OpenJDK 27 · java.lang.reflect.Method · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final byte[]	annotationDefault
private final byte[]	annotations
private byte	callerSensitive
private final Class<?>	clazz
private final Class<?>[]	exceptionTypes
private transient volatile MethodRepository	genericInfo
private int	hash
private MethodAccessor	methodAccessor
private final int	modifiers
private final String	name
private final byte[]	parameterAnnotations
private final Class<?>[]	parameterTypes
private final Class<?>	returnType
private Method	root Methods are mutable due to `AccessibleObject#setAccessible(boolean)`.
private final transient String	signature
private final int	slot

Access	Constructor and Description
pack-priv	Method(Class<?> declaringClass, String name, Class<?>[] parameterTypes, Class<?> returnType, Class<?>[] checkedExceptions, int modifiers, int slot, String signature, byte[] annotations, byte[] parameterAnnotations, byte[] annotationDefault) Package-private constructor

Method Summary

Modifier and Type	Method and Description
private MethodAccessor	acquireMethodAccessor()
pack-priv void	appendModifiers(StringBuilder sb) Implements abstract java.lang.reflect.Executable.appendModifiers.
pack-priv void	checkCanSetAccessible(Class<?> caller) Overrides java.lang.reflect.AccessibleObject.checkCanSetAccessible. If the given AccessibleObject is a `Constructor`, `Method` or `Field` then checks that its declaring class is in a package that can be accessed by the given caller of setAccessible.
pack-priv Method	copy() Package-private routine (exposed to java.lang.Class via ReflectAccess) which returns a copy of this Method.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Compares this `Method` against the specified object.
public AnnotatedType	getAnnotatedReturnType() Implements abstract java.lang.reflect.Executable.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.
public <T extends Annotation> T	getAnnotation(Class<T> annotationClass) Overrides java.lang.reflect.Executable.getAnnotation. Implements java.lang.reflect.AnnotatedElement.getAnnotation. Returns this element's annotation for the specified type if such an annotation is present, else null.
pack-priv byte[]	getAnnotationBytes() Implements abstract java.lang.reflect.Executable.getAnnotationBytes. Accessor method to allow code sharing
public Annotation[]	getDeclaredAnnotations() Overrides java.lang.reflect.Executable.getDeclaredAnnotations. Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Returns annotations that are directly present on this element.
public Class<?>	getDeclaringClass() Implements abstract java.lang.reflect.Executable.getDeclaringClass. Implements java.lang.reflect.Member.getDeclaringClass. Returns the `Class` object representing the class or interface that declares the method represented by this object.
public Object	Returns: the default value for the annotation member represented by this `Method` instance. getDefaultValue() Returns the default value for the annotation member represented by this `Method` instance.
public Class<?>[]	getExceptionTypes() Implements abstract java.lang.reflect.Executable.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.
private GenericsFactory	getFactory()
public Type[]	getGenericExceptionTypes() Overrides java.lang.reflect.Executable.getGenericExceptionTypes. Returns an array of `Type` objects that represent the exceptions declared to be thrown by this executable object.
pack-priv MethodRepository	getGenericInfo() Implements abstract java.lang.reflect.Executable.getGenericInfo.
public Type[]	getGenericParameterTypes() Overrides java.lang.reflect.Executable.getGenericParameterTypes. Returns an array of `Type` objects that represent the formal parameter types, in declaration order, of the executable represented by this object.
public Type	Returns: a `Type` object that represents the formal return type of the underlying method getGenericReturnType() Returns a `Type` object that represents the formal return type of the method represented by this `Method` object.
private String	getGenericSignature()
pack-priv MethodAccessor	getMethodAccessor()
public int	getModifiers() Implements abstract java.lang.reflect.Executable.getModifiers. Implements java.lang.reflect.Member.getModifiers. Returns the Java language modifiers for the executable represented by this object.
public String	getName() Implements abstract java.lang.reflect.Executable.getName. Implements java.lang.reflect.Member.getName. Returns the name of the method represented by this `Method` object, as a `String`.
public Annotation[][]	getParameterAnnotations() Implements abstract java.lang.reflect.Executable.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.
public int	getParameterCount() Implements abstract java.lang.reflect.Executable.getParameterCount. Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object.
public Class<?>[]	getParameterTypes() Implements abstract java.lang.reflect.Executable.getParameterTypes. Returns an array of `Class` objects that represent the formal parameter types, in declaration order, of the executable represented by this object.
public Class<?>	Returns: the return type for the method this object represents getReturnType() Returns a `Class` object that represents the formal return type of the method represented by this `Method` object.
pack-priv Method	getRoot() Overrides java.lang.reflect.AccessibleObject.getRoot. Returns the root AccessibleObject; or null if this object is the root.
pack-priv Class<?>[]	getSharedExceptionTypes() Implements abstract java.lang.reflect.Executable.getSharedExceptionTypes.
pack-priv Class<?>[]	getSharedParameterTypes() Implements abstract java.lang.reflect.Executable.getSharedParameterTypes.
public TypeVariable<Method>[]	getTypeParameters() Implements abstract java.lang.reflect.Executable.getTypeParameters. Implements java.lang.reflect.GenericDeclaration.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.
pack-priv boolean	handleParameterNumberMismatch(int resultLength, Class<?>[] parameterTypes) Implements abstract java.lang.reflect.Executable.handleParameterNumberMismatch.
pack-priv boolean	hasGenericInformation() Implements abstract java.lang.reflect.Executable.hasGenericInformation. Does the Executable have generic information.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hashcode for this `Method`.
public Object	Returns: the result of dispatching the method represented by this object on `obj` with parameters `args` invoke(Object the object the underlying method is invoked from obj, Object... the arguments used for the method call args) Invokes the underlying method represented by this `Method` object, on the specified object with the specified parameters.
private Object	invoke(Object obj, Object[] args, Class<?> caller) This is to support MethodHandle calling caller-sensitive Method::invoke that may invoke a caller-sensitive method in order to get the original caller class (not the injected invoker).
public boolean	Returns: `true` if this method is a bridge method; returns `false` otherwise isBridge() Returns `true` if this method is a bridge method; returns `false` otherwise.
private boolean	isCallerSensitive()
public boolean	Returns: true if and only if this method is a default method as defined by the Java Language Specification. isDefault() Returns `true` if this method is a default method; returns `false` otherwise.
public boolean	isSynthetic() Overrides java.lang.reflect.Executable.isSynthetic. Implements java.lang.reflect.Member.isSynthetic. Returns `true` if this executable is a synthetic construct; returns `false` otherwise.
public boolean	isVarArgs() Overrides java.lang.reflect.Executable.isVarArgs. Returns `true` if this executable was declared to take a variable number of arguments; returns `false` otherwise.
public void	setAccessible(boolean flag) Overrides java.lang.reflect.AccessibleObject.setAccessible. Set the `accessible` flag for this reflected object to the indicated boolean value.
pack-priv void	setMethodAccessor(MethodAccessor accessor)
pack-priv void	specificToGenericStringHeader(StringBuilder sb) Implements abstract java.lang.reflect.Executable.specificToGenericStringHeader. Generate toGenericString header information specific to a method or constructor.
pack-priv void	specificToStringHeader(StringBuilder sb) Implements abstract java.lang.reflect.Executable.specificToStringHeader. Generate toString header information specific to a method or constructor.
public String	Returns: a string describing this `Method`, include type parameters toGenericString() Overrides java.lang.reflect.Executable.toGenericString. Returns a string describing this `Method`, including type parameters.
pack-priv String	toShortSignature()
pack-priv String	toShortString() Overrides java.lang.reflect.AccessibleObject.toShortString. Returns a short descriptive string to describe this object in log messages.
public String	Returns: a string describing this `Method` toString() Overrides java.lang.Object.toString. Returns a string describing this `Method`.

