com.sun.tools.jxc.model.nav
Class APTNavigator

java.lang.Object
  com.sun.tools.jxc.model.nav.APTNavigator

All Implemented Interfaces:

Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

public class APTNavigator
extends java.lang.Object
implements Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Navigator implementation for APT. TODO: check the spec on how generics are supposed to be handled

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Field Summary

Fields inherited from interface com.sun.xml.bind.v2.model.nav.Navigator

REFLECTION

Constructor Summary

APTNavigator(AnnotationProcessorEnvironment env)

Method Summary

TypeDeclaration	asDecl(java.lang.Class c) If the given type is an use of class declaration, returns the type casted as C.
TypeDeclaration	asDecl(TypeMirror m) If the given type is an use of class declaration, returns the type casted as C.
<T> TypeMirror	erasure(TypeMirror t) Computes the erasure
TypeDeclaration	findClass(java.lang.String className, TypeDeclaration referencePoint) Finds the class/interface/enum/annotation of the given name.
TypeMirror	getBaseClass(TypeMirror type, TypeDeclaration sup) Gets the parameterization of the given base type.
Location	getClassLocation(TypeDeclaration decl) Returns a location of the specified class.
java.lang.String	getClassName(TypeDeclaration t) Gets the fully-qualified name of the class.
java.lang.String	getClassShortName(TypeDeclaration t) Gets the short name of the class ("Object" for Object.) For nested classes, this method should just return the inner name.
TypeMirror	getComponentType(TypeMirror t) Gets the component type of the array.
FieldDeclaration	getDeclaredField(TypeDeclaration clazz, java.lang.String fieldName) Gets the named field declared on the given class.
java.util.Collection<FieldDeclaration>	getDeclaredFields(TypeDeclaration c) Gets all the declared fields of the given class.
java.util.Collection<MethodDeclaration>	getDeclaredMethods(TypeDeclaration c) Gets all the declared methods of the given class (regardless of their access modifiers, regardless of whether they override methods of the base classes.)
ClassDeclaration	getDeclaringClassForField(FieldDeclaration f) Gets the class that declares the given field.
ClassDeclaration	getDeclaringClassForMethod(MethodDeclaration m) Gets the class that declares the given method.
FieldDeclaration[]	getEnumConstants(TypeDeclaration clazz) Gets the enumeration constants from an enum class.
Location	getFieldLocation(FieldDeclaration decl)
java.lang.String	getFieldName(FieldDeclaration f) Gets the name of the field.
TypeMirror	getFieldType(FieldDeclaration f) Gets the type of the field.
Location	getMethodLocation(MethodDeclaration decl)
java.lang.String	getMethodName(MethodDeclaration m) Gets the name of the method, such as "toString" or "equals".
TypeMirror[]	getMethodParameters(MethodDeclaration m) Returns the list of parameters to the method.
java.lang.String	getPackageName(TypeDeclaration clazz) Gets the package name of the given class.
TypeMirror	getPrimitive(java.lang.Class primitiveType) Returns the representation for the given primitive type.
TypeMirror	getReturnType(MethodDeclaration m) Gets the return type of a method.
TypeDeclaration	getSuperClass(TypeDeclaration t) Gets the base class of the specified class.
TypeMirror	getTypeArgument(TypeMirror typeMirror, int i) Gets the i-th type argument from a parameterized type.
java.lang.String	getTypeName(TypeMirror typeMirror) Gets the display name of the type object
TypeMirror	getVoidType() Gets the representation of the primitive "void" type.
boolean	hasDefaultConstructor(TypeDeclaration t) Returns true if the given class has a no-arg default constructor.
boolean	isAbstract(TypeDeclaration clazz) Returns true if this is an abstract class.
boolean	isArray(TypeMirror t) Checks if the type is an array type.
boolean	isArrayButNotByteArray(TypeMirror t) Checks if the type is an array type but not byte[].
boolean	isBridgeMethod(MethodDeclaration method) Returns true if this method is a bridge method as defined in JLS.
boolean	isEnum(TypeDeclaration t) Returns true if this is an enum class.
boolean	isFinal(TypeDeclaration clazz) Returns true if this is a final class.
boolean	isFinalMethod(MethodDeclaration m) Returns true if the method is final.
boolean	isInnerClass(TypeDeclaration clazz) Returns true if the given class is an inner class.
boolean	isInterface(TypeDeclaration clazz) Returns true if 'clazz' is an interface.
boolean	isOverriding(MethodDeclaration method, TypeDeclaration base) Returns true if the given method is overriding another one defined in the base class 'base' or its ancestors.
boolean	isParameterizedType(TypeMirror t) Returns true if t is a parameterized type.
boolean	isPrimitive(TypeMirror t) Checks if the given type is a primitive type.
boolean	isPublicField(FieldDeclaration f) Returns true if the field is public.
boolean	isPublicMethod(MethodDeclaration m) Returns true if the method is public.
boolean	isStaticField(FieldDeclaration f) Returns true if the field is static.
boolean	isStaticMethod(MethodDeclaration m) Returns true if the method is static.
boolean	isSubClassOf(TypeMirror sub, TypeMirror sup) Checks if sub is a sub-type of sup.
boolean	isTransient(FieldDeclaration f) Returns true if the field is transient.
TypeMirror	ref(java.lang.Class c) Gets the representation of the given Java type in T.
TypeMirror	use(TypeDeclaration t) Gets the T for the given C.

