ApNavigator (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

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 (kk@kohsuke.org)

Constructor Summary

Constructors
Constructor and Description

ApNavigator(ProcessingEnvironment env)

Constructors
Constructor and Description
`ApNavigator(ProcessingEnvironment env)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypeElement`	`asDecl(Class c)` Gets the `C` representation for the given class.
`TypeElement`	`asDecl(TypeMirror m)` If the given type is an use of class declaration, returns the type casted as `C`.
`TypeMirror`	`erasure(TypeMirror t)` Computes the erasure
`TypeMirror`	`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" for `Object`.) 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 object
`TypeMirror`	`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 same
`boolean`	`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 if `sub` is a sub-type of `sup`.
`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 in `T`.
`TypeMirror`	`use(TypeElement 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
  - 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 interface Navigator<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
```
 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,TypeElement,VariableElement,ExecutableElement>
    
    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 String getClassName(TypeElement 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,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 interface Navigator<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" 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,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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
  - 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,TypeElement,VariableElement,ExecutableElement>
  - ref
```
public TypeMirror ref(Class c)
```
    Description copied from interface: Navigator
    
    Gets the representation of the given Java type in T.
    
    Specified by:
    
    ref in interface Navigator<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 interface Navigator<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 as C. Otherwise null.
    TODO: define the exact semantics.
    
    Specified by:
    
    asDecl in interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
  - asDecl
```
public TypeElement asDecl(Class c)
```
    Description copied from interface: Navigator
    
    Gets the C 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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
  - erasure
```
public TypeMirror erasure(TypeMirror t)
```
    Description copied from interface: Navigator
    
    Computes the erasure
    
    Specified by:
    
    erasure in interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
    
    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,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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
    
    Parameters:
    
    t1 - type
    
    t2 - 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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
    
    Parameters:
    
    primitiveType - must be Class objects like Integer.TYPE.
  - getClassLocation
```
public Location getClassLocation(TypeElement typeElement)
```
    Description copied from interface: Navigator
    
    Returns a location of the specified class.
    
    Specified by:
    
    getClassLocation in interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
  - getFieldLocation
```
public Location getFieldLocation(VariableElement variableElement)
```
    Specified by:
    
    getFieldLocation in interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>
  - getMethodLocation
```
public Location getMethodLocation(ExecutableElement executableElement)
```
    Specified by:
    
    getMethodLocation in interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<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 interface Navigator<TypeMirror,TypeElement,VariableElement,ExecutableElement>

Class ApNavigator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApNavigator

Method Detail

getSuperClass

getBaseClass

getClassName

getTypeName

getClassShortName

getDeclaredFields

getDeclaredField

getDeclaredMethods

getDeclaringClassForField

getDeclaringClassForMethod

getFieldType

getFieldName

getMethodName

getReturnType

getMethodParameters

isStaticMethod

isFinalMethod

isSubClassOf

ref

use

asDecl

asDecl

erasure

isAbstract

isFinal

getEnumConstants

getVoidType

getPackageName

loadObjectFactory

isBridgeMethod

isOverriding

isInterface

isTransient

isInnerClass

isSameType

isArray

isArrayButNotByteArray

getComponentType

getTypeArgument

isParameterizedType

isPrimitive

getPrimitive

getClassLocation

getFieldLocation

getMethodLocation

hasDefaultConstructor

isStaticField

isPublicMethod

isPublicField

isEnum