Module java.base

Package java.lang.reflect

Class Method

java.lang.Object

java.lang.reflect.AccessibleObject

java.lang.reflect.Executable

java.lang.reflect.Method

All Implemented Interfaces:

AnnotatedElement, GenericDeclaration, Member

public final class Method
extends Executable

A Method provides information about, and access to, a single method on a class or interface. The reflected method may be a class method or an instance method (including an abstract method).

A Method permits widening conversions to occur when matching the actual parameters to invoke with the underlying method's formal parameters, but it throws an IllegalArgumentException if a narrowing conversion would occur.

Since:

1.1

See Also:

Member, Class, Class.getMethods(), Class.getMethod(String, Class[]), Class.getDeclaredMethods(), Class.getDeclaredMethod(String, Class[])

Field Summary

Fields inherited from interface java.lang.reflect.Member

DECLARED, PUBLIC

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares this Method against the specified object.
AnnotatedType	getAnnotatedReturnType()	Returns an AnnotatedType object that represents the use of a type to specify the return type of the method/constructor represented by this Executable.
<T extends Annotation> T	getAnnotation(Class<T> annotationClass)	Returns this element's annotation for the specified type if such an annotation is present, else null.
Annotation[]	getDeclaredAnnotations()	Returns annotations that are directly present on this element.
Class<?>	getDeclaringClass()	Returns the Class object representing the class or interface that declares the method represented by this object.
Object	getDefaultValue()	Returns the default value for the annotation member represented by this Method instance.
Class<?>[]	getExceptionTypes()	Returns an array of Class objects that represent the types of exceptions declared to be thrown by the underlying executable represented by this object.
Type[]	getGenericExceptionTypes()	Returns an array of Type objects that represent the exceptions declared to be thrown by this executable object.
Type[]	getGenericParameterTypes()	Returns an array of Type objects that represent the formal parameter types, in declaration order, of the executable represented by this object.
Type	getGenericReturnType()	Returns a Type object that represents the formal return type of the method represented by this Method object.
int	getModifiers()	Returns the Java language modifiers for the executable represented by this object.
String	getName()	Returns the name of the method represented by this Method object, as a String.
Annotation[][]	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.
int	getParameterCount()	Returns the number of formal parameters (whether explicitly declared or implicitly declared or neither) for the executable represented by this object.
Class<?>[]	getParameterTypes()	Returns an array of Class objects that represent the formal parameter types, in declaration order, of the executable represented by this object.
Class<?>	getReturnType()	Returns a Class object that represents the formal return type of the method represented by this Method object.
TypeVariable<Method>[]	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.
int	hashCode()	Returns a hashcode for this Method.
Object	invoke(Object obj, Object... args)	Invokes the underlying method represented by this Method object, on the specified object with the specified parameters.
boolean	isBridge()	Returns true if this method is a bridge method; returns false otherwise.
boolean	isDefault()	Returns true if this method is a default method; returns false otherwise.
boolean	isSynthetic()	Returns true if this executable is a synthetic construct; returns false otherwise.
boolean	isVarArgs()	Returns true if this executable was declared to take a variable number of arguments; returns false otherwise.
void	setAccessible(boolean flag)	Set the accessible flag for this reflected object to the indicated boolean value.
String	toGenericString()	Returns a string describing this Method, including type parameters.
String	toString()	Returns a string describing this Method.

Methods inherited from class java.lang.reflect.AccessibleObject

canAccess, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAccessible, isAnnotationPresent, setAccessible, trySetAccessible

Methods inherited from interface java.lang.reflect.AnnotatedElement

getAnnotations, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent

Methods inherited from class java.lang.reflect.Executable

getAnnotatedExceptionTypes, getAnnotatedParameterTypes, getAnnotatedReceiverType, getAnnotationsByType, getParameters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

setAccessible

public void setAccessible(boolean flag)

Description copied from class: AccessibleObject

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 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.

If there is a security manager, its checkPermission method is first called with a ReflectPermission("suppressAccessChecks") permission.

Overrides:

setAccessible in class AccessibleObject

Parameters:

flag - the new value for the accessible flag

Throws:

InaccessibleObjectException - if access cannot be enabled

SecurityException - if the request is denied by the security manager

See Also:

AccessibleObject.trySetAccessible(), MethodHandles.privateLookupIn(java.lang.Class<?>, java.lang.invoke.MethodHandles.Lookup)

getDeclaringClass

public Class<?> getDeclaringClass()

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

Specified by: