FileDocCategorySizeDatePackage
AccessibleObject.javaAPI DocJava SE 6 API6902Tue Jun 10 00:25:38 BST 2008java.lang.reflect

AccessibleObject

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.

see
Field
see
Method
see
Constructor
see
ReflectPermission
since
1.2

Fields Summary
private static final Permission
ACCESS_PERMISSION
The Permission object that is used to check whether a client has sufficient privilege to defeat Java language access control checks.
boolean
override
static final ReflectionFactory
reflectionFactory
Constructors Summary
protected AccessibleObject()
Constructor: only used by the Java Virtual Machine.

Methods Summary
public TgetAnnotation(java.lang.Class annotationClass)

throws
NullPointerException {@inheritDoc}
since
1.5


              
           
        throw new AssertionError("All subclasses should override this method");
    
public java.lang.annotation.Annotation[]getAnnotations()

since
1.5

 
        return getDeclaredAnnotations();
    
public java.lang.annotation.Annotation[]getDeclaredAnnotations()

since
1.5

        throw new AssertionError("All subclasses should override this method");
    
public booleanisAccessible()
Get the value of the accessible flag for this object.

return
the value of the object's accessible flag

	return override;
    
public booleanisAnnotationPresent(java.lang.Class annotationClass)

throws
NullPointerException {@inheritDoc}
since
1.5

        return getAnnotation(annotationClass) != null;
    
public static voidsetAccessible(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).

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.

param
array the array of AccessibleObjects
param
flag the new value for the accessible flag in each object
throws
SecurityException if the request is denied.
see
SecurityManager#checkPermission
see
java.lang.RuntimePermission


                                                                                                                                                                           
          
	  
	SecurityManager sm = System.getSecurityManager();
	if (sm != null) sm.checkPermission(ACCESS_PERMISSION);
	for (int i = 0; i < array.length; i++) {
	    setAccessible0(array[i], flag);
	}
    
public voidsetAccessible(boolean flag)
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.

param
flag the new value for the accessible flag
throws
SecurityException if the request is denied.
see
SecurityManager#checkPermission
see
java.lang.RuntimePermission

	SecurityManager sm = System.getSecurityManager();
	if (sm != null) sm.checkPermission(ACCESS_PERMISSION);
	setAccessible0(this, flag);
    
private static voidsetAccessible0(java.lang.reflect.AccessibleObject obj, boolean flag)

	if (obj instanceof Constructor && flag == true) {
	    Constructor c = (Constructor)obj;
	    if (c.getDeclaringClass() == Class.class) {
		throw new SecurityException("Can not make a java.lang.Class" +
					    " constructor accessible");
	    }
	}
	obj.override = flag;