- java.lang.Object
- 
- java.lang.reflect.AccessibleObject
- 
- java.lang.reflect.Executable
 
 
- 
- All Implemented Interfaces:
- AnnotatedElement,- GenericDeclaration,- Member
 - Direct Known Subclasses:
- Constructor,- Method
 
 public abstract class Executable extends AccessibleObject implements Member, GenericDeclaration A shared superclass for the common functionality ofMethodandConstructor.- Since:
- 1.8
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description AnnotatedType[]getAnnotatedExceptionTypes()Returns an array ofAnnotatedTypeobjects that represent the use of types to specify the declared exceptions of the method/constructor represented by this Executable.AnnotatedType[]getAnnotatedParameterTypes()Returns an array ofAnnotatedTypeobjects that represent the use of types to specify formal parameter types of the method/constructor represented by this Executable.AnnotatedTypegetAnnotatedReceiverType()Returns anAnnotatedTypeobject that represents the use of a type to specify the receiver type of the method/constructor represented by thisExecutableobject.abstract AnnotatedTypegetAnnotatedReturnType()Returns anAnnotatedTypeobject that represents the use of a type to specify the return type of the method/constructor represented by this Executable.<T extends Annotation>
 TgetAnnotation(Class<T> annotationClass)Returns this element's annotation for the specified type if such an annotation is present, else null.<T extends Annotation>
 T[]getAnnotationsByType(Class<T> annotationClass)Returns annotations that are associated with this element.abstract Class<?>getDeclaringClass()Returns theClassobject representing the class or interface that declares the executable represented by this object.abstract Class<?>[]getExceptionTypes()Returns an array ofClassobjects that represent the types of exceptions declared to be thrown by the underlying executable represented by this object.Type[]getGenericExceptionTypes()Returns an array ofTypeobjects that represent the exceptions declared to be thrown by this executable object.Type[]getGenericParameterTypes()Returns an array ofTypeobjects that represent the formal parameter types, in declaration order, of the executable represented by this object.abstract intgetModifiers()Returns the Java language modifiers for the executable represented by this object.abstract StringgetName()Returns the name of the executable represented by this object.abstract Annotation[][]getParameterAnnotations()Returns an array of arrays ofAnnotations that represent the annotations on the formal parameters, in declaration order, of theExecutablerepresented by this object.intgetParameterCount()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 ofParameterobjects that represent all the parameters to the underlying executable represented by this object.abstract Class<?>[]getParameterTypes()Returns an array ofClassobjects that represent the formal parameter types, in declaration order, of the executable represented by this object.abstract TypeVariable<?>[]getTypeParameters()Returns an array ofTypeVariableobjects that represent the type variables declared by the generic declaration represented by thisGenericDeclarationobject, in declaration order.booleanisSynthetic()Returnstrueif this executable is a synthetic construct; returnsfalseotherwise.booleanisVarArgs()Returnstrueif this executable was declared to take a variable number of arguments; returnsfalseotherwise.abstract StringtoGenericString()Returns a string describing thisExecutable, including any type parameters.- 
Methods declared in class java.lang.reflect.AccessibleObjectcanAccess, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAccessible, isAnnotationPresent, setAccessible, setAccessible, trySetAccessible
 - 
Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods declared in interface java.lang.reflect.AnnotatedElementgetAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAnnotationPresent
 
- 
 
- 
- 
- 
Method Detail- 
getDeclaringClasspublic abstract Class<?> getDeclaringClass() Returns theClassobject representing the class or interface that declares the executable represented by this object.- Specified by:
- getDeclaringClassin interface- Member
- Returns:
- an object representing the declaring class of the underlying member
 
 - 
getNamepublic abstract String getName() Returns the name of the executable represented by this object.
 - 
getModifierspublic abstract int getModifiers() Returns the Java language modifiers for the executable represented by this object.- Specified by:
- getModifiersin interface- Member
- Returns:
- the Java language modifiers for the underlying member
- See Also:
- Modifier
 
 - 
getTypeParameterspublic abstract TypeVariable<?>[] getTypeParameters() Returns an array ofTypeVariableobjects that represent the type variables declared by the generic declaration represented by thisGenericDeclarationobject, in declaration order. Returns an array of length 0 if the underlying generic declaration declares no type variables.- Specified by:
- getTypeParametersin interface- GenericDeclaration
- Returns:
- an array of TypeVariableobjects that represent the type variables declared by this generic declaration
- Throws:
- GenericSignatureFormatError- if the generic signature of this generic declaration does not conform to the format specified in The Java™ Virtual Machine Specification
 
 - 
getParameterTypespublic abstract Class<?>[] getParameterTypes() Returns an array ofClassobjects 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.- Returns:
- the parameter types for the executable this object represents
 
 - 
getParameterCountpublic int getParameterCount() Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object.- Returns:
- The number of formal parameters for the executable this object represents
 
 - 
getGenericParameterTypespublic Type[] getGenericParameterTypes() Returns an array ofTypeobjects 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.If a formal parameter type is a parameterized type, the Typeobject returned for it must accurately reflect the actual type parameters 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. - Returns:
- an array of Types that represent the formal parameter types of the underlying executable, in declaration order
- Throws:
- GenericSignatureFormatError- 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 declaration
- MalformedParameterizedTypeException- if any of the underlying executable's parameter types refer to a parameterized type that cannot be instantiated for any reason
 
 - 
