com.github.misberner.apcommons.util

Class APUtils

java.lang.Object

com.github.misberner.apcommons.util.APUtils

public class APUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
APUtils(ProcessingEnvironment processingEnv)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,VariableElement>	allFieldsByName(TypeElement type) Retrieves a by-name map of all fields (inherited or directly declared) of a given type.
boolean	checkMethodSignature(ExecutableElement method, CharSequence... paramTypeNames)
boolean	checkMethodSignature(ExecutableElement method, Class<?>[] paramTypes)
boolean	checkMethodSignature(ExecutableElement method, Class<?> firstParamType, Class<?>... otherParamTypes)
Map<String,VariableElement>	declaredFieldsByName(TypeElement type) Retrieves a by-name map of the directly declared fields of a given type.
Map<String,List<ExecutableElement>>	declaredMethodsByName(TypeElement type) Retrieves a by-name map of the directly declared methods of a given type.
ExecutableElement	findConstructor(Iterable<? extends ExecutableElement> allConstructors, CharSequence... paramTypeNames)
ExecutableElement	findConstructor(Iterable<? extends ExecutableElement> allConstructors, Class<?>... paramTypes)
ExecutableElement	findConstructor(Iterable<? extends ExecutableElement> allConstructors, Class<?> firstParamType, Class<?>... otherParamTypes)
ExecutableElement	findConstructor(TypeElement type, CharSequence... paramTypeNames)
ExecutableElement	findConstructor(TypeElement type, Class<?>[] paramTypes)
ExecutableElement	findConstructor(TypeElement type, Class<?> firstParamType, Class<?>... otherParamTypes)
ExecutableElement	findDeclaredMethod(TypeElement type, CharSequence name, Class<?> firstParamType, Class<?>... otherParamTypes)
ExecutableElement	findDeclaredMethod(TypeElement type, CharSequence name, String... paramTypeNames)
ExecutableElement	findMethod(Iterable<? extends ExecutableElement> allMethods, CharSequence name, CharSequence... paramTypeNames)
ExecutableElement	findMethod(Iterable<? extends ExecutableElement> allMethods, CharSequence name, Class<?> firstParamType, Class<?>... otherParamTypes)
ExecutableElement	findMethod(TypeElement type, CharSequence name, Class<?> firstParamType, Class<?>... otherParamTypes)
ExecutableElement	findMethod(TypeElement type, CharSequence name, String... paramTypeNames)
List<? extends VariableElement>	getAllFields(TypeElement type) Retrieves all fields of a given type, whether inherited or directly declared.
List<? extends ExecutableElement>	getAllMethods(TypeElement type) Retrieves all methods of a given type, whether inherited or directly declared.
List<? extends VariableElement>	getDeclaredFields(TypeElement type) Retrieves the directly declared fields of a given type.
List<? extends ExecutableElement>	getDeclaredMethods(TypeElement type) Retrieves the directly declared methods of a given type.
Elements	getElementUtils() Retrieves a reference to the element utilities.
Filer	getFiler() Retrieves a reference to the filer.
Messager	getMessager() Retrieves a reference to the messager.
ProcessingEnvironment	getProcessingEnv() Retrieves a reference to the processing environment.
RootReporter	getReporter()
ElementReporter	getReporter(Element elem)
AnnotationReporter	getReporter(Element elem, AnnotationMirror annotation)
ValueReporter	getReporter(Element elem, AnnotationMirror annotation, AnnotationValue value)
ValueReporter	getReporter(Element elem, AnnotationMirror annotation, CharSequence valueName)
AnnotationReporter	getReporter(Element elem, CharSequence annotationName)
ValueReporter	getReporter(Element elem, CharSequence annotationName, CharSequence valueName)
AnnotationReporter	getReporter(Element elem, Class<? extends Annotation> annotationClazz)
ValueReporter	getReporter(Element elem, Class<? extends Annotation> annotationClazz, CharSequence valueName)
Types	getTypeUtils() Retrieves a reference to the type utilities.
Map<String,List<ExecutableElement>>	methodsByName(TypeElement type) Retrieves a by-name map of all methods (inherited or directly declared) of a given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

APUtils

public APUtils(ProcessingEnvironment processingEnv)

Method Detail

getProcessingEnv

public ProcessingEnvironment getProcessingEnv()

Retrieves a reference to the processing environment.

Returns:

a reference to the processing environment.

getTypeUtils

public Types getTypeUtils()

Retrieves a reference to the type utilities.

Returns:

a reference to the type utilities.

getElementUtils

public Elements getElementUtils()

Retrieves a reference to the element utilities.

Returns:

a reference to the element utilities.

getFiler

public Filer getFiler()

Retrieves a reference to the filer.

Returns:

a reference to the filer

getMessager

public Messager getMessager()

Retrieves a reference to the messager.

Returns:

a reference to the messager

checkMethodSignature

public boolean checkMethodSignature(ExecutableElement method,
                           CharSequence... paramTypeNames)

checkMethodSignature

public boolean checkMethodSignature(ExecutableElement method,
                           Class<?>[] paramTypes)

