Method Summary

Method Details

• equals

  public boolean equals(Object obj)

  Compares based on the executable and the index.

  Overrides:

  equals in class Object

  Parameters:

  obj - The object to compare.

  Returns:

  Whether or not this is equal to the argument.

  See Also:

  • Object.hashCode()
  • HashMap

• hashCode

  public int hashCode()

  Returns a hash code based on the executable's hash code and the index.

  Overrides:

  hashCode in class Object

  Returns:

  A hash code based on the executable's hash code.

  See Also:

  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

• isNamePresent

  public boolean isNamePresent()

  Returns true if the parameter has a name according to the class file; returns false otherwise. Whether a parameter has a name is determined by the MethodParameters attribute of the method which declares the parameter.

  Returns:

  true if and only if the parameter has a name according to the class file.

• toString

  public String toString()

  Returns a string describing this parameter. The format is the modifiers for the parameter, if any, in canonical order as recommended byThe Java Language Specification, followed by the fully-qualified type of the parameter (excluding the last [] if the parameter is variable arity), followed by "..." if the parameter is variable arity, followed by a space, followed by the name of the parameter.

  Overrides:

  toString in class Object

  Returns:

  A string representation of the parameter and associated information.

• getDeclaringExecutable

  public Executable getDeclaringExecutable()

  Returns theExecutable declaring this parameter.

  Returns:

  theExecutable declaring this parameter

• getModifiers

  public int getModifiers()

  Returns the Java languagemodifiers for the parameter represented by this object.

  Returns:

  the Java languagemodifiers for the parameter represented by this object

  SeeJava Language Specification:

  8.4.1 Formal Parameters
  

  See Also:

  • Java programming language and JVM modeling in core reflection

• getName

  public String getName()

  Returns the name of the parameter. If the parameter's name ispresent, then this method returns the name provided by the class file. Otherwise, this method synthesizes a name of the form argN, where N is the index of the parameter in the descriptor of the method which declares the parameter.

  Returns:

  The name of the parameter, either provided by the class file or synthesized if the class file does not provide a name.

• getParameterizedType

  public Type getParameterizedType()

  Returns aType object that identifies the parameterized type for the parameter represented by thisParameter object.

  Returns:

  aType object identifying the parameterized type of the parameter represented by this object

• getType

  public Class<?> getType()

  Returns aClass object that identifies the declared type for the parameter represented by thisParameter object.

  Returns:

  aClass object identifying the declared type of the parameter represented by this object

• getAnnotatedType

  public AnnotatedType getAnnotatedType()

  Returns an AnnotatedType object that represents the use of a type to specify the type of the formal parameter represented by this Parameter.

  Returns:

  anAnnotatedType object representing the use of a type to specify the type of the formal parameter represented by this Parameter

• isImplicit

  public boolean isImplicit()

  Returnstrue if this parameter is implicitly declared in source code; returnsfalse otherwise.

  Returns:

  true if and only if this parameter is implicitly declared as defined byThe Java Language Specification.

• isSynthetic

  public boolean isSynthetic()

  Returnstrue if this parameter is neither implicitly nor explicitly declared in source code; returnsfalse otherwise.

  Returns:

  true if and only if this parameter is a synthetic construct as defined byThe Java Language Specification.

  SeeJava Language Specification:

  13.1 The Form of a Binary
  

  See Also:

  • Java programming language and JVM modeling in core reflection

• isVarArgs

  public boolean isVarArgs()

  Returnstrue if this parameter represents a variable argument list; returnsfalse otherwise.

  Returns:

  true if an only if this parameter represents a variable argument list.

• getAnnotation

  public <T extendsAnnotation> T getAnnotation(Class<T> annotationClass)

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

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

  Specified by:

  getAnnotation in interface AnnotatedElement

  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 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 arepeatable annotation type (JLS9.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.

  Specified by:

  getAnnotationsByType in interface AnnotatedElement

  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 will have no effect on the arrays returned to other callers.

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

  Specified by:

  getDeclaredAnnotations in interface AnnotatedElement

  Returns:

  annotations directly present on this element

• getDeclaredAnnotation

  public <T extendsAnnotation> T getDeclaredAnnotation(Class<T> annotationClass)

  Returns this element's annotation for the specified type if such an annotation isdirectly 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.

  Specified by:

  getDeclaredAnnotation in interface AnnotatedElement

  Type Parameters:

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

  Parameters:

  annotationClass - the Class object corresponding to the annotation type

  Returns:

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

  Throws:

  NullPointerException - if the given annotation class is null

• getDeclaredAnnotationsByType

  public <T extendsAnnotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)

  Returns this element's annotation(s) for the specified type if such annotations are eitherdirectly present orindirectly 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 andAnnotatedElement.getDeclaredAnnotation(Class) is that this method detects if its argument is arepeatable annotation type (JLS9.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.

  Specified by:

  getDeclaredAnnotationsByType in interface AnnotatedElement

  Type Parameters:

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

  Parameters:

  annotationClass - the Class object corresponding to the annotation type

  Returns:

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

  Throws:

  NullPointerException - if the given annotation class is null

• getAnnotations

  public Annotation[] getAnnotations()

  Returns annotations that arepresent on this element. If there are no annotationspresent 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.

  Specified by:

  getAnnotations in interface AnnotatedElement

  Returns:

  annotations present on this element