Most visited

Recently visited

Results for

Added in API level 1

Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

AccessibleObject

public class AccessibleObject
extends Object implements AnnotatedElement

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

Known Direct Subclasses

Constructor<T>, Field, Method

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.

By default, a reflected object is not accessible.

See also:

Summary

Protected constructors
`AccessibleObject()` Constructor: only used by the Java Virtual Machine.

Public methods
`<T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)` Returns this element's annotation for the specified type if such an annotation is present, else null.
`Annotation[]`	`getAnnotations()` Returns all annotations present on this element.
`Annotation[]`	`getDeclaredAnnotations()` Returns all annotations that are directly present on this element.
`boolean`	`isAccessible()` Get the value of the `accessible` flag for this object.
`void`	`setAccessible(boolean flag)` Set the `accessible` flag for this object to the indicated boolean value.
`static void`	`setAccessible(AccessibleObject[] array, boolean flag)` Convenience method to set the `accessible` flag for an array of objects with a single security check (for efficiency).

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    java.lang.reflect.AnnotatedElement

`abstract <T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)` Returns this element's annotation for the specified type if such an annotation is present, else null.
`abstract Annotation[]`	`getAnnotations()` Returns all annotations present on this element.
`default <T extends Annotation> T[]`	`getAnnotationsByType(Class<T> annotationClass)` Returns an associated list of annotations on `this` element, whose class is `annotationClass`, or an empty array if nothing was found.
`default <T extends Annotation> Annotation`	`getDeclaredAnnotation(Class<T> annotationClass)` Returns a directly-present annotation on `this` element, whose class is `annotationClass`, or `null` if nothing was found.
`abstract Annotation[]`	`getDeclaredAnnotations()` Returns all annotations that are directly present on this element.
`default <T extends Annotation> T[]`	`getDeclaredAnnotationsByType(Class<T> annotationClass)` Returns a directly or indirectly present list of annotations on `this` element, whose class is `annotationClass`, or an empty array if nothing was found.
`default boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationClass)` Returns true if an annotation for the specified type is present on this element, else false.

Protected constructors

AccessibleObject

Added in API level 1

AccessibleObject ()

Constructor: only used by the Java Virtual Machine.

Public methods

getAnnotation

Added in API level 1

T getAnnotation (Class<T> annotationClass)

Returns this element's annotation for the specified type if such an annotation is present, else null.

Parameters
`annotationClass`	`Class`: the Class object corresponding to the annotation type

Returns
`T`	this element's annotation for the specified annotation type if present on this element, else null

Throws
`NullPointerException`

getAnnotations

Added in API level 1

Annotation[] 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.

Returns
`Annotation[]`	all annotations present on this element

getDeclaredAnnotations

Added in API level 1

Annotation[] 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.

Returns
`Annotation[]`	All annotations directly present on this element

isAccessible

Added in API level 1

boolean isAccessible ()

Get the value of the accessible flag for this object.

Returns
`boolean`	the value of the object's `accessible` flag

setAccessible

Added in API level 1

void setAccessible (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 Constructor object for the class Class).

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

Parameters
`flag`	`boolean`: the new value for the `accessible` flag

Throws
`SecurityException`	if the request is denied.

See also:

setAccessible

Added in API level 1

void setAccessible (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 Constructor object for the class 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`	`AccessibleObject`: the array of AccessibleObjects
`flag`	`boolean`: the new value for the `accessible` flag in each object

Throws
`SecurityException`	if the request is denied.

See also:

Interfaces

Classes

Exceptions

Errors

Most visited

Recently visited

Results for

AccessibleObject

Summary

Protected constructors

Public methods

Inherited methods

Protected constructors

AccessibleObject

Public methods

getAnnotation

getAnnotations

getDeclaredAnnotations

isAccessible

setAccessible

setAccessible