java.lang.reflect
Class AccessibleObject

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.reflect.AccessibleObject
All Implemented Interfaces:
AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement
Direct Known Subclasses:
Constructor sample code for java.lang.reflect.Constructor definition code for java.lang.reflect.Constructor , Field sample code for java.lang.reflect.Field definition code for java.lang.reflect.Field , Method sample code for java.lang.reflect.Method definition code for java.lang.reflect.Method

public class AccessibleObject
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement

The AccessibleObject class is the base class for Field, Method and Constructor objects. It provides the ability to flag a reflected object as suppressing default Java language access control checks when it is used. The access checks--for public, default (package) access, protected, and private members--are performed when Fields, Methods or Constructors are used to set or get fields, to invoke methods, or to create and initialize new instances of classes, respectively.

Setting the accessible flag in a reflected object permits sophisticated applications with sufficient privilege, such as Java Object Serialization or other persistence mechanisms, to manipulate objects in a manner that would normally be prohibited.

Since:
1.2
See Also:
Field sample code for java.lang.reflect.Field definition code for java.lang.reflect.Field , Method sample code for java.lang.reflect.Method definition code for java.lang.reflect.Method , Constructor sample code for java.lang.reflect.Constructor definition code for java.lang.reflect.Constructor , ReflectPermission sample code for java.lang.reflect.ReflectPermission definition code for java.lang.reflect.ReflectPermission

Constructor Summary
protected AccessibleObject sample code for java.lang.reflect.AccessibleObject.AccessibleObject() definition code for java.lang.reflect.AccessibleObject.AccessibleObject() ()
          Constructor: only used by the Java Virtual Machine.
 
Method Summary
<T extends Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation >
T
getAnnotation sample code for java.lang.reflect.AccessibleObject.getAnnotation(java.lang.Class) definition code for java.lang.reflect.AccessibleObject.getAnnotation(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <T> annotationClass)
          Returns this element's annotation for the specified type if such an annotation is present, else null.
 Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation [] getAnnotations sample code for java.lang.reflect.AccessibleObject.getAnnotations() definition code for java.lang.reflect.AccessibleObject.getAnnotations() ()
          Returns all annotations present on this element.
 Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation [] getDeclaredAnnotations sample code for java.lang.reflect.AccessibleObject.getDeclaredAnnotations() definition code for java.lang.reflect.AccessibleObject.getDeclaredAnnotations() ()
          Returns all annotations that are directly present on this element.
 boolean isAccessible sample code for java.lang.reflect.AccessibleObject.isAccessible() definition code for java.lang.reflect.AccessibleObject.isAccessible() ()
          Get the value of the accessible flag for this object.
 boolean isAnnotationPresent sample code for java.lang.reflect.AccessibleObject.isAnnotationPresent(java.lang.Class) definition code for java.lang.reflect.AccessibleObject.isAnnotationPresent(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <? extends Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation > annotationClass)
          Returns true if an annotation for the specified type is present on this element, else false.
static void setAccessible sample code for java.lang.reflect.AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) definition code for java.lang.reflect.AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) (AccessibleObject sample code for java.lang.reflect.AccessibleObject definition code for java.lang.reflect.AccessibleObject [] array, boolean flag)
          Convenience method to set the accessible flag for an array of objects with a single security check (for efficiency).
 void setAccessible sample code for java.lang.reflect.AccessibleObject.setAccessible(boolean) definition code for java.lang.reflect.AccessibleObject.setAccessible(boolean) (boolean flag)
          Set the accessible flag for this object to the indicated boolean value.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AccessibleObject sample code for java.lang.reflect.AccessibleObject() definition code for java.lang.reflect.AccessibleObject()

protected AccessibleObject()
Constructor: only used by the Java Virtual Machine.

Method Detail

setAccessible sample code for java.lang.reflect.AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) definition code for java.lang.reflect.AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

public static void setAccessible(AccessibleObject sample code for java.lang.reflect.AccessibleObject definition code for java.lang.reflect.AccessibleObject [] array,
                                 boolean flag)
                          throws SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException 
Convenience method to set the accessible flag for an array of objects with a single security check (for efficiency).

First, if there is a security manager, its checkPermission method is called with a ReflectPermission("suppressAccessChecks") permission.

A SecurityException is raised if flag is true but accessibility of any of the elements of the input array may not be changed (for example, if the element object is a Constructor sample code for java.lang.reflect.Constructor definition code for java.lang.reflect.Constructor object for the class Class sample code for java.lang.Class definition code for java.lang.Class ). In the event of such a SecurityException, the accessibility of objects is set to flag for array elements upto (and excluding) the element for which the exception occurred; the accessibility of elements beyond (and including) the element for which the exception occurred is unchanged.

Parameters:
array - the array of AccessibleObjects
flag - the new value for the accessible flag in each object
Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if the request is denied.
See Also:
SecurityManager.checkPermission(java.security.Permission) sample code for java.lang.SecurityManager.checkPermission(java.security.Permission) definition code for java.lang.SecurityManager.checkPermission(java.security.Permission) , RuntimePermission sample code for java.lang.RuntimePermission definition code for java.lang.RuntimePermission

setAccessible sample code for java.lang.reflect.AccessibleObject.setAccessible(boolean) definition code for java.lang.reflect.AccessibleObject.setAccessible(boolean)

public void setAccessible(boolean flag)
                   throws SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException 