Inherited from java.lang.reflect.Executable:: accessFlags equalParamTypes getAllGenericParameterTypes getAnnotatedExceptionTypes getAnnotatedParameterTypes getAnnotatedReceiverType getAnnotatedReturnType0 getAnnotationsByType getParameters getTypeAnnotationBytes getTypeAnnotationBytes0 hasRealParameterData parameterize parseParameterAnnotations sharedGetParameterAnnotations sharedToGenericString sharedToString typeVarBounds

annotationDefault	back to summary
private final byte[] annotationDefault

annotations	back to summary
private final byte[] annotations

callerSensitive	back to summary
private byte callerSensitive Annotations @Stable

clazz	back to summary
private final Class<?> clazz

exceptionTypes	back to summary
private final Class<?>[] exceptionTypes

genericInfo	back to summary
private transient volatile MethodRepository genericInfo

hash	back to summary
private int hash

methodAccessor	back to summary
private MethodAccessor methodAccessor Annotations @Stable

modifiers	back to summary
private final int modifiers

name	back to summary
private final String name

parameterAnnotations	back to summary
private final byte[] parameterAnnotations

parameterTypes	back to summary
private final Class<?>[] parameterTypes

returnType	back to summary
private final Class<?> returnType

root	back to summary
private Method root Methods are mutable due to `AccessibleObject#setAccessible(boolean)`. Thus, we return a new copy of a root each time a method is returned. Some lazily initialized immutable states can be stored on root and shared to the copies.

