com.gwtplatform.dispatch.annotation.helper

Class ReflectionHelper

java.lang.Object

com.gwtplatform.dispatch.annotation.helper.ReflectionHelper

public class ReflectionHelper
extends Object

ReflectionHelper is an internal class that provides common routines only used by the annotation processors.

Constructor Summary

Constructors

Constructor and Description
ReflectionHelper(ProcessingEnvironment environment, TypeElement classRepresenter)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<VariableElement>	filterConstantFields(Collection<VariableElement> fieldElements)
Collection<VariableElement>	filterFields(Collection<VariableElement> fieldElements, Class<? extends Annotation>... annotations) Returns only fields which are not annotated with one of the passed annotation.
Collection<VariableElement>	filterFields(Collection<VariableElement> fieldElements, Modifier... modifiers) Returns only fields which do not contain one of the passed modifiers.
Collection<VariableElement>	filterFields(Collection<VariableElement> fieldElements, String... simpleFieldNames) Returns only fields which simple names do not equal the passed field names.
Collection<VariableElement>	getAnnotatedFields(Class<? extends Annotation>... annotations) Returns all fields annotated with the passed annotation classes.
String	getClassName() Returns the class name.
TypeElement	getClassRepresenter()
Collection<VariableElement>	getConstantFields() Returns all fields ordered that are Modifier.FINAL or Modifier.STATIC.
protected Elements	getElementUtils() Utility method.
Collection<VariableElement>	getFields() Returns all fields.
Collection<VariableElement>	getFinalFields() Returns all fields which contains Modifier.FINAL.
Collection<VariableElement>	getInFields() Returns all fields annotated with @In.
Collection<VariableElement>	getModifierFields(Modifier... modifiers) Returns all fields with the passed modifier.
Collection<VariableElement>	getNonConstantFields() Returns all fields that are not Modifier.FINAL or Modifier.STATIC.
Collection<VariableElement>	getOptionalFields() Returns all non constant fields annotated with @Optional.
Collection<VariableElement>	getOptionalFields(Class<? extends Annotation> annotation) Returns all non constant fields annotated with passed annotation.
Collection<VariableElement>	getOrderedFields() Returns all fields ordered.
Collection<VariableElement>	getOutFields() Returns all fields annotated with @Out.
String	getPackageName()
ProcessingEnvironment	getProcessingEnvironment()
Collection<VariableElement>	getRequiredFields() Returns all non Optional|Modifier.STATIC| Modifier.FINAL fields ordered.
String	getSimpleClassName()
Collection<VariableElement>	getStaticFields() Returns all fields which contains Modifier.STATIC.
boolean	hasOptionalFields()
boolean	hasRequiredFields()
Collection<VariableElement>	sortFields(Class<? extends Annotation> annotation, Collection<VariableElement> fields) Sorts the passed fields based on the passed annotation sort logic.
protected void	sortInFields(SortedMap<Integer,VariableElement> sortedFields, Collection<VariableElement> fields)
protected void	sortOrderFields(SortedMap<Integer,VariableElement> sortedFields, Collection<VariableElement> fields)
protected void	sortOutFields(SortedMap<Integer,VariableElement> sortedFields, Collection<VariableElement> fields)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionHelper

public ReflectionHelper(ProcessingEnvironment environment,
                TypeElement classRepresenter)

Method Detail

filterConstantFields

public Collection<VariableElement> filterConstantFields(Collection<VariableElement> fieldElements)

filterFields

public Collection<VariableElement> filterFields(Collection<VariableElement> fieldElements,
                                       Class<? extends Annotation>... annotations)

Returns only fields which are not annotated with one of the passed annotation.

filterFields

public Collection<VariableElement> filterFields(Collection<VariableElement> fieldElements,
                                       Modifier... modifiers)

Returns only fields which do not contain one of the passed modifiers.

filterFields

public Collection<VariableElement> filterFields(Collection<VariableElement> fieldElements,
                                       String... simpleFieldNames)

Returns only fields which simple names do not equal the passed field names.

getAnnotatedFields

public Collection<VariableElement> getAnnotatedFields(Class<? extends Annotation>... annotations)

Returns all fields annotated with the passed annotation classes.

getClassName

public String getClassName()

Returns the class name.

For example:
com.gwtplatform.dispatch.annotation.Foo

Returns:

the class name.

getClassRepresenter

public TypeElement getClassRepresenter()

getConstantFields

public Collection<VariableElement> getConstantFields()

Returns all fields ordered that are Modifier.FINAL or Modifier.STATIC.

getFields

public Collection<VariableElement> getFields()

Returns all fields.

Important: Fields are not sorted according to @Order!

To get these sorted use getOrderedFields().

getFinalFields

public Collection<VariableElement> getFinalFields()

Returns all fields which contains Modifier.FINAL.

getInFields

public Collection<VariableElement> getInFields()

Returns all fields annotated with @In. Sorted based on the @ In annotation.

getModifierFields

public Collection<VariableElement> getModifierFields(Modifier... modifiers)

Returns all fields with the passed modifier.

getNonConstantFields

public Collection<VariableElement> getNonConstantFields()

Returns all fields that are not Modifier.FINAL or Modifier.STATIC. Sorted based on the @ Order annotation.

getOptionalFields

public Collection<VariableElement> getOptionalFields()

Returns all non constant fields annotated with @Optional. Sorted based on the @ Order annotation.

getOptionalFields

public Collection<VariableElement> getOptionalFields(Class<? extends Annotation> annotation)

Returns all non constant fields annotated with passed annotation.

Important: Fields are not sorted!

getOrderedFields

public Collection<VariableElement> getOrderedFields()

Returns all fields ordered. Sorted based on the @ Order annotation.

getOutFields

public Collection<VariableElement> getOutFields()

Returns all fields annotated with @Out. Sorted based on the @ Out annotation.

getPackageName

public String getPackageName()

getProcessingEnvironment

public ProcessingEnvironment getProcessingEnvironment()

getRequiredFields

public Collection<VariableElement> getRequiredFields()

Returns all non Optional|Modifier.STATIC| Modifier.FINAL fields ordered. Sorted based on the @ Order annotation.

Required are all:

• Declared fields matching rules below
• Non annotated Optional fields
• Non Modifier.STATIC fields
• Non Modifier.FINAL fields

getSimpleClassName

public String getSimpleClassName()

getStaticFields

public Collection<VariableElement> getStaticFields()

Returns all fields which contains Modifier.STATIC.

sortFields

public Collection<VariableElement> sortFields(Class<? extends Annotation> annotation,
                                     Collection<VariableElement> fields)

Sorts the passed fields based on the passed annotation sort logic.

hasOptionalFields

public boolean hasOptionalFields()

hasRequiredFields

public boolean hasRequiredFields()

getElementUtils

protected Elements getElementUtils()

Utility method.

sortInFields

protected void sortInFields(SortedMap<Integer,VariableElement> sortedFields,
                Collection<VariableElement> fields)

sortOrderFields

protected void sortOrderFields(SortedMap<Integer,VariableElement> sortedFields,
                   Collection<VariableElement> fields)

sortOutFields

protected void sortOutFields(SortedMap<Integer,VariableElement> sortedFields,
                 Collection<VariableElement> fields)