Test if the caller can access this reflected object. If this reflected object corresponds to an instance method or field then this method tests if the caller can access the given obj with the reflected object. For instance methods or fields then the obj argument must be an instance of the declaring class. For static members and constructors then obj must be null.

This method returns true if the accessible flag is set to true, i.e. the checks for Java language access control are suppressed, or if the caller can access the member as specified in The Java Language Specification, with the variation noted in the class description. If this method is invoked by JNI code with no caller class on the stack, this method returns true if the member and the declaring class are public, and the class is in a package that is exported unconditionally.

Parameters

obj:Object

an instance object of the declaring class of this reflected object if it is an instance method or field

Returns:boolean

true if the caller can access this reflected object.

Annotations

@CallerSensitive

Exceptions

IllegalArgumentException:

• if this reflected object is a static member or constructor and the given obj is non-null, or
• if this reflected object is an instance method or field and the given obj is null or of type that is not a subclass of the declaring class of the member.

Since

9

Java Language Specification

6.6 Access Control

External Specification

Java Native Interface Specification

See Also

trySetAccessible, setAccessible(boolean)

Implements java.lang.reflect.AnnotatedElement.getAnnotation.

Doc from java.lang.reflect.AnnotatedElement.getAnnotation.

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

Note that any annotation returned by this method is a declaration annotation.

Parameters

<T>

the type of the annotation to query for and return if present

annotationClass:Class<T>

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

Annotations

@Override

Exceptions

NullPointerException:

if the given annotation class is null

Since

1.5

Implements java.lang.reflect.AnnotatedElement.getAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getAnnotations.

Returns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns:Annotation[]

annotations present on this element

Annotations

@Override

Since

1.5

Overrides default java.lang.reflect.AnnotatedElement.getAnnotationsByType.

Doc from java.lang.reflect.AnnotatedElement.getAnnotationsByType.

Returns annotations that are associated with this element. If there are no annotations associated with this element, the return value is an array of length 0. The difference between this method and getAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Parameters

<T>

the type of the annotation to query for and return if present

annotationClass:Class<T>

the Class object corresponding to the annotation type

Returns:T[]

all this element's annotations for the specified annotation type if associated with this element, else an array of length zero

Annotations

@Override

Exceptions

NullPointerException:

if the given annotation class is null

Since

1.8

Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotation.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotation.

Returns this element's annotation for the specified type if such an annotation is directly present, else null. This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)

Note that any annotation returned by this method is a declaration annotation.

Parameters

<T>

the type of the annotation to query for and return if directly present

annotationClass:Class<T>

the Class object corresponding to the annotation type

Returns:T

this element's annotation for the specified annotation type if directly present on this element, else null

Annotations

@Override

Exceptions

NullPointerException:

if the given annotation class is null

Since

1.8

Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns:Annotation[]

annotations directly present on this element

Annotations

@Override

Since

1.5

Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType.

Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present. This method ignores inherited annotations. If there are no specified annotations directly or indirectly present on this element, the return value is an array of length 0. The difference between this method and getDeclaredAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation if one is present. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Parameters

<T>

the type of the annotation to query for and return if directly or indirectly present

annotationClass:Class<T>

the Class object corresponding to the annotation type

Returns:T[]

all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero

Annotations

@Override

Exceptions

NullPointerException:

if the given annotation class is null

Since

1.8

Get the value of the accessible flag for this reflected object.

Returns:boolean

the value of the object's accessible flag

Annotations

@Deprecated

since:9

Overrides default java.lang.reflect.AnnotatedElement.isAnnotationPresent.

Doc from java.lang.reflect.AnnotatedElement.isAnnotationPresent.

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.

The truth value returned by this method is equivalent to: getAnnotation(annotationClass) != null

Parameters

annotationClass:Class<? extends Annotation>

the Class object corresponding to the annotation type

Returns:boolean

true if an annotation for the specified annotation type is present on this element, else false