signature	back to summary
private final transient String signature

slot	back to summary
private final int slot

Method	back to summary
pack-priv Method(Class<?> declaringClass, String name, Class<?>[] parameterTypes, Class<?> returnType, Class<?>[] checkedExceptions, int modifiers, int slot, String signature, byte[] annotations, byte[] parameterAnnotations, byte[] annotationDefault) Package-private constructor

Method Detail

acquireMethodAccessor	back to summary
private MethodAccessor acquireMethodAccessor()

appendModifiers	back to summary
pack-priv void appendModifiers(StringBuilder sb) Implements abstract java.lang.reflect.Executable.appendModifiers. Annotations @Override

appendModifiers

back to summary

pack-priv void appendModifiers(StringBuilder sb)

Implements abstract java.lang.reflect.Executable.appendModifiers.

Annotations

@Override

checkCanSetAccessible back to summary

checkCanSetAccessible	back to summary
pack-priv void checkCanSetAccessible(Class<?> caller) Overrides java.lang.reflect.AccessibleObject.checkCanSetAccessible. Doc from java.lang.reflect.AccessibleObject.checkCanSetAccessible. If the given AccessibleObject is a `Constructor`, `Method` or `Field` then checks that its declaring class is in a package that can be accessed by the given caller of setAccessible. Annotations @Override

pack-priv void checkCanSetAccessible(Class<?> caller)

Overrides java.lang.reflect.AccessibleObject.checkCanSetAccessible.

Doc from java.lang.reflect.AccessibleObject.checkCanSetAccessible.

If the given AccessibleObject is a Constructor, Method or Field then checks that its declaring class is in a package that can be accessed by the given caller of setAccessible.

Annotations

@Override

copy	back to summary
pack-priv Method copy() Package-private routine (exposed to java.lang.Class via ReflectAccess) which returns a copy of this Method. The copy's "root" field points to this Method.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Compares this `Method` against the specified object. Returns true if the objects are the same. Two `Methods` are the same if they were declared by the same class and have the same name and formal parameter types and return type.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Compares this Method against the specified object. Returns true if the objects are the same. Two Methods are the same if they were declared by the same class and have the same name and formal parameter types and return type.

getAnnotatedReturnType back to summary

getAnnotatedReturnType	back to summary
public AnnotatedType getAnnotatedReturnType() Implements abstract java.lang.reflect.Executable.getAnnotatedReturnType. Doc from java.lang.reflect.Executable.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. 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. Annotations @Override Since 1.8

public AnnotatedType getAnnotatedReturnType()

Implements abstract java.lang.reflect.Executable.getAnnotatedReturnType.

Doc from java.lang.reflect.Executable.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. 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.

Annotations

@Override

Since

1.8

getAnnotation	back to summary
public <T extends Annotation> T getAnnotation(Class<T> annotationClass) Overrides java.lang.reflect.Executable.getAnnotation. Implements java.lang.reflect.AnnotatedElement.getAnnotation. Doc from java.lang.reflect.Executable.getAnnotation. Returns this element's annotation for the specified type if such an annotation is present, else null. Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.5

getAnnotation

back to summary

public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

Overrides java.lang.reflect.Executable.getAnnotation.

Implements java.lang.reflect.AnnotatedElement.getAnnotation.

Doc from java.lang.reflect.Executable.getAnnotation.

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

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.5

getAnnotationBytes	back to summary
pack-priv byte[] getAnnotationBytes() Implements abstract java.lang.reflect.Executable.getAnnotationBytes. Doc from java.lang.reflect.Executable.getAnnotationBytes. Accessor method to allow code sharing Annotations @Override

getAnnotationBytes

back to summary

pack-priv byte[] getAnnotationBytes()

Implements abstract java.lang.reflect.Executable.getAnnotationBytes.

Doc from java.lang.reflect.Executable.getAnnotationBytes.

Accessor method to allow code sharing

Annotations

@Override

getDeclaredAnnotations	back to summary
public Annotation[] getDeclaredAnnotations() Overrides java.lang.reflect.Executable.getDeclaredAnnotations. Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Doc from java.lang.reflect.Executable.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. Annotations @Override Since 1.5

getDeclaredAnnotations

back to summary

public Annotation[] getDeclaredAnnotations()