Methods inherited from class java.lang.Object

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

Constructor Detail

APTNavigator

public APTNavigator(AnnotationProcessorEnvironment env)

Method Detail

getSuperClass

public TypeDeclaration getSuperClass(TypeDeclaration t)

Description copied from interface: Navigator

Gets the base class of the specified class.

Specified by:

getSuperClass in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Returns:

null if the parameter represents Object.

getBaseClass

public TypeMirror getBaseClass(TypeMirror type,
                               TypeDeclaration sup)

Description copied from interface: Navigator

Gets the parameterization of the given base type.

For example, given the following

 interface Foo<T> extends List<List<T>> {}
 interface Bar extends Foo<String> {}
 

This method works like this:

 getBaseClass( Bar, List ) = List<List<String>
 getBaseClass( Bar, Foo  ) = Foo<String>
 getBaseClass( Foo<? extends Number>, Collection ) = Collection<List<? extends Number>>
 getBaseClass( ArrayList<? extends BigInteger>, List ) = List<? extends BigInteger>
 

Specified by:

getBaseClass in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Parameters:

type - The type that derives from baseType

sup - The class whose parameterization we are interested in.

Returns:

The use of baseType in type. or null if the type is not assignable to the base type.

getClassName

public java.lang.String getClassName(TypeDeclaration t)

Description copied from interface: Navigator

Gets the fully-qualified name of the class. ("java.lang.Object" for Object)

Specified by:

getClassName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getTypeName

public java.lang.String getTypeName(TypeMirror typeMirror)

Description copied from interface: Navigator

Gets the display name of the type object

Specified by:

getTypeName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Returns:

a human-readable name that the type represents.

getClassShortName

public java.lang.String getClassShortName(TypeDeclaration t)

Description copied from interface: Navigator

