org.apache.juneau.reflect

Class MethodInfo

java.lang.Object

org.apache.juneau.reflect.ExecutableInfo

org.apache.juneau.reflect.MethodInfo

All Implemented Interfaces:

Comparable<MethodInfo>

@BeanIgnore
public final class MethodInfo
extends ExecutableInfo
implements Comparable<MethodInfo>

Lightweight utility class for introspecting information about a method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MethodInfo(ClassInfo declaringClass, Method m, Method rm) Constructor.

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> List<T>	appendAnnotations(List<T> l, Class<T> a) Finds and appends the specified annotation on the specified method and methods on superclasses/interfaces to the specified list.
<T extends Annotation> List<T>	appendAnnotationsParentFirst(List<T> l, Class<T> a) Finds and appends the specified annotation on the specified class and superclasses/interfaces to the specified list.
boolean	argsOnlyOfType(Class<?>... args) Returns true if the parameters on the method only consist of the types specified in the list.
int	compareTo(MethodInfo o)
<T extends Annotation> T	getAnnotation(Class<T> a) Finds the annotation of the specified type defined on this method.
<T extends Annotation> T	getAnnotation(Class<T> a, MetaProvider mp) Finds the annotation of the specified type defined on this method.
AnnotationList	getAnnotationList(Predicate<AnnotationInfo<?>> filter) Constructs an AnnotationList of all annotations found on this method.
AnnotationList	getAnnotationListMethodOnlyParentFirst(Predicate<AnnotationInfo<?>> filter) Same as getAnnotationListParentFirst(Predicate) except only returns annotations defined on methods.
AnnotationList	getAnnotationListParentFirst(Predicate<AnnotationInfo<?>> filter) Constructs an AnnotationList of all annotations found on this method.
<T extends Annotation> List<T>	getAnnotations(Class<T> a) Returns all annotations of the specified type defined on the specified method.
<T extends Annotation> List<T>	getAnnotationsParentFirst(Class<T> a) Identical to getAnnotations(Class) but returns the list in reverse (parent-to-child) order.
Annotation	getAnyAnnotation(Class<? extends Annotation>... c) Returns the first annotation in the specified list on this method.
List<Method>	getMatching() Finds all declared methods with the same name and arguments on all superclasses and interfaces.
Iterable<Method>	getMatchingParentFirst() Convenience method for retrieving values in getMatching() in parent-to-child order.
String	getPropertyName() Returns the bean property name if this is a getter or setter.
ClassInfo	getResolvedReturnType() Returns the generic return type of this method as a ClassInfo object.
ClassInfo	getReturnType() Returns the generic return type of this method as a ClassInfo object.
String	getSignature() Returns the signature of this method.
boolean	hasAnnotation(Class<? extends Annotation> a) Returns true if the specified annotation is present on this method.
boolean	hasConfigAnnotations() Returns true if this method or parent methods have any annotations annotated with PropertyStoreApply.
boolean	hasReturnType(Class<?> c) Returns true if this method has this return type.
boolean	hasReturnType(ClassInfo ci) Returns true if this method has this return type.
boolean	hasReturnTypeParent(Class<?> c) Returns true if this method has this parent return type.
boolean	hasReturnTypeParent(ClassInfo ci) Returns true if this method has this parent return type.
Method	inner() Returns the wrapped method.
<T> T	invoke(Object obj, Object... args) Shortcut for calling the invoke method on the underlying method.
Object	invokeFuzzy(Object pojo, Object... args) Invokes the specified method using fuzzy-arg matching.
boolean	isBridge() Returns true if this method is a bridge method.
static MethodInfo	of(Class<?> declaringClass, Method m, Method rm) Convenience method for instantiating a MethodInfo;
static MethodInfo	of(ClassInfo declaringClass, Method m, Method rm) Convenience method for instantiating a MethodInfo;
static MethodInfo	of(Method m) Convenience method for instantiating a MethodInfo;

Methods inherited from class org.apache.juneau.reflect.ExecutableInfo

getDeclaringClass, getExceptionTypes, getFullName, getParam, getParamCount, getParameterAnnotations, getParameterAnnotations, getParams, getParamType, getParamTypes, getRawExceptionTypes, getRawGenericParamType, getRawGenericParamTypes, getRawParameter, getRawParameters, getRawParamType, getRawParamTypes, getShortName, getSimpleName, hasFuzzyParamTypes, hasFuzzyParamTypes, hasName, hasName, hasName, hasNoParams, hasNumParams, hasParams, hasParamTypeParents, hasParamTypeParents, hasParamTypes, hasParamTypes, isAbstract, isAll, isAny, isConstructor, isDeprecated, isNotAbstract, isNotDeprecated, isNotPublic, isNotStatic, isPublic, isStatic, isVisible, setAccessible, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodInfo

protected MethodInfo(ClassInfo declaringClass,
                     Method m,
                     Method rm)

Constructor.

Parameters:

declaringClass - The class that declares this method.

m - The method being wrapped.

rm - The "real" method if the method above is defined against a CGLIB proxy.

Method Detail

of

public static MethodInfo of(ClassInfo declaringClass,
                            Method m,
                            Method rm)

Convenience method for instantiating a MethodInfo;

Parameters:

declaringClass - The class that declares this method.

m - The method being wrapped.

rm - The "real" method if the method above is defined against a CGLIB proxy.

Returns:

A new MethodInfo object, or null if the method was null;

of

public static MethodInfo of(Class<?> declaringClass,
                            Method m,
                            Method rm)

Convenience method for instantiating a MethodInfo;

Parameters:

declaringClass - The class that declares this method.

m - The method being wrapped.

rm - The "real" method if the method above is defined against a CGLIB proxy.

Returns:

A new MethodInfo object, or null if the method was null;

of

public static MethodInfo of(Method m)

Convenience method for instantiating a MethodInfo;

Parameters:

m - The method being wrapped.

Returns:

A new MethodInfo object, or null if the method was null;

inner

public Method inner()

Returns the wrapped method.

Returns:

The wrapped method.

getMatching

public List<Method> getMatching()

Finds all declared methods with the same name and arguments on all superclasses and interfaces.

Returns:

All matching methods including this method itself.
Methods are ordered from child-to-parent order.

getMatchingParentFirst

public Iterable<Method> getMatchingParentFirst()

Convenience method for retrieving values in getMatching() in parent-to-child order.

Returns:

All matching methods including this method itself.
Methods are ordered from parent-to-child order.

getAnnotation

public final <T extends Annotation> T getAnnotation(Class<T> a)

Finds the annotation of the specified type defined on this method.

If this is a method and the annotation cannot be found on the immediate method, searches methods with the same signature on the parent classes or interfaces.
The search is performed in child-to-parent order.

Parameters:

a - The annotation to search for.

Returns:

The annotation if found, or null if not.

getAnnotation

public final <T extends Annotation> T getAnnotation(Class<T> a,
                                                    MetaProvider mp)

Finds the annotation of the specified type defined on this method.

Searches all methods with the same signature on the parent classes or interfaces and the return type on the method.

Parameters:

a - The annotation to search for.

mp - The meta provider for looking up annotations on classes/methods/fields.

Returns:

The first annotation found, or null if it doesn't exist.

hasAnnotation

public final boolean hasAnnotation(Class<? extends Annotation> a)

Returns true if the specified annotation is present on this method.

Parameters:

a - The annotation to check for.

Returns:

true if the specified annotation is present on this method.

getAnnotations

public <T extends Annotation> List<T> getAnnotations(Class<T> a)

Returns all annotations of the specified type defined on the specified method.

Searches all methods with the same signature on the parent classes or interfaces and the return type on the method.

Parameters:

a - The annotation to search for.

Returns:

A list of all matching annotations found in child-to-parent order, or an empty list if none found.

getAnnotationsParentFirst

public <T extends Annotation> List<T> getAnnotationsParentFirst(Class<T> a)

Identical to getAnnotations(Class) but returns the list in reverse (parent-to-child) order.

Parameters:

a - The annotation to search for.

Returns:

A list of all matching annotations found or an empty list if none found.

appendAnnotations

public <T extends Annotation> List<T> appendAnnotations(List<T> l,
                                                        Class<T> a)

Finds and appends the specified annotation on the specified method and methods on superclasses/interfaces to the specified list.

Results are ordered in child-to-parent order.

Parameters:

l - The list of annotations.

a - The annotation.

Returns:

The same list.

appendAnnotationsParentFirst

public <T extends Annotation> List<T> appendAnnotationsParentFirst(List<T> l,
                                                                   Class<T> a)

Finds and appends the specified annotation on the specified class and superclasses/interfaces to the specified list.

Parameters:

l - The list of annotations.

a - The annotation.

Returns:

The same list.

getAnyAnnotation

@SafeVarargs
public final Annotation getAnyAnnotation(Class<? extends Annotation>... c)

Returns the first annotation in the specified list on this method.

Parameters:

c - The annotations that cannot be present on the method.

Returns:

true if this method does not have any of the specified annotations.

getAnnotationList

public AnnotationList getAnnotationList(Predicate<AnnotationInfo<?>> filter)

Constructs an AnnotationList of all annotations found on this method.

Annotations are appended in the following orders:

1. On this method and matching methods ordered child-to-parent.
2. On this class.
3. On parent classes ordered child-to-parent.
4. On interfaces ordered child-to-parent.
5. On the package of this class.