Overrides java.lang.reflect.Executable.getDeclaredAnnotations.

Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Doc from java.lang.reflect.Executable.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.

Annotations

@Override

Since

1.5

getDeclaringClass back to summary

getDeclaringClass	back to summary
public Class<?> getDeclaringClass() Implements abstract java.lang.reflect.Executable.getDeclaringClass. Implements java.lang.reflect.Member.getDeclaringClass. Returns the `Class` object representing the class or interface that declares the method represented by this object. Annotations @Override

public Class<?> getDeclaringClass()

Implements abstract java.lang.reflect.Executable.getDeclaringClass.

Implements java.lang.reflect.Member.getDeclaringClass.

Returns the Class object representing the class or interface that declares the method represented by this object.

Annotations

@Override

getDefaultValue back to summary

getDefaultValue	back to summary
public Object getDefaultValue() Returns the default value for the annotation member represented by this `Method` instance. If the member is of a primitive type, an instance of the corresponding wrapper type is returned. Returns null if no default is associated with the member, or if the method instance does not represent a declared member of an annotation type. Returns:Object the default value for the annotation member represented by this `Method` instance. Exceptions TypeNotPresentException: if the annotation is of type `Class` and no definition can be found for the default class value. Since 1.5 Java Language Specification 9.6.2 Defaults for Annotation Interface Elements

public Object getDefaultValue()

Returns the default value for the annotation member represented by this Method instance. If the member is of a primitive type, an instance of the corresponding wrapper type is returned. Returns null if no default is associated with the member, or if the method instance does not represent a declared member of an annotation type.

Returns:Object

the default value for the annotation member represented by this Method instance.

Exceptions

TypeNotPresentException:: if the annotation is of type Class and no definition can be found for the default class value.

Since

1.5

Java Language Specification

9.6.2 Defaults for Annotation Interface Elements

getExceptionTypes back to summary

getExceptionTypes	back to summary
public Class<?>[] getExceptionTypes() Implements abstract java.lang.reflect.Executable.getExceptionTypes. Doc from java.lang.reflect.Executable.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. Returns an array of length 0 if the executable declares no exceptions in its `throws` clause. Annotations @Override

public Class<?>[] getExceptionTypes()

Implements abstract java.lang.reflect.Executable.getExceptionTypes.

Doc from java.lang.reflect.Executable.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. Returns an array of length 0 if the executable declares no exceptions in its throws clause.

Annotations

@Override

getFactory	back to summary
private GenericsFactory getFactory()

getGenericExceptionTypes back to summary

getGenericExceptionTypes	back to summary
public Type[] getGenericExceptionTypes() Overrides java.lang.reflect.Executable.getGenericExceptionTypes. Doc from java.lang.reflect.Executable.getGenericExceptionTypes. Returns an array of `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. Annotations @Override Exceptions 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 declaration MalformedParameterizedTypeException: if the underlying executable's `throws` clause refers to a parameterized type that cannot be instantiated for any reason Since 1.5

public Type[] getGenericExceptionTypes()

Overrides java.lang.reflect.Executable.getGenericExceptionTypes.

Doc from java.lang.reflect.Executable.getGenericExceptionTypes.

Returns an array of 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.

Annotations

@Override

Exceptions

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 declaration
MalformedParameterizedTypeException:: if the underlying executable's throws clause refers to a parameterized type that cannot be instantiated for any reason

Since

1.5

getGenericInfo	back to summary
pack-priv MethodRepository getGenericInfo() Implements abstract java.lang.reflect.Executable.getGenericInfo. Annotations @Override

getGenericInfo

back to summary

pack-priv MethodRepository getGenericInfo()

Implements abstract java.lang.reflect.Executable.getGenericInfo.

Annotations

@Override

getGenericParameterTypes back to summary

getGenericParameterTypes	back to summary
public Type[] getGenericParameterTypes() Overrides java.lang.reflect.Executable.getGenericParameterTypes. Doc from java.lang.reflect.Executable.getGenericParameterTypes. Returns an array of `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. Compact constructors of a record class may also have implicitly declared parameters, but they are a special case and thus considered as if they had been explicitly declared in the source. Finally 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, parameters explicitly present in the source or parameters of compact constructors of 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 returned regardless of the parameters being implicitly declared or not. 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. This assertion also applies to the parameters of compact constructors of a record class, independently of them being implicitly declared or not. If a formal parameter type is a type variable or a parameterized type, it is created. Otherwise, it is resolved. Annotations @Override Exceptions 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 Since 1.5

public Type[] getGenericParameterTypes()

