Class Executable

java.lang.Object
java.lang.reflect.AccessibleObject
java.lang.reflect.Executable
All Implemented Interfaces:
AnnotatedElement,GenericDeclaration,Member
Direct Known Subclasses:
Constructor,Method
public abstract sealed classExecutableextendsAccessibleObjectimplementsMember,GenericDeclarationpermitsConstructor<T>,Method
A shared superclass for the common functionality ofMethodandConstructor.
Sealed Class Hierarchy Graph:
Sealed class hierarchy graph for ExecutableSealed class hierarchy graph for Executable
Since:
1.8

  • Method Details

    • getDeclaringClass

      public abstract Class<?> getDeclaringClass()
      Returns theClass object representing the class or interfacethat declares the executable represented by this object.
      Specified by:
      getDeclaringClass in interface Member
      Returns:
      an object representing the declaring class of theunderlying member

    • getName

      public abstract String getName()
      Returns the name of the executable represented by this object.
      Specified by:
      getName in interface Member
      Returns:
      the simple name of the underlying member

    • getModifiers

      public abstract int getModifiers()
      Returns the Java languagemodifiers forthe executable represented by this object.
      Specified by:
      getModifiers in interface Member
      Returns:
      the Java languagemodifiers forthe executable represented by this object
      See Also:

    • accessFlags

      public Set<AccessFlag> accessFlags()
      Returns an unmodifiable set of theaccess flags for the executable represented by this object,possibly empty.
      Specified by:
      accessFlags in interface Member
      Returns:
      an unmodifiable set of theaccess flags for the executable represented by this object,possibly empty
      SeeJava Virtual Machine Specification:
      4.6 Methods
      Since:
      20
      See Also:

    • getTypeParameters

      public abstract TypeVariable<?>[] getTypeParameters()
      Returns an array ofTypeVariable objects that represent thetype variables declared by the generic declaration represented by thisGenericDeclaration object, in declaration order. Returns anarray of length 0 if the underlying generic declaration declares no typevariables.
      Specified by:
      getTypeParameters in interface GenericDeclaration
      Returns:
      an array ofTypeVariable objects 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 inThe Java Virtual Machine Specification

    • getParameterTypes

      public abstract Class<?>[] getParameterTypes()
      Returns an array ofClass objects that represent the formalparameter types, in declaration order, of the executablerepresented by this object. Returns an array of length0 if the underlying executable takes no parameters.Note that the constructors of some inner classesmay have animplicitly declared parameter in addition to explicitlydeclared ones.Also note that compact constructors of a record class may haveimplicitly declared parameters.
      Returns:
      the parameter types for the executable this objectrepresents

    • getParameterCount

      public abstract int getParameterCount()
      Returns the number of formal parameters (whether explicitlydeclared or implicitly declared or neither) for the executablerepresented by this object.
      Returns:
      The number of formal parameters for the executable thisobject represents

    • getGenericParameterTypes

      public Type[] getGenericParameterTypes()
      Returns an array ofType objects that represent theformal parameter types, in declaration order, of the executablerepresented by this object. An array of length 0 is returned if theunderlying executable takes no parameters. Note that theconstructors of some inner classes may have an implicitlydeclared parameter in addition to explicitly declared ones.Compact constructors of a record class may also haveimplicitly declared parameters,but they are a special case and thus considered as if they hadbeen explicitly declared in the source.Finally note that as amodeling artifact, the number of returned parameters can differdepending on whether or not generic information is present. Ifgeneric information is present, parameters explicitlypresent in the source or parameters of compact constructorsof a record class will be returned.Note that parameters of compact constructors of a record class are a special case,as they are not explicitly present in the source, and its type will be returnedregardless of the parameters beingimplicitly declared or not.If generic information is not present, implicit and synthetic parameters may bereturned as well.

      If a formal parameter type is a parameterized type,theType object returned for it must accurately reflectthe actual type arguments used in the source code. This assertion alsoapplies to the parameters of compact constructors of a record class,independently of them beingimplicitly declared or not.

      If a formal parameter type is a type variable or a parameterizedtype, it is created. Otherwise, it is resolved.

      Returns:
      an array ofTypes 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 inThe 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

    • getParameters

      public Parameter[] getParameters()
      Returns an array ofParameter objects representingall the parameters to the underlying executable represented bythis object. An array of length 0 is returned if the executablehas no parameters.

      The parameters of the underlying executable do not necessarilyhave unique names, or names that are legal identifiers in theJava programming language (JLS3.8).

      Returns:
      an array ofParameter objects representingall the parameters to the underlying executable represented bythis object
      Throws:
      MalformedParametersException - if the class file containsa MethodParameters attribute that is improperly formatted.

    • getExceptionTypes

      public abstract Class<?>[] getExceptionTypes()
      Returns an array ofClass objects that represent thetypes of exceptions declared to be thrown by the underlyingexecutable represented by this object. Returns an array oflength 0 if the executable declares no exceptions in itsthrows clause.
      Returns:
      the exception types declared as being thrown by theexecutable this object represents

    • getGenericExceptionTypes

      public Type[] getGenericExceptionTypes()
      Returns an array ofType objects that represent theexceptions declared to be thrown by this executable object.Returns an array of length 0 if the underlying executable declaresno exceptions in itsthrows clause.

      If an exception type is a type variable or a parameterizedtype, 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 inThe Java Virtual Machine Specification
      TypeNotPresentException - if the underlying executable'sthrows clause refers to a non-existent type declaration
      MalformedParameterizedTypeException - if the underlying executable'sthrows clause refers to a parameterized type that cannot be instantiated for any reason

    • toGenericString

      public abstract String toGenericString()
      Returns a string describing thisExecutable, includingany type parameters.
      Returns:
      a string describing thisExecutable, includingany type parameters

    • isVarArgs

      public boolean isVarArgs()
      Returnstrue if this executable was declared to take avariable number of arguments; returnsfalse otherwise.
      Returns:
      true if this executable was declared to take avariable number of arguments; returnsfalse otherwise

    • isSynthetic

      public boolean isSynthetic()
      Returnstrue if this executable is a syntheticconstruct; returnsfalse otherwise.
      Specified by:
      isSynthetic in interface Member
      Returns:
      true if and only if this executable is a syntheticconstruct as defined byThe Java Language Specification.
      SeeJava Language Specification:
      13.1 The Form of a Binary
      SeeJava Virtual Machine Specification:
      4.6 Methods

    • getParameterAnnotations

      public abstract Annotation[][] getParameterAnnotations()
      Returns an array of arrays ofAnnotations thatrepresent the annotations on the formal parameters, indeclaration order, of theExecutable represented bythis object. Synthetic and mandated parameters (seeexplanation below), such as the outer "this" parameter to aninner class constructor will be represented in the returnedarray. If the executable has no parameters (meaning no formal,no synthetic, and no mandated parameters), a zero-length arraywill be returned. If theExecutable has one or moreparameters, a nested array of length zero is returned for eachparameter with no annotations. The annotation objects containedin the returned arrays are serializable. The caller of thismethod is free to modify the returned arrays; it will have noeffect on the arrays returned to other callers.A compiler may add extra parameters that are implicitlydeclared in source ("mandated"), as well as parameters thatare neither implicitly nor explicitly declared in source("synthetic") to the parameter list for a method. SeeParameter for more information.

      Note that any annotations returned by this method aredeclaration annotations.

      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:

    • getAnnotation

      public <T extendsAnnotation> T getAnnotation(Class<T> annotationClass)
      Returns this element's annotation for the specified type ifsuch an annotation ispresent, else null.

      Note that any annotation returned by this method is adeclaration annotation.

      Specified by:
      getAnnotation in interface AnnotatedElement
      Overrides:
      getAnnotation in 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

    • getAnnotationsByType

      public <T extendsAnnotation> T[] getAnnotationsByType(Class<T> annotationClass)
      Returns annotations that areassociated with this element.If there are no annotationsassociated with this element, the returnvalue is an array of length 0.The difference between this method andAnnotatedElement.getAnnotation(Class)is that this method detects if its argument is arepeatableannotation type (JLS9.6), and if so, attempts to find one ormore annotations of that type by "looking through" a containerannotation.The caller of this method is free to modify the returned array; it willhave no effect on the arrays returned to other callers.

      Note that any annotations returned by this method aredeclaration annotations.

      Specified by:
      getAnnotationsByType in interface AnnotatedElement
      Overrides:
      getAnnotationsByType in 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

    • getDeclaredAnnotations

      public Annotation[] getDeclaredAnnotations()
      Returns annotations that aredirectly present on this element.This method ignores inherited annotations.If there are no annotationsdirectly 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 willhave no effect on the arrays returned to other callers.

      Note that any annotations returned by this method aredeclaration annotations.

      Specified by:
      getDeclaredAnnotations in interface AnnotatedElement
      Overrides:
      getDeclaredAnnotations in class AccessibleObject
      Returns:
      annotations directly present on this element

    • getAnnotatedReturnType

      public abstract AnnotatedType getAnnotatedReturnType()
      Returns anAnnotatedType object that represents the use of a type tospecify the return type of the method/constructor represented by thisExecutable.If thisExecutable object represents a constructor, theAnnotatedType object represents the type of the constructed object.If thisExecutable object represents a method, theAnnotatedType object represents the use of a type to specify the returntype of the method.
      Returns:
      an object representing the return type of the methodor constructor represented by thisExecutable

    • getAnnotatedReceiverType

      public AnnotatedType getAnnotatedReceiverType()
      Returns anAnnotatedType object that represents the use of atype to specify the receiver type of the method/constructor representedby thisExecutable object.The receiver type of a method/constructor is available only if themethod/constructor has a receiver parameter (JLS8.4.1). If thisExecutable objectrepresents an instance method or represents aconstructor of an inner member class, and themethod/constructoreither has no receiver parameter or has areceiver parameter with no annotations on its type, then the returnvalue is anAnnotatedType object representing an element with noannotations.If thisExecutable object represents a static method orrepresents a constructor of a top level, static member, local, oranonymous class, then the return value is null.
      Returns:
      an object representing the receiver type of the method orconstructor represented by thisExecutable ornull ifthisExecutable can not have a receiver parameter
      SeeJava Language Specification:
      8.4 Method Declarations
      8.4.1 Formal Parameters
      8.8 Constructor Declarations

    • getAnnotatedParameterTypes

      public AnnotatedType[] getAnnotatedParameterTypes()
      Returns an array ofAnnotatedType objects that represent the useof types to specify formal parameter types of the method/constructorrepresented by this Executable. The order of the objects in the arraycorresponds to the order of the formal parameter types in thedeclaration of the method/constructor.Returns an array of length 0 if the method/constructor declares noparameters.Note that the constructors of some inner classesmay have animplicitly declared parameter in addition to explicitly declared ones.Also note that compact constructors of a record class may haveimplicitly declared parameters.
      Returns:
      an array of objects representing the types of theformal parameters of the method or constructor represented by thisExecutable

    • getAnnotatedExceptionTypes

      public AnnotatedType[] getAnnotatedExceptionTypes()
      Returns an array ofAnnotatedType objects that represent the useof types to specify the declared exceptions of the method/constructorrepresented by this Executable. The order of the objects in the arraycorresponds to the order of the exception types in the declaration ofthe method/constructor.Returns an array of length 0 if the method/constructor declares noexceptions.
      Returns:
      an array of objects representing the declaredexceptions of the method or constructor represented by thisExecutable