Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.lang.reflect

Class AccessibleObject

Implemented Interfaces:
AnnotatedElement
Known Direct Subclasses:
Constructor<T>, Field, Method
public class AccessibleObject
extends Object
implements AnnotatedElement
This class is the superclass of various reflection classes, and allows sufficiently trusted code to bypass normal restrictions to do necessary things like invoke private methods outside of the class during Serialization. If you don't have a good reason to mess with this, don't try. Fortunately, there are adequate security checks before you can set a reflection object as accessible.
Since:
1.2
See Also:
Field, Constructor, Method, ReflectPermission

Constructor Summary

AccessibleObject()
Only the three reflection classes that extend this can create an accessible object.

Method Summary

extends Annotation> T getAnnotation(Class annotationClass)
Returns the element's annotation for the specified annotation type, or null if no such annotation exists.
Annotation[]
getAnnotations()
Returns all annotations associated with the element.
Annotation[]
getDeclaredAnnotations()
Returns all annotations directly defined by the element.
boolean
isAccessible()
Return the accessibility status of this object.
boolean
isAnnotationPresent(Annotation> annotationClass)
Returns true if an annotation for the specified type is associated with the element.
void
setAccessible(boolean flag)
Sets the accessibility flag for this reflection object.
static void
setAccessible(AccessibleObject[] array, boolean flag)
Convenience method to set the flag on a number of objects with a single security check.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AccessibleObject

protected AccessibleObject()
Only the three reflection classes that extend this can create an accessible object. This is not serializable for security reasons.

Method Details

extends Annotation> T getAnnotation

public extends Annotation> T getAnnotation(Class annotationClass)
Returns the element's annotation for the specified annotation type, or null if no such annotation exists.

This method must be overridden by subclasses to provide appropriate behaviour.

Specified by:
extends Annotation> T getAnnotation in interface AnnotatedElement
Parameters:
annotationClass - the type of annotation to look for.
Returns:
this element's annotation for the specified type, or null if no such annotation exists.
Throws:
NullPointerException - if the annotation class is null.

getAnnotations

public Annotation[] getAnnotations()
Returns all annotations associated with the element. If there are no annotations associated with the element, then a zero-length array will be returned. The returned array may be modified by the client code, but this will have no effect on the annotation content of the element, and hence no effect on the return value of this method for future callers.
Specified by:
getAnnotations in interface AnnotatedElement
Returns:
this element's annotations.

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()
Returns all annotations directly defined by the element. If there are no annotations directly associated with the element, then a zero-length array will be returned. The returned array may be modified by the client code, but this will have no effect on the annotation content of this class, and hence no effect on the return value of this method for future callers.

This method must be overridden by subclasses to provide appropriate behaviour.

Specified by:
getDeclaredAnnotations in interface AnnotatedElement
Returns:
the annotations directly defined by the element.
Since:
1.5

isAccessible

public boolean isAccessible()
Return the accessibility status of this object.
Returns:
true if this object bypasses security checks

isAnnotationPresent

public boolean isAnnotationPresent(Annotation> annotationClass)
Returns true if an annotation for the specified type is associated with the element. This is primarily a short-hand for using marker annotations.
Specified by:
isAnnotationPresent in interface AnnotatedElement
Parameters:
annotationClass - the type of annotation to look for.
Returns:
true if an annotation exists for the specified type.
Since:
1.5

setAccessible

public void setAccessible(boolean flag)
Sets the accessibility flag for this reflection object. If a security manager exists, it is checked for ReflectPermission("suppressAccessChecks").

It is forbidden to set the accessibility flag to true on any constructor for java.lang.Class. This will result in a SecurityException.

Parameters:
flag - the desired state of accessibility, true to bypass security
Throws:
NullPointerException - if array is null
SecurityException - if the request is denied
See Also:
SecurityManager.checkPermission(Permission), RuntimePermission

setAccessible

public static void setAccessible(AccessibleObject[] array,
                                 boolean flag)
Convenience method to set the flag on a number of objects with a single security check. If a security manager exists, it is checked for ReflectPermission("suppressAccessChecks").

It is forbidden to set the accessibility flag to true on any constructor for java.lang.Class. This will result in a SecurityException. If the SecurityException is thrown for any of the passed AccessibleObjects, the accessibility flag will be set on AccessibleObjects in the array prior to the one which resulted in the exception.

Parameters:
array - the array of accessible objects
flag - the desired state of accessibility, true to bypass security
Throws:
NullPointerException - if array is null
SecurityException - if the request is denied
See Also:
SecurityManager.checkPermission(Permission), RuntimePermission
java.lang.reflect.AccessibleObject Copyright (C) 2001, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About