Overrides java.lang.reflect.Executable.getGenericParameterTypes.

Doc from java.lang.reflect.Executable.getGenericParameterTypes.

Returns an array of 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. Compact constructors of a record class may also have implicitly declared parameters, but they are a special case and thus considered as if they had been explicitly declared in the source. Finally 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, parameters explicitly present in the source or parameters of compact constructors of 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 returned regardless of the parameters being implicitly declared or not. 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. This assertion also applies to the parameters of compact constructors of a record class, independently of them being implicitly declared or not.

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

Annotations

@Override

Exceptions

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

Since

1.5

getGenericReturnType back to summary

getGenericReturnType	back to summary
public Type getGenericReturnType() Returns a `Type` object that represents the formal return type of the method represented by this `Method` object. If the return type is a parameterized type, the `Type` object returned must accurately reflect the actual type arguments used in the source code. If the return type is a type variable or a parameterized type, it is created. Otherwise, it is resolved. Returns:Type a `Type` object that represents the formal return type of the underlying method Exceptions GenericSignatureFormatError: if the generic method signature does not conform to the format specified in The Java Virtual Machine Specification TypeNotPresentException: if the underlying method's return type refers to a non-existent class or interface declaration MalformedParameterizedTypeException: if the underlying method's return type refers to a parameterized type that cannot be instantiated for any reason Since 1.5

public Type getGenericReturnType()

Returns a Type object that represents the formal return type of the method represented by this Method object.

If the return type is a parameterized type, the Type object returned must accurately reflect the actual type arguments used in the source code.

If the return type is a type variable or a parameterized type, it is created. Otherwise, it is resolved.

Returns:Type

a Type object that represents the formal return type of the underlying method

Exceptions

GenericSignatureFormatError:: if the generic method signature does not conform to the format specified in The Java Virtual Machine Specification
TypeNotPresentException:: if the underlying method's return type refers to a non-existent class or interface declaration
MalformedParameterizedTypeException:: if the underlying method's return type refers to a parameterized type that cannot be instantiated for any reason

Since

1.5

getGenericSignature	back to summary
private String getGenericSignature()

getMethodAccessor	back to summary
pack-priv MethodAccessor getMethodAccessor()

getModifiers	back to summary
public int getModifiers() Implements abstract java.lang.reflect.Executable.getModifiers. Implements java.lang.reflect.Member.getModifiers. Doc from java.lang.reflect.Executable.getModifiers. Returns the Java language modifiers for the executable represented by this object. Annotations @Override Java Language Specification 8.4.3 Method Modifiers

getModifiers

back to summary

public int getModifiers()

Implements abstract java.lang.reflect.Executable.getModifiers.

Implements java.lang.reflect.Member.getModifiers.

Doc from java.lang.reflect.Executable.getModifiers.

Returns the Java language modifiers for the executable represented by this object.

Annotations

@Override

Java Language Specification

8.4.3 Method Modifiers

getName back to summary

getName	back to summary
public String getName() Implements abstract java.lang.reflect.Executable.getName. Implements java.lang.reflect.Member.getName. Returns the name of the method represented by this `Method` object, as a `String`. Annotations @Override

public String getName()

Implements abstract java.lang.reflect.Executable.getName.

Implements java.lang.reflect.Member.getName.

Returns the name of the method represented by this Method object, as a String.

Annotations

@Override

getParameterAnnotations back to summary

getParameterAnnotations	back to summary
public Annotation[][] getParameterAnnotations() Implements abstract java.lang.reflect.Executable.getParameterAnnotations. Doc from java.lang.reflect.Executable.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. 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 `java.lang.reflect.Parameter` for more information. Note that any annotations returned by this method are declaration annotations. Annotations @Override Since 1.5

public Annotation[][] getParameterAnnotations()

Implements abstract java.lang.reflect.Executable.getParameterAnnotations.

Doc from java.lang.reflect.Executable.getParameterAnnotations.

Returns an array of arrays of Annotations 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 java.lang.reflect.Parameter for more information.

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

Annotations

@Override

Since

1.5

getParameterCount	back to summary
public int getParameterCount() Implements abstract java.lang.reflect.Executable.getParameterCount. Doc from java.lang.reflect.Executable.getParameterCount. Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object. Since 1.8

getParameterCount

back to summary

public int getParameterCount()

Implements abstract java.lang.reflect.Executable.getParameterCount.

Doc from java.lang.reflect.Executable.getParameterCount.

Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object.

Since: 1.8

getParameterTypes back to summary

