java.lang.reflect
class AccessibleObject

java.lang.Object java.lang.reflect.AccessibleObject

All Implemented Interfaces:

AnnotatedElement

Direct Known Subclasses:

Constructor, Field, Method

public class AccessibleObject
extends Object
implements 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.

AccessibleObject

protected AccessibleObject()

Constructor: only used by the Java Virtual Machine.

getAnnotation

public Annotation getAnnotation(Class annotationClass)

Parameters:

annotationClass

getAnnotations

public Annotation[] getAnnotations()

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

isAccessible

public boolean isAccessible()

Get the value of the accessible flag for this object.

Returns:

the value of the object's accessible flag

isAnnotationPresent

public boolean isAnnotationPresent(Class annotationClass)

Parameters:

annotationClass

setAccessible

public static void setAccessible(AccessibleObject[] array,
                                 boolean flag)
                          throws 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 {@link Constructor} object for the class {@link 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 - if the request is denied.

setAccessible

public void setAccessible(boolean flag)
                   throws 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 {@link Constructor} object for the class {@link java.lang.Class}).

A SecurityException is raised if this object is a {@link 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 - if the request is denied.