- java.lang.Object
-
- com.sun.tools.jxc.model.nav.ApNavigator
-
- All Implemented Interfaces:
Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
public final class ApNavigator extends Object implements Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
Navigator
implementation for annotation processing. TODO: check the spec on how generics are supposed to be handled- Author:
- Kohsuke Kawaguchi ([email protected])
-
-
Constructor Summary
Constructors Constructor Description ApNavigator(ProcessingEnvironment env)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TypeElement
asDecl(Class c)
Gets theC
representation for the given class.TypeElement
asDecl(TypeMirror m)
If the given type is an use of class declaration, returns the type casted asC
.TypeMirror
erasure(TypeMirror t)
Computes the erasureTypeMirror
getBaseClass(TypeMirror type, TypeElement sup)
Gets the parameterization of the given base type.Location
getClassLocation(TypeElement typeElement)
Returns a location of the specified class.String
getClassName(TypeElement t)
Gets the fully-qualified name of the class.String
getClassShortName(TypeElement t)
Gets the short name of the class ("Object" forObject
.) For nested classes, this method should just return the inner name.TypeMirror
getComponentType(TypeMirror t)
Gets the component type of the array.VariableElement
getDeclaredField(TypeElement clazz, String fieldName)
Gets the named field declared on the given class.Collection<VariableElement>
getDeclaredFields(TypeElement typeElement)
Gets all the declared fields of the given class.Collection<ExecutableElement>
getDeclaredMethods(TypeElement typeElement)
Gets all the declared methods of the given class (regardless of their access modifiers, regardless of whether they override methods of the base classes.)TypeElement
getDeclaringClassForField(VariableElement f)
Gets the class that declares the given field.TypeElement
getDeclaringClassForMethod(ExecutableElement m)
Gets the class that declares the given method.VariableElement[]
getEnumConstants(TypeElement clazz)
Gets the enumeration constants from an enum class.Location
getFieldLocation(VariableElement variableElement)
String
getFieldName(VariableElement f)
Gets the name of the field.TypeMirror
getFieldType(VariableElement f)
Gets the type of the field.Location
getMethodLocation(ExecutableElement executableElement)
String
getMethodName(ExecutableElement m)
Gets the name of the method, such as "toString" or "equals".TypeMirror[]
getMethodParameters(ExecutableElement m)
Returns the list of parameters to the method.String
getPackageName(TypeElement clazz)
Gets the package name of the given class.TypeMirror
getPrimitive(Class primitiveType)
Returns the representation for the given primitive type.TypeMirror
getReturnType(ExecutableElement m)
Gets the return type of a method.TypeElement
getSuperClass(TypeElement typeElement)
Gets the base class of the specified class.TypeMirror
getTypeArgument(TypeMirror typeMirror, int i)
Gets the i-th type argument from a parameterized type.String
getTypeName(TypeMirror typeMirror)
Gets the display name of the type objectTypeMirror
getVoidType()
Gets the representation of the primitive "void" type.boolean
hasDefaultConstructor(TypeElement t)
Returns true if the given class has a no-arg default constructor.boolean
isAbstract(TypeElement clazz)
Returns true if this is an abstract class.boolean
isArray(TypeMirror type)
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(ExecutableElement method)
Returns true if this method is a bridge method as defined in JLS.boolean
isEnum(TypeElement t)
Returns true if this is an enum class.boolean
isFinal(TypeElement clazz)
Returns true if this is a final class.boolean
isFinalMethod(ExecutableElement m)
Returns true if the method is final.boolean
isInnerClass(TypeElement clazz)
Returns true if the given class is an inner class.boolean
isInterface(TypeElement clazz)
Returns true if 'clazz' is an interface.boolean
isOverriding(ExecutableElement method, TypeElement base)
Returns true if the given method is overriding another one defined in the base class 'base' or its ancestors.boolean
isParameterizedType(TypeMirror typeMirror)
Returns true if t is a parameterized type.boolean
isPrimitive(TypeMirror t)
Checks if the given type is a primitive type.boolean
isPublicField(VariableElement f)
Returns true if the field is public.boolean
isPublicMethod(ExecutableElement m)
Returns true if the method is public.boolean
isSameType(TypeMirror t1, TypeMirror t2)
Checks if types are the sameboolean
isStaticField(VariableElement f)
Returns true if the field is static.boolean
isStaticMethod(ExecutableElement m)
Returns true if the method is static.boolean
isSubClassOf(TypeMirror sub, TypeMirror sup)
Checks ifsub
is a sub-type ofsup
.boolean
isTransient(VariableElement f)
Returns true if the field is transient.TypeElement
loadObjectFactory(TypeElement referencePoint, String packageName)
Finds ObjectFactory for the given referencePoint.TypeMirror
ref(Class c)
Gets the representation of the given Java type inT
.TypeMirror
use(TypeElement t)
Gets the T for the given C.
-
-
-
Constructor Detail
-
ApNavigator
public ApNavigator(ProcessingEnvironment env)
-
-
Method Detail
-
getSuperClass
public TypeElement getSuperClass(TypeElement typeElement)
Description copied from interface:Navigator
Gets the base class of the specified class.- Specified by:
getSuperClass
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Returns:
- null if the parameter represents
Object
.
-
getBaseClass
public TypeMirror getBaseClass(TypeMirror type, TypeElement sup)
Description copied from interface:Navigator
Gets the parameterization of the given base type.For example, given the following
This method works like this:interface Foo<T> extends List<List<T>> {} interface Bar extends Foo<String> {}
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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
type
- The type that derives frombaseType
sup
- The class whose parameterization we are interested in.- Returns:
- The use of
baseType
intype
. or null if the type is not assignable to the base type.
-
getClassName
public String getClassName(TypeElement t)
Description copied from interface:Navigator
Gets the fully-qualified name of the class. ("java.lang.Object" forObject
)- Specified by:
getClassName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getTypeName
public String getTypeName(TypeMirror typeMirror)
Description copied from interface:Navigator
Gets the display name of the type object- Specified by:
getTypeName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Returns:
- a human-readable name that the type represents.
-
getClassShortName
public String getClassShortName(TypeElement t)
Description copied from interface:Navigator
Gets the short name of the class ("Object" forObject
.) For nested classes, this method should just return the inner name. (for example "Inner" for "com.acme.Outer$Inner".- Specified by:
getClassShortName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getDeclaredFields
public Collection<VariableElement> getDeclaredFields(TypeElement typeElement)
Description copied from interface:Navigator
Gets all the declared fields of the given class.- Specified by:
getDeclaredFields
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getDeclaredField
public VariableElement getDeclaredField(TypeElement clazz, 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Returns:
- null if not found
-
getDeclaredMethods
public Collection<ExecutableElement> getDeclaredMethods(TypeElement typeElement)
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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Returns:
- can be empty but always non-null.
-
getDeclaringClassForField
public TypeElement getDeclaringClassForField(VariableElement f)
Description copied from interface:Navigator
Gets the class that declares the given field.- Specified by:
getDeclaringClassForField
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getDeclaringClassForMethod
public TypeElement getDeclaringClassForMethod(ExecutableElement m)
Description copied from interface:Navigator
Gets the class that declares the given method.- Specified by:
getDeclaringClassForMethod
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getFieldType
public TypeMirror getFieldType(VariableElement f)
Description copied from interface:Navigator
Gets the type of the field.- Specified by:
getFieldType
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getFieldName
public String getFieldName(VariableElement f)
Description copied from interface:Navigator
Gets the name of the field.- Specified by:
getFieldName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getMethodName
public String getMethodName(ExecutableElement m)
Description copied from interface:Navigator
Gets the name of the method, such as "toString" or "equals".- Specified by:
getMethodName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getReturnType
public TypeMirror getReturnType(ExecutableElement m)
Description copied from interface:Navigator
Gets the return type of a method.- Specified by:
getReturnType
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getMethodParameters
public TypeMirror[] getMethodParameters(ExecutableElement m)
Description copied from interface:Navigator
Returns the list of parameters to the method.- Specified by:
getMethodParameters
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isStaticMethod
public boolean isStaticMethod(ExecutableElement m)
Description copied from interface:Navigator
Returns true if the method is static.- Specified by:
isStaticMethod
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isFinalMethod
public boolean isFinalMethod(ExecutableElement m)
Description copied from interface:Navigator
Returns true if the method is final.- Specified by:
isFinalMethod
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isSubClassOf
public boolean isSubClassOf(TypeMirror sub, TypeMirror sup)
Description copied from interface:Navigator
Checks ifsub
is a sub-type ofsup
. TODO: should this method take T or C?- Specified by:
isSubClassOf
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
ref
public TypeMirror ref(Class c)
Description copied from interface:Navigator
Gets the representation of the given Java type inT
.- Specified by:
ref
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
c
- can be a primitive, array, class, or anything. (therefore the return type has to be T, not C)
-
use
public TypeMirror use(TypeElement t)
Description copied from interface:Navigator
Gets the T for the given C.- Specified by:
use
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
asDecl
public TypeElement asDecl(TypeMirror m)
Description copied from interface:Navigator
If the given type is an use of class declaration, returns the type casted asC
. Otherwise null.TODO: define the exact semantics.
- Specified by:
asDecl
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
asDecl
public TypeElement asDecl(Class c)
Description copied from interface:Navigator
Gets theC
representation for the given class. The behavior is undefined if the class object represents primitives, arrays, and other types that are not class declaration.- Specified by:
asDecl
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
erasure
public TypeMirror erasure(TypeMirror t)
Description copied from interface:Navigator
Computes the erasure- Specified by:
erasure
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isAbstract
public boolean isAbstract(TypeElement clazz)
Description copied from interface:Navigator
Returns true if this is an abstract class.- Specified by:
isAbstract
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isFinal
public boolean isFinal(TypeElement clazz)
Description copied from interface:Navigator
Returns true if this is a final class.- Specified by:
isFinal
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getEnumConstants
public VariableElement[] getEnumConstants(TypeElement clazz)
Description copied from interface:Navigator
Gets the enumeration constants from an enum class.- Specified by:
getEnumConstants
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
clazz
- must derive fromEnum
.- 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getPackageName
public String getPackageName(TypeElement clazz)
Description copied from interface:Navigator
Gets the package name of the given class.- Specified by:
getPackageName
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Returns:
- i.e. "", "java.lang" but not null.
-
loadObjectFactory
public TypeElement loadObjectFactory(TypeElement referencePoint, String packageName)
Description copied from interface:Navigator
Finds ObjectFactory for the given referencePoint.- Specified by:
loadObjectFactory
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
referencePoint
- The class that refers to the specified class.- Returns:
- null if not found.
-
isBridgeMethod
public boolean isBridgeMethod(ExecutableElement method)
Description copied from interface:Navigator
Returns true if this method is a bridge method as defined in JLS.- Specified by:
isBridgeMethod
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isOverriding
public boolean isOverriding(ExecutableElement method, TypeElement 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isInterface
public boolean isInterface(TypeElement clazz)
Description copied from interface:Navigator
Returns true if 'clazz' is an interface.- Specified by:
isInterface
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isTransient
public boolean isTransient(VariableElement f)
Description copied from interface:Navigator
Returns true if the field is transient.- Specified by:
isTransient
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isInnerClass
public boolean isInnerClass(TypeElement 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isSameType
public boolean isSameType(TypeMirror t1, TypeMirror t2)
Description copied from interface:Navigator
Checks if types are the same- Specified by:
isSameType
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
t1
- typet2
- type- Returns:
- true if types are the same
-
isArray
public boolean isArray(TypeMirror type)
Description copied from interface:Navigator
Checks if the type is an array type.- Specified by:
isArray
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getComponentType
public TypeMirror getComponentType(TypeMirror t)
Description copied from interface:Navigator
Gets the component type of the array.- Specified by:
getComponentType
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- See Also:
Navigator.isParameterizedType(Object)
-
isParameterizedType
public boolean isParameterizedType(TypeMirror typeMirror)
Description copied from interface:Navigator
Returns true if t is a parameterized type.- Specified by:
isParameterizedType
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isPrimitive
public boolean isPrimitive(TypeMirror t)
Description copied from interface:Navigator
Checks if the given type is a primitive type.- Specified by:
isPrimitive
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getPrimitive
public TypeMirror getPrimitive(Class primitiveType)
Description copied from interface:Navigator
Returns the representation for the given primitive type.- Specified by:
getPrimitive
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
- Parameters:
primitiveType
- must be Class objects likeInteger.TYPE
.
-
getClassLocation
public Location getClassLocation(TypeElement typeElement)
Description copied from interface:Navigator
Returns a location of the specified class.- Specified by:
getClassLocation
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getFieldLocation
public Location getFieldLocation(VariableElement variableElement)
- Specified by:
getFieldLocation
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
getMethodLocation
public Location getMethodLocation(ExecutableElement executableElement)
- Specified by:
getMethodLocation
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
hasDefaultConstructor
public boolean hasDefaultConstructor(TypeElement 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 interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isStaticField
public boolean isStaticField(VariableElement f)
Description copied from interface:Navigator
Returns true if the field is static.- Specified by:
isStaticField
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isPublicMethod
public boolean isPublicMethod(ExecutableElement m)
Description copied from interface:Navigator
Returns true if the method is public.- Specified by:
isPublicMethod
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isPublicField
public boolean isPublicField(VariableElement f)
Description copied from interface:Navigator
Returns true if the field is public.- Specified by:
isPublicField
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
isEnum
public boolean isEnum(TypeElement t)
Description copied from interface:Navigator
Returns true if this is an enum class.- Specified by:
isEnum
in interfaceNavigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
-
-