Parameters:

filter - Optional filter to apply to limit which annotations are added to the list.
Can be null for no filtering.

Returns:

A new AnnotationList object on every call.

getAnnotationListParentFirst

public AnnotationList getAnnotationListParentFirst(Predicate<AnnotationInfo<?>> filter)

Constructs an AnnotationList of all annotations found on this method.

Annotations are appended in the following orders:

1. On the package of this class.
2. On interfaces ordered parent-to-child.
3. On parent classes ordered parent-to-child.
4. On this class.
5. On this method and matching methods ordered parent-to-child.

Parameters:

filter - Optional filter to apply to limit which annotations are added to the list.
Can be null for no filtering.

Returns:

A new AnnotationList object on every call.

getAnnotationListMethodOnlyParentFirst

public AnnotationList getAnnotationListMethodOnlyParentFirst(Predicate<AnnotationInfo<?>> filter)

Same as getAnnotationListParentFirst(Predicate) except only returns annotations defined on methods.

Parameters:

filter - Optional filter to apply to limit which annotations are added to the list.
Can be null for no filtering.

Returns:

A new AnnotationList object on every call.

hasConfigAnnotations

public boolean hasConfigAnnotations()

Returns true if this method or parent methods have any annotations annotated with PropertyStoreApply.

Returns:

true if this method or parent methods have any annotations annotated with PropertyStoreApply.

getReturnType

public ClassInfo getReturnType()

Returns the generic return type of this method as a ClassInfo object.

Returns:

The generic return type of this method.

getResolvedReturnType

public ClassInfo getResolvedReturnType()

Returns the generic return type of this method as a ClassInfo object.

Unwraps the type if it's a Value.

Returns:

The generic return type of this method.

hasReturnType

public boolean hasReturnType(Class<?> c)

Returns true if this method has this return type.

Parameters:

c - The return type to test for.

Returns:

true if this method has this return type.

hasReturnType

public boolean hasReturnType(ClassInfo ci)

Returns true if this method has this return type.

Parameters:

ci - The return type to test for.

Returns:

true if this method has this return type.

hasReturnTypeParent

public boolean hasReturnTypeParent(Class<?> c)

Returns true if this method has this parent return type.

Parameters:

c - The return type to test for.

Returns:

true if this method has this parent return type.

hasReturnTypeParent

public boolean hasReturnTypeParent(ClassInfo ci)

Returns true if this method has this parent return type.

Parameters:

ci - The return type to test for.

Returns:

true if this method has this parent return type.

invoke

public <T> T invoke(Object obj,
                    Object... args)
             throws ExecutableException

Shortcut for calling the invoke method on the underlying method.

Parameters:

obj - the object the underlying method is invoked from.

args - the arguments used for the method call

Returns:

The object returned from the method.

Throws:

ExecutableException - Exception occurred on invoked constructor/method/field.

invokeFuzzy

public Object invokeFuzzy(Object pojo,
                          Object... args)
                   throws ExecutableException

Invokes the specified method using fuzzy-arg matching.

Arguments will be matched to the parameters based on the parameter types.
Arguments can be in any order.
Extra arguments will be ignored.
Missing arguments will be left null.

Note that this only works for methods that have distinguishable argument types.
It's not going to work on methods with generic argument types like Object

Parameters:

pojo - The POJO the method is being called on.
Can be null for static methods.

args - The arguments to pass to the method.

Returns:

The results of the method invocation.

Throws:

ExecutableException - Exception occurred on invoked constructor/method/field.

getSignature

public String getSignature()

Returns the signature of this method.

For no-arg methods, the signature will be a simple string such as "toString". For methods with one or more args, the arguments will be fully-qualified class names (e.g. "append(java.util.StringBuilder,boolean)")

Returns:

The methods signature.

getPropertyName

public String getPropertyName()

Returns the bean property name if this is a getter or setter.

Returns:

The bean property name, or null if this isn't a getter or setter.

argsOnlyOfType

public boolean argsOnlyOfType(Class<?>... args)

Returns true if the parameters on the method only consist of the types specified in the list.

Example:

// Example method: public void foo(String bar, Integer baz); argsOnlyOfType(fooMethod, String.class, Integer.class); // True. argsOnlyOfType(fooMethod, String.class, Integer.class, Map.class); // True. argsOnlyOfType(fooMethod, String.class); // False.

Parameters:

args - The valid class types (exact) for the arguments.

Returns:

true if the method parameters only consist of the types specified in the list.

isBridge

public boolean isBridge()

Returns true if this method is a bridge method.

Returns:

true if this method is a bridge method.

compareTo

public int compareTo(MethodInfo o)

Specified by:

compareTo in interface Comparable<MethodInfo>