getParameterTypes	back to summary
public Class<?>[] getParameterTypes() Implements abstract java.lang.reflect.Executable.getParameterTypes. Doc from java.lang.reflect.Executable.getParameterTypes. Returns an array of `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. Also note that compact constructors of a record class may have implicitly declared parameters. Annotations @Override

public Class<?>[] getParameterTypes()

Implements abstract java.lang.reflect.Executable.getParameterTypes.

Doc from java.lang.reflect.Executable.getParameterTypes.

Returns an array of 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. Also note that compact constructors of a record class may have implicitly declared parameters.

Annotations

@Override

getReturnType back to summary

getReturnType	back to summary
public Class<?> getReturnType() Returns a `Class` object that represents the formal return type of the method represented by this `Method` object. Returns:Class<?> the return type for the method this object represents

public Class<?> getReturnType()

Returns a Class object that represents the formal return type of the method represented by this Method object.

Returns:Class<?>: the return type for the method this object represents

getRoot	back to summary
pack-priv Method getRoot() Overrides java.lang.reflect.AccessibleObject.getRoot. Doc from java.lang.reflect.AccessibleObject.getRoot. Returns the root AccessibleObject; or null if this object is the root. All subclasses override this method. Annotations @Override

getRoot

back to summary

pack-priv Method getRoot()

Overrides java.lang.reflect.AccessibleObject.getRoot.

Doc from java.lang.reflect.AccessibleObject.getRoot.

Returns the root AccessibleObject; or null if this object is the root. All subclasses override this method.

Annotations

@Override

getSharedExceptionTypes	back to summary
pack-priv Class<?>[] getSharedExceptionTypes() Implements abstract java.lang.reflect.Executable.getSharedExceptionTypes. Annotations @Override

getSharedExceptionTypes

back to summary

pack-priv Class<?>[] getSharedExceptionTypes()

Implements abstract java.lang.reflect.Executable.getSharedExceptionTypes.

Annotations

@Override

getSharedParameterTypes	back to summary
pack-priv Class<?>[] getSharedParameterTypes() Implements abstract java.lang.reflect.Executable.getSharedParameterTypes. Annotations @Override

getSharedParameterTypes

back to summary

pack-priv Class<?>[] getSharedParameterTypes()

Implements abstract java.lang.reflect.Executable.getSharedParameterTypes.

Annotations

@Override

getTypeParameters back to summary

getTypeParameters	back to summary
public TypeVariable<Method>[] getTypeParameters() Implements abstract java.lang.reflect.Executable.getTypeParameters. Implements java.lang.reflect.GenericDeclaration.getTypeParameters. Doc from java.lang.reflect.Executable.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. Returns an array of length 0 if the underlying generic declaration declares no type variables. Annotations @Override @SuppressWarnings:unchecked Exceptions GenericSignatureFormatError: if the generic signature of this generic declaration does not conform to the format specified in The Java Virtual Machine Specification Since 1.5 Java Language Specification 8.4.4 Generic Methods

public TypeVariable<Method>[] getTypeParameters()

Implements abstract java.lang.reflect.Executable.getTypeParameters.

Implements java.lang.reflect.GenericDeclaration.getTypeParameters.

Doc from java.lang.reflect.Executable.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. Returns an array of length 0 if the underlying generic declaration declares no type variables.

Annotations

@Override
@SuppressWarnings:unchecked

Exceptions

GenericSignatureFormatError:: if the generic signature of this generic declaration does not conform to the format specified in The Java Virtual Machine Specification

Since

1.5

Java Language Specification

8.4.4 Generic Methods

handleParameterNumberMismatch	back to summary
pack-priv boolean handleParameterNumberMismatch(int resultLength, Class<?>[] parameterTypes) Implements abstract java.lang.reflect.Executable.handleParameterNumberMismatch. Annotations @Override

handleParameterNumberMismatch

back to summary

pack-priv boolean handleParameterNumberMismatch(int resultLength, Class<?>[] parameterTypes)

Implements abstract java.lang.reflect.Executable.handleParameterNumberMismatch.

Annotations

@Override

hasGenericInformation

back to summary

pack-priv boolean hasGenericInformation()

Implements abstract java.lang.reflect.Executable.hasGenericInformation.

Doc from java.lang.reflect.Executable.hasGenericInformation.

Does the Executable have generic information.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode for this Method. The hashcode is computed as the exclusive-or of the hashcodes for the underlying method's declaring class name and the method's name.

invoke back to summary

public Object invoke(Object obj, Object... args) throws IllegalAccessException, InvocationTargetException

Invokes the underlying method represented by this Method object, on the specified object with the specified parameters. Individual parameters are automatically unwrapped to match primitive formal parameters, and both primitive and reference parameters are subject to method invocation conversions as necessary.

If the underlying method is static, then the specified obj argument is ignored. It may be null.

If the number of formal parameters required by the underlying method is 0, the supplied args array may be of length 0 or null.

If the underlying method is an instance method, it is invoked using dynamic method lookup as documented in The Java Language Specification, section 15.12.4.4; in particular, overriding based on the runtime type of the target object may occur.

If the underlying method is static, the class that declared the method is initialized if it has not already been initialized.

If the method completes normally, the value it returns is returned to the caller of invoke; if the value has a primitive type, it is first appropriately wrapped in an object. However, if the value has the type of an array of a primitive type, the elements of the array are not wrapped in objects; in other words, an array of primitive type is returned. If the underlying method return type is void, the invocation returns null.

Parameters

obj:Object: the object the underlying method is invoked from
args:Object[]: the arguments used for the method call

Returns:Object

the result of dispatching the method represented by this object on obj with parameters args

Annotations

@CallerSensitive
@ForceInline
@IntrinsicCandidate

Exceptions

IllegalAccessException:: if this Method object is enforcing Java language access control and the underlying method is inaccessible.
InvocationTargetException:: if the underlying method throws an exception.
IllegalArgumentException:: if the method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or implementor thereof); if the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
NullPointerException:: if the specified object is null and the method is an instance method.
ExceptionInInitializerError:: if the initialization provoked by this method fails.

invoke

back to summary

private Object invoke(Object obj, Object[] args, Class<?> caller) throws IllegalAccessException, InvocationTargetException

This is to support MethodHandle calling caller-sensitive Method::invoke that may invoke a caller-sensitive method in order to get the original caller class (not the injected invoker). If this adapter is not presented, MethodHandle invoking Method::invoke will get an invoker class, a hidden nestmate of the original caller class, that becomes the caller class invoking Method::invoke.

Annotations

@CallerSensitiveAdapter

isBridge back to summary

public boolean isBridge()

Returns true if this method is a bridge method; returns false otherwise.

API Note

A bridge method is a synthetic method created by a Java compiler alongside a method originating from the source code. Bridge methods are used by Java compilers in various circumstances to span differences in Java programming language semantics and JVM semantics.

One example use of bridge methods is as a technique for a Java compiler to support covariant overrides, where a subclass overrides a method and gives the new method a more specific return type than the method in the superclass. While the Java language specification forbids a class declaring two methods with the same parameter types but a different return type, the virtual machine does not. A common case where covariant overrides are used is for a Cloneable class where the clone method inherited from java.lang.Object is overridden and declared to return the type of the class. For example, Object declares

protected Object clone() throws CloneNotSupportedException {...}

and EnumSet<E> declares its language-level covariant override

public EnumSet<E> clone() {...}

If this technique was being used, the resulting class file for EnumSet would have two clone methods, one returning EnumSet<E> and the second a bridge method returning Object. The bridge method is a JVM-level override of Object.clone(). The body of the clone bridge method calls its non-bridge counterpart and returns its result.

Returns:boolean: true if this method is a bridge method; returns false otherwise
Since: 1.5
Java Language Specification: 8.4.8.3 Requirements in Overriding and Hiding, 15.12.4.5 Create Frame, Synchronize, Transfer Control
Java Virtual Machine Specification: 4.6 Methods
See Also: Java programming language and JVM modeling in core reflection

isCallerSensitive	back to summary
private boolean isCallerSensitive()

isDefault back to summary

public boolean isDefault()

Returns true if this method is a default method; returns false otherwise. A default method is a public non-abstract instance method, that is, a non-static method with a body, declared in an interface.

Returns:boolean: true if and only if this method is a default method as defined by the Java Language Specification.
Since: 1.8
Java Language Specification: 9.4 Method Declarations

isSynthetic back to summary

public boolean isSynthetic()

Overrides java.lang.reflect.Executable.isSynthetic.

Implements java.lang.reflect.Member.isSynthetic.

Doc from java.lang.reflect.Executable.isSynthetic.

Returns true if this executable is a synthetic construct; returns false otherwise.

Annotations

@Override

Since

1.5

Java Language Specification

13.1 The Form of a Binary

Java Virtual Machine Specification

4.6 Methods

isVarArgs back to summary

public boolean isVarArgs()

Overrides java.lang.reflect.Executable.isVarArgs.

Doc from java.lang.reflect.Executable.isVarArgs.

Returns true if this executable was declared to take a variable number of arguments; returns false otherwise.

Annotations

@Override

Since

1.5

Java Language Specification

8.4.1 Formal Parameters

setAccessible back to summary

public void setAccessible(boolean flag)

Overrides java.lang.reflect.AccessibleObject.setAccessible.

Doc from java.lang.reflect.AccessibleObject.setAccessible.

Set the accessible flag for this reflected object to the indicated boolean value. A value of true indicates that the reflected object should suppress checks for Java language access control when it is used. A value of false indicates that the reflected object should enforce checks for Java language access control when it is used, with the variation noted in the class description.

This method may be used by a caller in class C to enable access to a member of declaring class D if any of the following hold:

C and D are in the same module.
The member is public and D is public in a package that the module containing D exports to at least the module containing C.
The member is protected static, D is public in a package that the module containing D exports to at least the module containing C, and C is a subclass of D.
D is in a package that the module containing D opens to at least the module containing C. All packages in unnamed and open modules are open to all modules and so this method always succeeds when D is in an unnamed or open module.

This method may be used by JNI code with no caller class on the stack to enable access to a member of declaring class D if and only if:

The member is public and D is public in a package that the module containing D exports unconditionally.

This method cannot be used to enable access to private members, members with default (package) access, protected instance members, or protected constructors when the declaring class is in a different module to the caller and the package containing the declaring class is not open to the caller's module.

Annotations

@Override
@CallerSensitive

Exceptions

InaccessibleObjectException:: if access cannot be enabled

setMethodAccessor	back to summary
pack-priv void setMethodAccessor(MethodAccessor accessor)

specificToGenericStringHeader

back to summary

pack-priv void specificToGenericStringHeader(StringBuilder sb)

Implements abstract java.lang.reflect.Executable.specificToGenericStringHeader.

Doc from java.lang.reflect.Executable.specificToGenericStringHeader.

Generate toGenericString header information specific to a method or constructor.

Annotations

@Override

specificToStringHeader

back to summary

pack-priv void specificToStringHeader(StringBuilder sb)

Implements abstract java.lang.reflect.Executable.specificToStringHeader.

Doc from java.lang.reflect.Executable.specificToStringHeader.

Generate toString header information specific to a method or constructor.

Annotations

@Override

toGenericString back to summary

public String toGenericString()

Overrides java.lang.reflect.Executable.toGenericString.

Returns a string describing this Method, including type parameters. The string is formatted as the method access modifiers, if any, followed by an angle-bracketed comma-separated list of the method's type parameters, if any, including informative bounds of the type parameters, if any, followed by the method's generic return type, followed by a space, followed by the class declaring the method, followed by a period, followed by the method name, followed by a parenthesized, comma-separated list of the method's generic formal parameter types. If this method was declared to take a variable number of arguments, instead of denoting the last parameter as "Type[]", it is denoted as "Type...". A space is used to separate access modifiers from one another and from the type parameters or return type. If there are no type parameters, the type parameter list is elided; if the type parameter list is present, a space separates the list from the class name. If the method is declared to throw exceptions, the parameter list is followed by a space, followed by the word "throws" followed by a comma-separated list of the generic thrown exception types.

The access modifiers are placed in canonical order as specified by "The Java Language Specification". This is public, protected or private first, and then other modifiers in the following order: abstract, default, static, final, synchronized, native, strictfp.

Returns:String

a string describing this Method, include type parameters

Annotations

@Override

Since

1.5

Java Language Specification

8.4.3 Method Modifiers, 9.4 Method Declarations, 9.6.1 Annotation Interface Elements

toShortSignature	back to summary
pack-priv String toShortSignature()

toShortString

back to summary

pack-priv String toShortString()

Overrides java.lang.reflect.AccessibleObject.toShortString.

Doc from java.lang.reflect.AccessibleObject.toShortString.

Returns a short descriptive string to describe this object in log messages.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string describing this Method. The string is formatted as the method access modifiers, if any, followed by the method return type, followed by a space, followed by the class declaring the method, followed by a period, followed by the method name, followed by a parenthesized, comma-separated list of the method's formal parameter types. If the method throws checked exceptions, the parameter list is followed by a space, followed by the word "throws" followed by a comma-separated list of the thrown exception types. For example:

   public boolean java.lang.Object.equals(java.lang.Object)

Returns:String: a string describing this Method
Java Language Specification: 8.4.3 Method Modifiers, 9.4 Method Declarations, 9.6.1 Annotation Interface Elements

public final Class Method

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail