- Java method is accessible
- Constructor Summary
- Method Summary
- Methods inherited from class java.lang.Object
- Constructor Detail
- AccessibleObject
- Method Detail
- setAccessible
- setAccessible
- isAccessible
- getAnnotation
- isAnnotationPresent
- getAnnotationsByType
- getAnnotations
- getDeclaredAnnotation
- getDeclaredAnnotationsByType
- getDeclaredAnnotations
- Java method is accessible
- Constructor Summary
- Method Summary
- Methods inherited from class java.lang.Object
- Constructor Detail
- AccessibleObject
- Method Detail
- setAccessible
- setAccessible
- isAccessible
- getAnnotation
- isAnnotationPresent
- getAnnotationsByType
- getAnnotations
- getDeclaredAnnotation
- getDeclaredAnnotationsByType
- getDeclaredAnnotations
Java method is accessible
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.
Constructor Summary
Method Summary
Returns this element’s annotation for the specified type if such an annotation is present, else null.
Returns this element’s annotation for the specified type if such an annotation is directly present, else null.
Returns this element’s annotation(s) for the specified type if such annotations are either directly present or indirectly present.
Convenience method to set the accessible flag for an array of objects with a single security check (for efficiency).
Methods inherited from class java.lang.Object
Constructor Detail
AccessibleObject
protected AccessibleObject()
Method Detail
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 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.
setAccessible
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.
isAccessible
public boolean isAccessible()
getAnnotation
public Annotation> T getAnnotation(Class annotationClass)
Returns this element’s annotation for the specified type if such an annotation is present, else null.
isAnnotationPresent
public boolean isAnnotationPresent(ClassAnnotation> annotationClass)
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 The body of the default method is specified to be the code above.
getAnnotationsByType
public Annotation> T[] getAnnotationsByType(Class annotationClass)
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 AnnotatedElement.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.
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.
getDeclaredAnnotation
public Annotation> T getDeclaredAnnotation(Class annotationClass)
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.)
getDeclaredAnnotationsByType
public Annotation> T[] getDeclaredAnnotationsByType(Class annotationClass)
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 AnnotatedElement.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.
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.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Java method is accessible
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.
Constructor Summary
Method Summary
Returns this element’s annotation for the specified type if such an annotation is present, else null.
Returns this element’s annotation for the specified type if such an annotation is directly present, else null.
Returns this element’s annotation(s) for the specified type if such annotations are either directly present or indirectly present.
Convenience method to set the accessible flag for an array of objects with a single security check (for efficiency).
Methods inherited from class java.lang.Object
Constructor Detail
AccessibleObject
protected AccessibleObject()
Method Detail
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 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.
setAccessible
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.
isAccessible
public boolean isAccessible()
getAnnotation
public Annotation> T getAnnotation(Class annotationClass)
Returns this element’s annotation for the specified type if such an annotation is present, else null.
isAnnotationPresent
public boolean isAnnotationPresent(ClassAnnotation> annotationClass)
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 The body of the default method is specified to be the code above.
getAnnotationsByType
public Annotation> T[] getAnnotationsByType(Class annotationClass)
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 AnnotatedElement.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.
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.
getDeclaredAnnotation
public Annotation> T getDeclaredAnnotation(Class annotationClass)
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.)
getDeclaredAnnotationsByType
public Annotation> T[] getDeclaredAnnotationsByType(Class annotationClass)
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 AnnotatedElement.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.
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.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.