com.github.misberner.apcommons.util.methods

Class MethodUtils

java.lang.Object

com.github.misberner.apcommons.util.methods.MethodUtils

public abstract class MethodUtils
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkParameters(ExecutableElement elem, TypeUtils.TypeMatcher... paramTypeMatchers)
static boolean	checkSignature(ExecutableElement elem, TypeUtils.TypeMatcher returnTypeMatcher, TypeUtils.TypeMatcher... paramTypeMatchers)
static List<ParameterInfo>	getInfosFromParamList(List<? extends VariableElement> veList, boolean varArgs) Turns a list of VariableElements into a ParameterInfo list.
static List<ParameterInfo>	getParameterInfos(ExecutableElement method) Turns the parameter list of an ExecutableElement into a list of ParameterInfo objects.
static boolean	isObjectMethod(ExecutableElement method) Checks whether the specified method is one of the methods declared by the Object class.

Methods inherited from class java.lang.Object

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

Method Detail

isObjectMethod

public static boolean isObjectMethod(ExecutableElement method)

Checks whether the specified method is one of the methods declared by the Object class. Hence, the method returns true if the specified method is one of

• Object.clone()
• Object.finalize()
• Object.getClass()
• Object.hashCode()
• Object.notify()
• Object.notifyAll()
• Object.toString()
• Object.wait()
• Object.equals(Object)
• Object.wait(long)
• Object.wait(long, int)

Parameters:

method - the method to check

Returns:

true if this method was declared by Object, false otherwise.

checkSignature

public static boolean checkSignature(ExecutableElement elem,
                     TypeUtils.TypeMatcher returnTypeMatcher,
                     TypeUtils.TypeMatcher... paramTypeMatchers)

checkParameters

public static boolean checkParameters(ExecutableElement elem,
                      TypeUtils.TypeMatcher... paramTypeMatchers)

getInfosFromParamList

public static List<ParameterInfo> getInfosFromParamList(List<? extends VariableElement> veList,
                                        boolean varArgs)
                                                 throws IllegalArgumentException

Turns a list of VariableElements into a ParameterInfo list.

Parameters:

veList - the list of VariableElements

varArgs - whether this parameter list is of a varargs method. If set to true, the last parameter must have an array type and is interpreted as a varargs parameter

Returns:

the corresponding list of ParameterInfo objects

Throws:

IllegalArgumentException - if one of the following conditions is true:

• one of the elements of veList is null
• one of the elements of veList has a null type or name
• varArgs is set to true, but veList is empty
• varArgs is set to true, but the type of the last element of veList is not an array type

getParameterInfos

public static List<ParameterInfo> getParameterInfos(ExecutableElement method)

Turns the parameter list of an ExecutableElement into a list of ParameterInfo objects.

This is a convenience method, equivalent to

 fromParamList(method.getParameters(), method.isVarArgs())
 

Parameters:

method - the method from which to retrieve the parameter list

Returns:

the corresponding list of ParameterInfo objects