getParameterspublic Parameter[] getParameters() Returns an array ofParameterobjects that represent all the parameters to the underlying executable represented by this object. Returns an array of length 0 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). - Returns:
- an array of Parameterobjects representing all the parameters to the executable this object represents.
- Throws:
- MalformedParametersException- if the class file contains a MethodParameters attribute that is improperly formatted.
 
 - 
getExceptionTypespublic abstract Class<?>[] getExceptionTypes() Returns an array ofClassobjects 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 itsthrowsclause.- Returns:
- the exception types declared as being thrown by the executable this object represents
 
 - 
getGenericExceptionTypespublic Type[] getGenericExceptionTypes() Returns an array ofTypeobjects 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 itsthrowsclause.If an exception type is a type variable or a parameterized type, it is created. Otherwise, it is resolved. - Returns:
- an array of Types that represent the exception types thrown by the underlying executable
- Throws:
- 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- throwsclause refers to a non-existent type declaration
- MalformedParameterizedTypeException- if the underlying executable's- throwsclause refers to a parameterized type that cannot be instantiated for any reason
 
 - 
toGenericStringpublic abstract String toGenericString() Returns a string describing thisExecutable, including any type parameters.- Returns:
- a string describing this Executable, including any type parameters
 
 - 
isVarArgspublic boolean isVarArgs() Returnstrueif this executable was declared to take a variable number of arguments; returnsfalseotherwise.- Returns:
- trueif an only if this executable was declared to take a variable number of arguments.
 
 - 
isSyntheticpublic boolean isSynthetic() Returnstrueif this executable is a synthetic construct; returnsfalseotherwise.- Specified by:
- isSyntheticin interface- Member
- Returns:
- true if and only if this executable is a synthetic construct as defined by The Java™ Language Specification.
- See The Java™ Language Specification:
- 13.1 The Form of a Binary
 
 - 
getParameterAnnotationspublic abstract Annotation[][] getParameterAnnotations() Returns an array of arrays ofAnnotations that represent the annotations on the formal parameters, in declaration order, of theExecutablerepresented 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 theExecutablehas 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. SeeParameterfor more information.- Returns:
- an array of arrays that represent the annotations on the formal and implicit parameters, in declaration order, of the executable represented by this object
- See Also:
- Parameter,- AnnotatedElement.getAnnotations()
 
 - 
getAnnotationpublic <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.- Specified by:
- getAnnotationin interface- AnnotatedElement
- Overrides:
- getAnnotationin class- AccessibleObject
- Type Parameters:
- T- the type of the annotation to query for and return if present
- Parameters:
- annotationClass- the Class object corresponding to the annotation type
- Returns:
- this element's annotation for the specified annotation type if present on this element, else null
- Throws:
- NullPointerException- if the given annotation class is null
 
 - 
getAnnotationsByTypepublic <T extends Annotation> T[] getAnnotationsByType(Class<T> 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 andAnnotatedElement.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.- Specified by:
- getAnnotationsByTypein interface- AnnotatedElement
- Overrides:
- getAnnotationsByTypein class- AccessibleObject
- Type Parameters:
- T- the type of the annotation to query for and return if present
- Parameters:
- annotationClass- the Class object corresponding to the annotation type
- Returns:
- all this element's annotations for the specified annotation type if associated with this element, else an array of length zero
- Throws:
- NullPointerException- if the given annotation class is null
 
 - 
getAnnotatedReturnTypepublic abstract AnnotatedType getAnnotatedReturnType() Returns anAnnotatedTypeobject that represents the use of a type to specify the return type of the method/constructor represented by this Executable. If thisExecutableobject represents a constructor, theAnnotatedTypeobject represents the type of the constructed object. If thisExecutableobject represents a method, theAnnotatedTypeobject represents the use of a type to specify the return type of the method.- Returns:
- an object representing the return type of the method
 or constructor represented by this Executable
 
 - 
getAnnotatedReceiverTypepublic AnnotatedType getAnnotatedReceiverType() Returns anAnnotatedTypeobject that represents the use of a type to specify the receiver type of the method/constructor represented by thisExecutableobject. The receiver type of a method/constructor is available only if the method/constructor has a receiver parameter (JLS 8.4.1). If thisExecutableobject 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 anAnnotatedTypeobject representing an element with no annotations. If thisExecutableobject represents a static method or represents a constructor of a top level, static member, local, or anonymous class, then the return value is null.- Returns:
- an object representing the receiver type of the method or
 constructor represented by this Executableornullif thisExecutablecan not have a receiver parameter
 
 - 
getAnnotatedParameterTypespublic AnnotatedType[] getAnnotatedParameterTypes() Returns an array ofAnnotatedTypeobjects 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.- Returns:
- an array of objects representing the types of the
 formal parameters of the method or constructor represented by this
 Executable
 
 - 
getAnnotatedExceptionTypespublic AnnotatedType[] getAnnotatedExceptionTypes() Returns an array ofAnnotatedTypeobjects 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.- Returns:
- an array of objects representing the declared
 exceptions of the method or constructor represented by this Executable
 
 
- 
 
-