Gets the short name of the class ("Object" for Object.) For nested classes, this method should just return the inner name. (for example "Inner" for "com.acme.Outer$Inner".

Specified by:

getClassShortName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getDeclaredFields

public java.util.Collection<FieldDeclaration> getDeclaredFields(TypeDeclaration c)

Description copied from interface: Navigator

Gets all the declared fields of the given class.

Specified by:

getDeclaredFields in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getDeclaredField

public FieldDeclaration getDeclaredField(TypeDeclaration clazz,
                                         java.lang.String fieldName)

Description copied from interface: Navigator

Gets the named field declared on the given class. This method doesn't visit ancestors, but does recognize non-public fields.

Specified by:

getDeclaredField in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Returns:

null if not found

getDeclaredMethods

public java.util.Collection<MethodDeclaration> getDeclaredMethods(TypeDeclaration c)

Description copied from interface: Navigator

Gets all the declared methods of the given class (regardless of their access modifiers, regardless of whether they override methods of the base classes.)

Note that this method does not list methods declared on base classes.

Specified by:

getDeclaredMethods in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Returns:

can be empty but always non-null.

getDeclaringClassForField

public ClassDeclaration getDeclaringClassForField(FieldDeclaration f)

Description copied from interface: Navigator

Gets the class that declares the given field.

Specified by:

getDeclaringClassForField in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getDeclaringClassForMethod

public ClassDeclaration getDeclaringClassForMethod(MethodDeclaration m)

Description copied from interface: Navigator

Gets the class that declares the given method.

Specified by:

getDeclaringClassForMethod in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getFieldType

public TypeMirror getFieldType(FieldDeclaration f)

Description copied from interface: Navigator

Gets the type of the field.

Specified by:

getFieldType in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getFieldName

public java.lang.String getFieldName(FieldDeclaration f)

Description copied from interface: Navigator

Gets the name of the field.

Specified by:

getFieldName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getMethodName

public java.lang.String getMethodName(MethodDeclaration m)

Description copied from interface: Navigator

Gets the name of the method, such as "toString" or "equals".

Specified by:

getMethodName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getReturnType

public TypeMirror getReturnType(MethodDeclaration m)

Description copied from interface: Navigator

Gets the return type of a method.

Specified by:

getReturnType in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getMethodParameters

public TypeMirror[] getMethodParameters(MethodDeclaration m)

Description copied from interface: Navigator

Returns the list of parameters to the method.

Specified by:

getMethodParameters in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isStaticMethod

public boolean isStaticMethod(MethodDeclaration m)

Description copied from interface: Navigator

Returns true if the method is static.

Specified by:

isStaticMethod in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isFinalMethod

public boolean isFinalMethod(MethodDeclaration m)

Description copied from interface: Navigator

Returns true if the method is final.

Specified by:

isFinalMethod in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isSubClassOf

public boolean isSubClassOf(TypeMirror sub,
                            TypeMirror sup)

Description copied from interface: Navigator

Checks if sub is a sub-type of sup. TODO: should this method take T or C?

Specified by:

isSubClassOf in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

ref

public TypeMirror ref(java.lang.Class c)

Description copied from interface: Navigator

Gets the representation of the given Java type in T.

Specified by:

ref in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Parameters:

c - can be a primitive, array, class, or anything. (therefore the return type has to be T, not C)

use

public TypeMirror use(TypeDeclaration t)

Description copied from interface: Navigator

Gets the T for the given C.

Specified by:

use in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

asDecl

public TypeDeclaration asDecl(TypeMirror m)

Description copied from interface: Navigator

If the given type is an use of class declaration, returns the type casted as C. Otherwise null.

TODO: define the exact semantics.

Specified by:

asDecl in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

asDecl

public TypeDeclaration asDecl(java.lang.Class c)

Description copied from interface: Navigator

If the given type is an use of class declaration, returns the type casted as C. Otherwise null.

TODO: define the exact semantics.

Specified by:

asDecl in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

erasure

public <T> TypeMirror erasure(TypeMirror t)

Description copied from interface: Navigator

Computes the erasure

Specified by:

erasure in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isAbstract

public boolean isAbstract(TypeDeclaration clazz)

Description copied from interface: Navigator

Returns true if this is an abstract class.

Specified by:

isAbstract in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isFinal

public boolean isFinal(TypeDeclaration clazz)

Description copied from interface: Navigator

Returns true if this is a final class.

Specified by:

isFinal in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getEnumConstants

public FieldDeclaration[] getEnumConstants(TypeDeclaration clazz)

Description copied from interface: Navigator

Gets the enumeration constants from an enum class.

Specified by:

getEnumConstants in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Parameters:

clazz - must derive from Enum.

Returns:

can be empty but never null.

getVoidType

public TypeMirror getVoidType()

Description copied from interface: Navigator

Gets the representation of the primitive "void" type.

Specified by:

getVoidType in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getPackageName

public java.lang.String getPackageName(TypeDeclaration clazz)

Description copied from interface: Navigator

Gets the package name of the given class.

Specified by:

getPackageName in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Returns:

i.e. "", "java.lang" but not null.

findClass

public TypeDeclaration findClass(java.lang.String className,
                                 TypeDeclaration referencePoint)

Description copied from interface: Navigator

Finds the class/interface/enum/annotation of the given name.

Specified by:

findClass in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

referencePoint - The class that refers to the specified class.

Returns:

null if not found.

isBridgeMethod

public boolean isBridgeMethod(MethodDeclaration method)

Description copied from interface: Navigator

Returns true if this method is a bridge method as defined in JLS.

Specified by:

isBridgeMethod in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isOverriding

public boolean isOverriding(MethodDeclaration method,
                            TypeDeclaration base)

Description copied from interface: Navigator

Returns true if the given method is overriding another one defined in the base class 'base' or its ancestors.

Specified by:

isOverriding in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isInterface

public boolean isInterface(TypeDeclaration clazz)

Description copied from interface: Navigator

Returns true if 'clazz' is an interface.

Specified by:

isInterface in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isTransient

public boolean isTransient(FieldDeclaration f)

Description copied from interface: Navigator

Returns true if the field is transient.

Specified by:

isTransient in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isInnerClass

public boolean isInnerClass(TypeDeclaration clazz)

Description copied from interface: Navigator

Returns true if the given class is an inner class. This is only used to improve the error diagnostics, so it's OK to fail to detect some inner classes as such. Note that this method should return false for nested classes (static classes.)

Specified by:

isInnerClass in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isArray

public boolean isArray(TypeMirror t)

Description copied from interface: Navigator

Checks if the type is an array type.

Specified by:

isArray in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isArrayButNotByteArray

public boolean isArrayButNotByteArray(TypeMirror t)

Description copied from interface: Navigator

Checks if the type is an array type but not byte[].

Specified by:

isArrayButNotByteArray in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getComponentType

public TypeMirror getComponentType(TypeMirror t)

Description copied from interface: Navigator

Gets the component type of the array.

Specified by:

getComponentType in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Parameters:

t - must be an array.

getTypeArgument

public TypeMirror getTypeArgument(TypeMirror typeMirror,
                                  int i)

Description copied from interface: Navigator

Gets the i-th type argument from a parameterized type. For example, getTypeArgument([Map<Integer,String>],0)=Integer

Specified by:

getTypeArgument in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

See Also:

Navigator.isParameterizedType(Object)

isParameterizedType

public boolean isParameterizedType(TypeMirror t)

Description copied from interface: Navigator

Returns true if t is a parameterized type.

Specified by:

isParameterizedType in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isPrimitive

public boolean isPrimitive(TypeMirror t)

Description copied from interface: Navigator

Checks if the given type is a primitive type.

Specified by:

isPrimitive in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getPrimitive

public TypeMirror getPrimitive(java.lang.Class primitiveType)

Description copied from interface: Navigator

Returns the representation for the given primitive type.

Specified by:

getPrimitive in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

Parameters:

primitiveType - must be Class objects like Integer.TYPE.

getClassLocation

public Location getClassLocation(TypeDeclaration decl)

Description copied from interface: Navigator

Returns a location of the specified class.

Specified by:

getClassLocation in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getFieldLocation

public Location getFieldLocation(FieldDeclaration decl)

Specified by:

getFieldLocation in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

getMethodLocation

public Location getMethodLocation(MethodDeclaration decl)

Specified by:

getMethodLocation in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

hasDefaultConstructor

public boolean hasDefaultConstructor(TypeDeclaration t)

Description copied from interface: Navigator

Returns true if the given class has a no-arg default constructor. The constructor does not need to be public.

Specified by:

hasDefaultConstructor in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isStaticField

public boolean isStaticField(FieldDeclaration f)

Description copied from interface: Navigator

Returns true if the field is static.

Specified by:

isStaticField in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isPublicMethod

public boolean isPublicMethod(MethodDeclaration m)

Description copied from interface: Navigator

Returns true if the method is public.

Specified by:

isPublicMethod in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isPublicField

public boolean isPublicField(FieldDeclaration f)

Description copied from interface: Navigator

Returns true if the field is public.

Specified by:

isPublicField in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>

isEnum

public boolean isEnum(TypeDeclaration t)

Description copied from interface: Navigator

Returns true if this is an enum class.

Specified by:

isEnum in interface Navigator<TypeMirror,TypeDeclaration,FieldDeclaration,MethodDeclaration>