Set the accessible flag for this object to the indicated boolean value. A value of true indicates that the reflected object should suppress Java language access checking when it is used. A value of false indicates that the reflected object should enforce Java language access checks.

First, if there is a security manager, its checkPermission method is called with a ReflectPermission("suppressAccessChecks") permission.

A SecurityException is raised if flag is true but accessibility of this object may not be changed (for example, if this element object is a Constructor sample code for java.lang.reflect.Constructor definition code for java.lang.reflect.Constructor object for the class Class sample code for java.lang.Class definition code for java.lang.Class ).

A SecurityException is raised if this object is a Constructor sample code for java.lang.reflect.Constructor definition code for java.lang.reflect.Constructor object for the class java.lang.Class, and flag is true.

Parameters:
flag - the new value for the accessible flag
Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if the request is denied.
See Also:
SecurityManager.checkPermission(java.security.Permission) sample code for java.lang.SecurityManager.checkPermission(java.security.Permission) definition code for java.lang.SecurityManager.checkPermission(java.security.Permission) , RuntimePermission sample code for java.lang.RuntimePermission definition code for java.lang.RuntimePermission

isAccessible sample code for java.lang.reflect.AccessibleObject.isAccessible() definition code for java.lang.reflect.AccessibleObject.isAccessible()

public boolean isAccessible()
Get the value of the accessible flag for this object.

Returns:
the value of the object's accessible flag

getAnnotation sample code for java.lang.reflect.AccessibleObject.<T extends java.lang.annotation.Annotation>getAnnotation(java.lang.Class<T>) definition code for java.lang.reflect.AccessibleObject.<T extends java.lang.annotation.Annotation>getAnnotation(java.lang.Class<T>)

public <T extends Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation > T getAnnotation(Class sample code for java.lang.Class definition code for java.lang.Class <T> annotationClass)
Description copied from interface: AnnotatedElement sample code for java.lang.reflect.AnnotatedElement.getAnnotation(java.lang.Class) definition code for java.lang.reflect.AnnotatedElement.getAnnotation(java.lang.Class)
Returns this element's annotation for the specified type if such an annotation is present, else null.

Specified by:
getAnnotation sample code for java.lang.reflect.AnnotatedElement.getAnnotation(java.lang.Class) definition code for java.lang.reflect.AnnotatedElement.getAnnotation(java.lang.Class) in interface AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement
Parameters:
annotationClass - the Class object corresponding to the annotation type
Returns:
this element's annotation for the specified annotation type if present on this element, else null

isAnnotationPresent sample code for java.lang.reflect.AccessibleObject.isAnnotationPresent(java.lang.Class<? extends java.lang.annotation.Annotation>) definition code for java.lang.reflect.AccessibleObject.isAnnotationPresent(java.lang.Class<? extends java.lang.annotation.Annotation>)

public boolean isAnnotationPresent(Class sample code for java.lang.Class definition code for java.lang.Class <? extends Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation > annotationClass)
Description copied from interface: AnnotatedElement sample code for java.lang.reflect.AnnotatedElement.isAnnotationPresent(java.lang.Class) definition code for java.lang.reflect.AnnotatedElement.isAnnotationPresent(java.lang.Class)
Returns true if an annotation for the specified type is present on this element, else false. This method is designed primarily for convenient access to marker annotations.

Specified by:
isAnnotationPresent sample code for java.lang.reflect.AnnotatedElement.isAnnotationPresent(java.lang.Class) definition code for java.lang.reflect.AnnotatedElement.isAnnotationPresent(java.lang.Class) in interface AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement
Parameters:
annotationClass - the Class object corresponding to the annotation type
Returns:
true if an annotation for the specified annotation type is present on this element, else false

getAnnotations sample code for java.lang.reflect.AccessibleObject.getAnnotations() definition code for java.lang.reflect.AccessibleObject.getAnnotations()

public Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation [] getAnnotations()
Description copied from interface: AnnotatedElement sample code for java.lang.reflect.AnnotatedElement.getAnnotations() definition code for java.lang.reflect.AnnotatedElement.getAnnotations()
Returns all annotations present on this element. (Returns an array of length zero if this element has no annotations.) The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Specified by:
getAnnotations sample code for java.lang.reflect.AnnotatedElement.getAnnotations() definition code for java.lang.reflect.AnnotatedElement.getAnnotations() in interface AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement
Returns:
all annotations present on this element

getDeclaredAnnotations sample code for java.lang.reflect.AccessibleObject.getDeclaredAnnotations() definition code for java.lang.reflect.AccessibleObject.getDeclaredAnnotations()

public Annotation sample code for java.lang.annotation.Annotation definition code for java.lang.annotation.Annotation [] getDeclaredAnnotations()
Description copied from interface: AnnotatedElement sample code for java.lang.reflect.AnnotatedElement.getDeclaredAnnotations() definition code for java.lang.reflect.AnnotatedElement.getDeclaredAnnotations()
Returns all annotations that are directly present on this element. Unlike the other methods in this interface, this method ignores inherited annotations. (Returns an array of length zero if no annotations are directly present on this element.) The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Specified by:
getDeclaredAnnotations sample code for java.lang.reflect.AnnotatedElement.getDeclaredAnnotations() definition code for java.lang.reflect.AnnotatedElement.getDeclaredAnnotations() in interface AnnotatedElement sample code for java.lang.reflect.AnnotatedElement definition code for java.lang.reflect.AnnotatedElement
Returns:
All annotations directly present on this element