Annotations

@Override

Exceptions

NullPointerException:

if the given annotation class is null

Since

1.5

Convenience method to set the accessible flag for an array of reflected objects with a single security check (for efficiency).

This method may be used to enable access to all reflected objects in the array when access to each reflected object can be enabled as specified by setAccessible(boolean).

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

A SecurityException is also thrown if any of the elements of the input array is a java.lang.reflect.Constructor object for the class java.lang.Class and flag is true.

Parameters

array:AccessibleObject[]

the array of AccessibleObjects

flag:boolean

the new value for the accessible flag in each object

Annotations

@CallerSensitive

Exceptions

InaccessibleObjectException:

if access cannot be enabled for all objects in the array

SecurityException:

if the request is denied by the security manager or an element in the array is a constructor for java.lang.Class

See Also

SecurityManager#checkPermission, ReflectPermission

Set the accessible flag for this reflected object to the indicated boolean value. A value of true indicates that the reflected object should suppress checks for Java language access control when it is used. A value of false indicates that the reflected object should enforce checks for Java language access control when it is used, with the variation noted in the class description.

This method may be used by a caller in class C to enable access to a member of declaring class D if any of the following hold:

• C and D are in the same module.
• The member is public and D is public in a package that the module containing D exports to at least the module containing C.
• The member is protected static, D is public in a package that the module containing D exports to at least the module containing C, and C is a subclass of D.
• D is in a package that the module containing D opens to at least the module containing C. All packages in unnamed and open modules are open to all modules and so this method always succeeds when D is in an unnamed or open module.

This method may be used by JNI code with no caller class on the stack to enable access to a member of declaring class D if and only if:

• The member is public and D is public in a package that the module containing D exports unconditionally.

This method cannot be used to enable access to private members, members with default (package) access, protected instance members, or protected constructors when the declaring class is in a different module to the caller and the package containing the declaring class is not open to the caller's module.

This method cannot be used to enable write access to a non-modifiable final field. The following fields are non-modifiable:

• static final fields declared in any class or interface
• final fields declared in a hidden class
• final fields declared in a record

The accessible flag when true suppresses Java language access control checks to only enable read access to these non-modifiable final fields.

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

Parameters

flag:boolean

the new value for the accessible flag

Annotations

@CallerSensitive

Exceptions

InaccessibleObjectException:

if access cannot be enabled

SecurityException:

if the request is denied by the security manager

External Specification

Java Native Interface Specification

See Also

trySetAccessible, java.lang.invoke.MethodHandles#privateLookupIn

Set the accessible flag for this reflected object to true if possible. This method sets the accessible flag, as if by invoking setAccessible(true), and returns the possibly-updated value for the accessible flag. If access cannot be enabled, i.e. the checks or Java language access control cannot be suppressed, this method returns false (as opposed to setAccessible(true) throwing InaccessibleObjectException when it fails).

This method is a no-op if the accessible flag for this reflected object is true.

For example, a caller can invoke trySetAccessible on a Method object for a private instance method p.T::privateMethod to suppress the checks for Java language access control when the Method is invoked. If p.T class is in a different module to the caller and package p is open to at least the caller's module, the code below successfully sets the accessible flag to true.

p.T obj = ....;  // instance of p.T
    :
    Method m = p.T.class.getDeclaredMethod("privateMethod");
    if (m.trySetAccessible()) {
        m.invoke(obj);
    } else {
        // package p is not opened to the caller to access private member of T
        ...
    }

If this method is invoked by JNI code with no caller class on the stack, the accessible flag can only be set if the member and the declaring class are public, and the class is in a package that is exported unconditionally.

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

Returns:boolean

true if the accessible flag is set to true; false if access cannot be enabled.

Annotations

@CallerSensitive

Exceptions

SecurityException:

if the request is denied by the security manager

Since

9

External Specification

Java Native Interface Specification

See Also

java.lang.invoke.MethodHandles#privateLookupIn