checkMethodSignature

public boolean checkMethodSignature(ExecutableElement method,
                           Class<?> firstParamType,
                           Class<?>... otherParamTypes)

findConstructor

public ExecutableElement findConstructor(Iterable<? extends ExecutableElement> allConstructors,
                                CharSequence... paramTypeNames)

findConstructor

public ExecutableElement findConstructor(Iterable<? extends ExecutableElement> allConstructors,
                                Class<?>... paramTypes)

findConstructor

public ExecutableElement findConstructor(Iterable<? extends ExecutableElement> allConstructors,
                                Class<?> firstParamType,
                                Class<?>... otherParamTypes)

findConstructor

public ExecutableElement findConstructor(TypeElement type,
                                CharSequence... paramTypeNames)

findConstructor

public ExecutableElement findConstructor(TypeElement type,
                                Class<?> firstParamType,
                                Class<?>... otherParamTypes)

findConstructor

public ExecutableElement findConstructor(TypeElement type,
                                Class<?>[] paramTypes)

findMethod

public ExecutableElement findMethod(Iterable<? extends ExecutableElement> allMethods,
                           CharSequence name,
                           CharSequence... paramTypeNames)

findMethod

public ExecutableElement findMethod(Iterable<? extends ExecutableElement> allMethods,
                           CharSequence name,
                           Class<?> firstParamType,
                           Class<?>... otherParamTypes)

findDeclaredMethod

public ExecutableElement findDeclaredMethod(TypeElement type,
                                   CharSequence name,
                                   String... paramTypeNames)

findDeclaredMethod

public ExecutableElement findDeclaredMethod(TypeElement type,
                                   CharSequence name,
                                   Class<?> firstParamType,
                                   Class<?>... otherParamTypes)

findMethod

public ExecutableElement findMethod(TypeElement type,
                           CharSequence name,
                           String... paramTypeNames)

findMethod

public ExecutableElement findMethod(TypeElement type,
                           CharSequence name,
                           Class<?> firstParamType,
                           Class<?>... otherParamTypes)

declaredMethodsByName

public Map<String,List<ExecutableElement>> declaredMethodsByName(TypeElement type)

Retrieves a by-name map of the directly declared methods of a given type.

Note that due to overloading, several methods with the same type may exist.

Parameters:

type - the type

Returns:

a by-name map of the directly declared methods of the specified type.

methodsByName

public Map<String,List<ExecutableElement>> methodsByName(TypeElement type)

Retrieves a by-name map of all methods (inherited or directly declared) of a given type.

Note that due to overloading, several methods with the same type may exist.

Parameters:

type - the type

Returns:

a by-name map of all methods (inherited or directly declared) of the specified type.

declaredFieldsByName

public Map<String,VariableElement> declaredFieldsByName(TypeElement type)

Retrieves a by-name map of the directly declared fields of a given type.

Parameters:

type - the type

Returns:

a by-name map of the directly declared fields of the specified type.

allFieldsByName

public Map<String,VariableElement> allFieldsByName(TypeElement type)

Retrieves a by-name map of all fields (inherited or directly declared) of a given type.

Parameters:

type - the type

Returns:

a by-name map of all fields (inherited or directly declared) of the specified type.

getDeclaredMethods

public List<? extends ExecutableElement> getDeclaredMethods(TypeElement type)

Retrieves the directly declared methods of a given type.

Parameters:

type - the type

Returns:

a list of the directly declared methods of the specified type.

getAllMethods

public List<? extends ExecutableElement> getAllMethods(TypeElement type)

Retrieves all methods of a given type, whether inherited or directly declared.

Parameters:

type - the type

Returns:

a list of all methods (inherited or directly declared) of the specified type.

getDeclaredFields

public List<? extends VariableElement> getDeclaredFields(TypeElement type)

Retrieves the directly declared fields of a given type.

Parameters:

type - the type

Returns:

a list of the directly declared fields of the specified type.

getAllFields

public List<? extends VariableElement> getAllFields(TypeElement type)

Retrieves all fields of a given type, whether inherited or directly declared.

Parameters:

type - the type

Returns:

a list of all fields (inherited or directly declared) of the specified type.

getReporter

public RootReporter getReporter()

getReporter

public ElementReporter getReporter(Element elem)

getReporter

public AnnotationReporter getReporter(Element elem,
                             AnnotationMirror annotation)

getReporter

public AnnotationReporter getReporter(Element elem,
                             CharSequence annotationName)

getReporter

public AnnotationReporter getReporter(Element elem,
                             Class<? extends Annotation> annotationClazz)

getReporter

public ValueReporter getReporter(Element elem,
                        AnnotationMirror annotation,
                        AnnotationValue value)

getReporter

public ValueReporter getReporter(Element elem,
                        AnnotationMirror annotation,
                        CharSequence valueName)

getReporter

public ValueReporter getReporter(Element elem,
                        CharSequence annotationName,
                        CharSequence valueName)

getReporter

public ValueReporter getReporter(Element elem,
                        Class<? extends Annotation> annotationClazz,
                        CharSequence valueName)