AnnotatedElement
, GenericDeclaration
, Member
Constructor
, Method
public abstract sealed class Executable extends AccessibleObject implements Member, GenericDeclaration permits Constructor<T>, Method
Method
and Constructor
.Modifier and Type | Method | Description |
---|---|---|
Set |
accessFlags() |
Returns an unmodifiable set of the access flags for the executable represented by this object, possibly empty. |
AnnotatedType[] |
getAnnotatedExceptionTypes() |
Returns an array of AnnotatedType objects that represent the use of types to specify the declared exceptions of the method/constructor represented by this Executable. |
AnnotatedType[] |
getAnnotatedParameterTypes() |
Returns an array of AnnotatedType objects that represent the use of types to specify formal parameter types of the method/constructor represented by this Executable. |
AnnotatedType |
getAnnotatedReceiverType() |
Returns an AnnotatedType object that represents the use of a type to specify the receiver type of the method/constructor represented by this Executable object. |
abstract AnnotatedType |
getAnnotatedReturnType() |
Returns an AnnotatedType object that represents the use of a type to specify the return type of the method/constructor represented by this Executable. |
<T extends Annotation> |
getAnnotation |
Returns this element's annotation for the specified type if such an annotation is present, else null. |
<T extends Annotation> |
getAnnotationsByType |
Returns annotations that are associated with this element. |
Annotation[] |
getDeclaredAnnotations() |
Returns annotations that are directly present on this element. |
abstract Class |
getDeclaringClass() |
Returns the Class object representing the class or interface that declares the executable represented by this object. |
abstract Class<?>[] |
getExceptionTypes() |
Returns an array of Class objects that represent the types of exceptions declared to be thrown by the underlying executable represented by this object. |
Type[] |
getGenericExceptionTypes() |
Returns an array of Type objects that represent the exceptions declared to be thrown by this executable object. |
Type[] |
getGenericParameterTypes() |
Returns an array of Type objects that represent the formal parameter types, in declaration order, of the executable represented by this object. |
abstract int |
getModifiers() |
Returns the Java language modifiers for the executable represented by this object. |
abstract String |
getName() |
Returns the name of the executable represented by this object. |
abstract Annotation[][] |
getParameterAnnotations() |
Returns an array of arrays of Annotation s that represent the annotations on the formal parameters, in declaration order, of the Executable represented by this object. |
abstract int |
getParameterCount() |
Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object. |
Parameter[] |
getParameters() |
Returns an array of Parameter objects representing all the parameters to the underlying executable represented by this object. |
abstract Class<?>[] |
getParameterTypes() |
Returns an array of Class objects that represent the formal parameter types, in declaration order, of the executable represented by this object. |
abstract TypeVariable<?>[] |
getTypeParameters() |
Returns an array of TypeVariable objects that represent the type variables declared by the generic declaration represented by this GenericDeclaration object, in declaration order. |
boolean |
isSynthetic() |
Returns true if this executable is a synthetic construct; returns false otherwise. |
boolean |
isVarArgs() |
Returns true if this executable was declared to take a variable number of arguments; returns false otherwise. |
abstract String |
toGenericString() |
Returns a string describing this Executable , including any type parameters. |
canAccess, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAccessible, isAnnotationPresent, setAccessible, setAccessible, trySetAccessible
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnnotations, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent
public abstract Class<?> getDeclaringClass()
Class
object representing the class or interface that declares the executable represented by this object.getDeclaringClass
in interface Member
public abstract String getName()
public abstract int getModifiers()
getModifiers
in interface Member
public Set<AccessFlag> accessFlags()
accessFlags
in interface Member
public abstract TypeVariable<?>[] getTypeParameters()
TypeVariable
objects that represent the type variables declared by the generic declaration represented by this GenericDeclaration
object, in declaration order. Returns an array of length 0 if the underlying generic declaration declares no type variables.getTypeParameters
in interface GenericDeclaration
TypeVariable
objects that represent the type variables declared by this generic declarationGenericSignatureFormatError
- if the generic signature of this generic declaration does not conform to the format specified in The Java Virtual Machine Specification
public abstract Class<?>[] getParameterTypes()
Class
objects that represent the formal parameter types, in declaration order, of the executable represented by this object. Returns an array of length 0 if the underlying executable takes no parameters. Note that the constructors of some inner classes may have an implicitly declared parameter in addition to explicitly declared ones.public abstract int getParameterCount()
public Type[] getGenericParameterTypes()
Type
objects that represent the formal parameter types, in declaration order, of the executable represented by this object. An array of length 0 is returned if the underlying executable takes no parameters. Note that the constructors of some inner classes may have an implicitly declared parameter in addition to explicitly declared ones. Also note that as a modeling artifact, the number of returned parameters can differ depending on whether or not generic information is present. If generic information is present, only parameters explicitly present in the source will be returned; if generic information is not present, implicit and synthetic parameters may be returned as well. If a formal parameter type is a parameterized type, the Type
object returned for it must accurately reflect the actual type arguments used in the source code.
If a formal parameter type is a type variable or a parameterized type, it is created. Otherwise, it is resolved.
Type
s that represent the formal parameter types of the underlying executable, in declaration orderGenericSignatureFormatError
- if the generic method signature does not conform to the format specified in The Java Virtual Machine Specification
TypeNotPresentException
- if any of the parameter types of the underlying executable refers to a non-existent type declarationMalformedParameterizedTypeException
- if any of the underlying executable's parameter types refer to a parameterized type that cannot be instantiated for any reasonpublic Parameter[] getParameters()
Parameter
objects representing all the parameters to the underlying executable represented by this object. An array of length 0 is returned if the executable has no parameters. The parameters of the underlying executable do not necessarily have unique names, or names that are legal identifiers in the Java programming language (JLS 3.8).
Parameter
objects representing all the parameters to the underlying executable represented by this objectMalformedParametersException
- if the class file contains a MethodParameters attribute that is improperly formatted.public abstract Class<?>[] getExceptionTypes()
Class
objects that represent the types of exceptions declared to be thrown by the underlying executable represented by this object. Returns an array of length 0 if the executable declares no exceptions in its
throws
clause.public Type[] getGenericExceptionTypes()
Type
objects that represent the exceptions declared to be thrown by this executable object. Returns an array of length 0 if the underlying executable declares no exceptions in its throws
clause. If an exception type is a type variable or a parameterized type, it is created. Otherwise, it is resolved.
GenericSignatureFormatError
- if the generic method signature does not conform to the format specified in The Java Virtual Machine Specification
TypeNotPresentException
- if the underlying executable's throws
clause refers to a non-existent type declarationMalformedParameterizedTypeException
- if the underlying executable's throws
clause refers to a parameterized type that cannot be instantiated for any reasonpublic abstract String toGenericString()
Executable
, including any type parameters.Executable
, including any type parameterspublic boolean isVarArgs()
true
if this executable was declared to take a variable number of arguments; returns false
otherwise.true
if this executable was declared to take a variable number of arguments; returns false
otherwisepublic boolean isSynthetic()
true
if this executable is a synthetic construct; returns false
otherwise.isSynthetic
in interface Member
public abstract Annotation[][] getParameterAnnotations()
Annotation
s that represent the annotations on the formal parameters, in declaration order, of the Executable
represented by this object. Synthetic and mandated parameters (see explanation below), such as the outer "this" parameter to an inner class constructor will be represented in the returned array. If the executable has no parameters (meaning no formal, no synthetic, and no mandated parameters), a zero-length array will be returned. If the Executable
has one or more parameters, a nested array of length zero is returned for each parameter with no annotations. The annotation objects contained in the returned arrays are serializable. The caller of this method is free to modify the returned arrays; it will have no effect on the arrays returned to other callers. A compiler may add extra parameters that are implicitly declared in source ("mandated"), as well as parameters that are neither implicitly nor explicitly declared in source ("synthetic") to the parameter list for a method. See Parameter
for more information. Note that any annotations returned by this method are declaration annotations.
public <T extends Annotation> T getAnnotation(Class<T> annotationClass)
Note that any annotation returned by this method is a declaration annotation.
getAnnotation
in interface AnnotatedElement
getAnnotation
in class AccessibleObject
T
- the type of the annotation to query for and return if presentannotationClass
- the Class object corresponding to the annotation typeNullPointerException
- if the given annotation class is nullpublic <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
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. Note that any annotations returned by this method are declaration annotations.
getAnnotationsByType
in interface AnnotatedElement
getAnnotationsByType
in class AccessibleObject
T
- the type of the annotation to query for and return if presentannotationClass
- the Class object corresponding to the annotation typeNullPointerException
- if the given annotation class is nullpublic Annotation[] getDeclaredAnnotations()
Note that any annotations returned by this method are declaration annotations.
getDeclaredAnnotations
in interface AnnotatedElement
getDeclaredAnnotations
in class AccessibleObject
public abstract AnnotatedType getAnnotatedReturnType()
AnnotatedType
object that represents the use of a type to specify the return type of the method/constructor represented by this Executable. If this Executable
object represents a constructor, the
AnnotatedType
object represents the type of the constructed object. If this Executable
object represents a method, the
AnnotatedType
object represents the use of a type to specify the return type of the method.Executable
public AnnotatedType getAnnotatedReceiverType()
AnnotatedType
object that represents the use of a type to specify the receiver type of the method/constructor represented by this Executable
object. The receiver type of a method/constructor is available only if the method/constructor has a receiver parameter (JLS 8.4.1). If this
Executable
object represents an instance method or represents a constructor of an inner member class, and the method/constructor either has no receiver parameter or has a receiver parameter with no annotations on its type, then the return value is an AnnotatedType
object representing an element with no annotations. If this Executable
object represents a static method or represents a constructor of a top level, static member, local, or anonymous class, then the return value is null.Executable
or null
if this Executable
can not have a receiver parameterpublic AnnotatedType[] getAnnotatedParameterTypes()
AnnotatedType
objects that represent the use of types to specify formal parameter types of the method/constructor represented by this Executable. The order of the objects in the array corresponds to the order of the formal parameter types in the declaration of the method/constructor. Returns an array of length 0 if the method/constructor declares no parameters. Note that the constructors of some inner classes may have an implicitly declared parameter in addition to explicitly declared ones.Executable
public AnnotatedType[] getAnnotatedExceptionTypes()
AnnotatedType
objects that represent the use of types to specify the declared exceptions of the method/constructor represented by this Executable. The order of the objects in the array corresponds to the order of the exception types in the declaration of the method/constructor. Returns an array of length 0 if the method/constructor declares no exceptions.
Executable
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/reflect/Executable.html