com.artemis.utils.reflect

Class Method

java.lang.Object

com.artemis.utils.reflect.Method

public final class Method
extends Object

Provides information about, and access to, a single method on a class or interface.

Author:

nexsoftware

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> T	getAnnotation(Class<T> annotationClass)
Annotation	getDeclaredAnnotation(Class<? extends Annotation> annotationType) Returns an Annotation object reflecting the annotation provided, or null of this field doesn't have such an annotation.
Annotation[]	getDeclaredAnnotations() Returns an array of Annotation objects reflecting all annotations declared by this field, or an empty array if there are none.
Class	getDeclaringClass() Returns the Class object representing the class or interface that declares the method.
String	getName() Returns the name of the method.
Class[]	getParameterTypes() Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method.
Class	getReturnType() Returns a Class object that represents the formal return type of the method.
Object	invoke(Object obj, Object... args) Invokes the underlying method on the supplied object with the supplied parameters.
boolean	isAbstract() Return true if the method includes the abstract modifier.
boolean	isAccessible()
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType) Returns true if the field includes an annotation of the provided class type.
boolean	isDefaultAccess() Return true if the method does not include any of the private, protected, or public modifiers.
boolean	isFinal() Return true if the method includes the final modifier.
boolean	isNative() Return true if the method includes the native modifier.
boolean	isPrivate() Return true if the method includes the private modifier.
boolean	isProtected() Return true if the method includes the protected modifier.
boolean	isPublic() Return true if the method includes the public modifier.
boolean	isStatic() Return true if the method includes the static modifier.
boolean	isVarArgs() Return true if the method takes a variable number of arguments.
void	setAccessible(boolean accessible)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

Returns the name of the method.

getReturnType

public Class getReturnType()

Returns a Class object that represents the formal return type of the method.

getParameterTypes

public Class[] getParameterTypes()

Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method.

getDeclaringClass

public Class getDeclaringClass()

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

isAccessible

public boolean isAccessible()

setAccessible

public void setAccessible(boolean accessible)

isAbstract

public boolean isAbstract()

Return true if the method includes the abstract modifier.

isDefaultAccess

public boolean isDefaultAccess()

Return true if the method does not include any of the private, protected, or public modifiers.

isFinal

public boolean isFinal()

Return true if the method includes the final modifier.

isPrivate

public boolean isPrivate()

Return true if the method includes the private modifier.

isProtected

public boolean isProtected()

Return true if the method includes the protected modifier.

isPublic

public boolean isPublic()

Return true if the method includes the public modifier.

isNative

public boolean isNative()

Return true if the method includes the native modifier.

isStatic

public boolean isStatic()

Return true if the method includes the static modifier.

isVarArgs

public boolean isVarArgs()

Return true if the method takes a variable number of arguments.

invoke

public Object invoke(Object obj,
                     Object... args)
              throws ReflectionException

Invokes the underlying method on the supplied object with the supplied parameters.

Throws:

ReflectionException

getAnnotation

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

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)

Returns true if the field includes an annotation of the provided class type.

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

Returns an array of Annotation objects reflecting all annotations declared by this field, or an empty array if there are none. Does not include inherited annotations.

getDeclaredAnnotation

public Annotation getDeclaredAnnotation(Class<? extends Annotation> annotationType)

Returns an Annotation object reflecting the annotation provided, or null of this field doesn't have such an annotation. This is a convenience function if the caller knows already which annotation type he's looking for.