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

java.lang.Object
- com.sun.tools.xjc.model.nav.NavigatorImpl

All Implemented Interfaces:

Navigator<NType,NClass,Void,Void>
```
public final class NavigatorImpl
extends Object
implements Navigator<NType,NClass,Void,Void>
```
Navigator implementation for XJC. Most of the Navigator methods are used for parsing the model, which doesn't happen in XJC. So Most of the methods aren't really implemented. Implementations should be filled in as needed.

Author:

Kohsuke Kawaguchi

Field Summary

Fields
Modifier and Type Field and Description

static NavigatorImpl theInstance

Fields
Modifier and Type	Field and Description
`static NavigatorImpl`	`theInstance`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`NClass`	`asDecl(Class c)` Gets the `C` representation for the given class.
`NClass`	`asDecl(NType nt)` If the given type is an use of class declaration, returns the type casted as `C`.
`static NClass`	`create(Class c)`
`static NType`	`create(Type t)`
`static NType`	`createParameterizedType(Class rawType, NType... args)`
`static NType`	`createParameterizedType(NClass rawType, NType... args)` Creates a `NType` representation for a parameterized type `RawType<ParamType1,ParamType2,...>` .
`<T> NType`	`erasure(NType type)` Computes the erasure
`NType`	`getBaseClass(NType nt, NClass base)` Gets the parameterization of the given base type.
`Location`	`getClassLocation(NClass c)` Returns a location of the specified class.
`String`	`getClassName(NClass nClass)` Gets the fully-qualified name of the class.
`String`	`getClassShortName(NClass nClass)` Gets the short name of the class ("Object" for `Object`.) For nested classes, this method should just return the inner name.
`NType`	`getComponentType(NType nType)` Gets the component type of the array.
`Void`	`getDeclaredField(NClass clazz, String fieldName)` Gets the named field declared on the given class.
`Collection<? extends Void>`	`getDeclaredFields(NClass nClass)` Gets all the declared fields of the given class.
`Collection<? extends Void>`	`getDeclaredMethods(NClass nClass)` Gets all the declared methods of the given class (regardless of their access modifiers, regardless of whether they override methods of the base classes.)
`NClass`	`getDeclaringClassForField(Void aVoid)` Gets the class that declares the given field.
`NClass`	`getDeclaringClassForMethod(Void aVoid)` Gets the class that declares the given method.
`Void[]`	`getEnumConstants(NClass clazz)` Gets the enumeration constants from an enum class.
`Location`	`getFieldLocation(Void v)`
`String`	`getFieldName(Void aVoid)` Gets the name of the field.
`NType`	`getFieldType(Void aVoid)` Gets the type of the field.
`Location`	`getMethodLocation(Void v)`
`String`	`getMethodName(Void aVoid)` Gets the name of the method, such as "toString" or "equals".
`NType[]`	`getMethodParameters(Void aVoid)` Returns the list of parameters to the method.
`String`	`getPackageName(NClass clazz)` Gets the package name of the given class.
`NType`	`getPrimitive(Class primitiveType)` Returns the representation for the given primitive type.
`NType`	`getReturnType(Void aVoid)` Gets the return type of a method.
`NClass`	`getSuperClass(NClass nClass)` Gets the base class of the specified class.
`NType`	`getTypeArgument(NType nt, int i)` Gets the i-th type argument from a parameterized type.
`String`	`getTypeName(NType type)` Gets the display name of the type object
`NType`	`getVoidType()` Gets the representation of the primitive "void" type.
`boolean`	`hasDefaultConstructor(NClass nClass)` Returns true if the given class has a no-arg default constructor.
`boolean`	`isAbstract(NClass clazz)` Returns true if this is an abstract class.
`boolean`	`isArray(NType nType)` Checks if the type is an array type.
`boolean`	`isArrayButNotByteArray(NType t)` Checks if the type is an array type but not byte[].
`boolean`	`isBridgeMethod(Void method)` Returns true if this method is a bridge method as defined in JLS.
`boolean`	`isEnum(NClass c)` Returns true if this is an enum class.
`boolean`	`isFinal(NClass clazz)` Deprecated. no class generated by XJC is final.
`boolean`	`isFinalMethod(Void aVoid)` Returns true if the method is final.
`boolean`	`isInnerClass(NClass clazz)` Returns true if the given class is an inner class.
`boolean`	`isInterface(NClass clazz)` Returns true if 'clazz' is an interface.
`boolean`	`isOverriding(Void method, NClass clazz)` Returns true if the given method is overriding another one defined in the base class 'base' or its ancestors.
`boolean`	`isParameterizedType(NType nt)` Returns true if t is a parameterized type.
`boolean`	`isPrimitive(NType type)` Checks if the given type is a primitive type.
`boolean`	`isPublicField(Void aVoid)` Returns true if the field is public.
`boolean`	`isPublicMethod(Void aVoid)` Returns true if the method is public.
`boolean`	`isSameType(NType t1, NType t2)` Checks if types are the same
`boolean`	`isStaticField(Void aVoid)` Returns true if the field is static.
`boolean`	`isStaticMethod(Void aVoid)` Returns true if the method is static.
`boolean`	`isSubClassOf(NType sub, NType sup)` Checks if `sub` is a sub-type of `sup`.
`boolean`	`isTransient(Void f)` Returns true if the field is transient.
`NClass`	`loadObjectFactory(NClass referencePoint, String pkg)` Finds ObjectFactory for the given referencePoint.
`NClass`	`ref(Class c)` Gets the representation of the given Java type in `T`.
`NClass`	`ref(JClass c)`
`NType`	`use(NClass nc)` 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

- Field Detail
  - theInstance
```
public static final NavigatorImpl theInstance
```
- Method Detail
  - getSuperClass
```
public NClass getSuperClass(NClass nClass)
```
    Description copied from interface: Navigator
    
    Gets the base class of the specified class.
    
    Specified by:
    
    getSuperClass in interface Navigator<NType,NClass,Void,Void>
    
    Returns:
    
    null if the parameter represents Object.
  - getBaseClass
```
public NType getBaseClass(NType nt,
                          NClass base)
```
    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<NType,NClass,Void,Void>
    
    Parameters:
    
    nt - The type that derives from baseType
    
    base - 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(NClass nClass)
```
    Description copied from interface: Navigator
    
    Gets the fully-qualified name of the class. ("java.lang.Object" for Object)
    
    Specified by:
    
    getClassName in interface Navigator<NType,NClass,Void,Void>
  - getTypeName
```
public String getTypeName(NType type)
```
    Description copied from interface: Navigator
    
    Gets the display name of the type object
    
    Specified by:
    
    getTypeName in interface Navigator<NType,NClass,Void,Void>
    
    Returns:
    
    a human-readable name that the type represents.
  - getClassShortName
```
public String getClassShortName(NClass nClass)
```
    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<NType,NClass,Void,Void>
  - getDeclaredFields
```
public Collection<? extends Void> getDeclaredFields(NClass nClass)
```
    Description copied from interface: Navigator
    
    Gets all the declared fields of the given class.
    
    Specified by:
    
    getDeclaredFields in interface Navigator<NType,NClass,Void,Void>
  - getDeclaredField
```
public Void getDeclaredField(NClass 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<NType,NClass,Void,Void>
    
    Returns:
    
    null if not found
  - getDeclaredMethods
```
public Collection<? extends Void> getDeclaredMethods(NClass nClass)
```
    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<NType,NClass,Void,Void>
    
    Returns:
    
    can be empty but always non-null.
  - getDeclaringClassForField
```
public NClass getDeclaringClassForField(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the class that declares the given field.
    
    Specified by:
    
    getDeclaringClassForField in interface Navigator<NType,NClass,Void,Void>
  - getDeclaringClassForMethod
```
public NClass getDeclaringClassForMethod(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the class that declares the given method.
    
    Specified by:
    
    getDeclaringClassForMethod in interface Navigator<NType,NClass,Void,Void>
  - getFieldType
```
public NType getFieldType(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the type of the field.
    
    Specified by:
    
    getFieldType in interface Navigator<NType,NClass,Void,Void>
  - getFieldName
```
public String getFieldName(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the name of the field.
    
    Specified by:
    
    getFieldName in interface Navigator<NType,NClass,Void,Void>
  - getMethodName
```
public String getMethodName(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the name of the method, such as "toString" or "equals".
    
    Specified by:
    
    getMethodName in interface Navigator<NType,NClass,Void,Void>
  - getReturnType
```
public NType getReturnType(Void aVoid)
```
    Description copied from interface: Navigator
    
    Gets the return type of a method.
    
    Specified by:
    
    getReturnType in interface Navigator<NType,NClass,Void,Void>
  - getMethodParameters
```
public NType[] getMethodParameters(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns the list of parameters to the method.
    
    Specified by:
    
    getMethodParameters in interface Navigator<NType,NClass,Void,Void>
  - isStaticMethod
```
public boolean isStaticMethod(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns true if the method is static.
    
    Specified by:
    
    isStaticMethod in interface Navigator<NType,NClass,Void,Void>
  - isFinalMethod
```
public boolean isFinalMethod(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns true if the method is final.
    
    Specified by:
    
    isFinalMethod in interface Navigator<NType,NClass,Void,Void>
  - isSubClassOf
```
public boolean isSubClassOf(NType sub,
                            NType 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<NType,NClass,Void,Void>
  - ref
```
public NClass ref(Class c)
```
    Description copied from interface: Navigator
    
    Gets the representation of the given Java type in T.
    
    Specified by:
    
    ref in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    c - can be a primitive, array, class, or anything. (therefore the return type has to be T, not C)
  - ref
```
public NClass ref(JClass c)
```
  - use
```
public NType use(NClass nc)
```
    Description copied from interface: Navigator
    
    Gets the T for the given C.
    
    Specified by:
    
    use in interface Navigator<NType,NClass,Void,Void>
  - asDecl
```
public NClass asDecl(NType nt)
```
    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<NType,NClass,Void,Void>
  - asDecl
```
public NClass 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<NType,NClass,Void,Void>
  - isArray
```
public boolean isArray(NType nType)
```
    Description copied from interface: Navigator
    
    Checks if the type is an array type.
    
    Specified by:
    
    isArray in interface Navigator<NType,NClass,Void,Void>
  - isArrayButNotByteArray
```
public boolean isArrayButNotByteArray(NType t)
```
    Description copied from interface: Navigator
    
    Checks if the type is an array type but not byte[].
    
    Specified by:
    
    isArrayButNotByteArray in interface Navigator<NType,NClass,Void,Void>
  - getComponentType
```
public NType getComponentType(NType nType)
```
    Description copied from interface: Navigator
    
    Gets the component type of the array.
    
    Specified by:
    
    getComponentType in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    nType - must be an array.
  - getTypeArgument
```
public NType getTypeArgument(NType nt,
                             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<NType,NClass,Void,Void>
    
    See Also:
    
    Navigator.isParameterizedType(Object)
  - isParameterizedType
```
public boolean isParameterizedType(NType nt)
```
    Description copied from interface: Navigator
    
    Returns true if t is a parameterized type.
    
    Specified by:
    
    isParameterizedType in interface Navigator<NType,NClass,Void,Void>
  - isPrimitive
```
public boolean isPrimitive(NType type)
```
    Description copied from interface: Navigator
    
    Checks if the given type is a primitive type.
    
    Specified by:
    
    isPrimitive in interface Navigator<NType,NClass,Void,Void>
  - getPrimitive
```
public NType getPrimitive(Class primitiveType)
```
    Description copied from interface: Navigator
    
    Returns the representation for the given primitive type.
    
    Specified by:
    
    getPrimitive in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    primitiveType - must be Class objects like Integer.TYPE.
  - create
```
public static final NType create(Type t)
```
  - create
```
public static NClass create(Class c)
```
  - createParameterizedType
```
public static NType createParameterizedType(NClass rawType,
                                            NType... args)
```
    Creates a NType representation for a parameterized type RawType<ParamType1,ParamType2,...> .
  - createParameterizedType
```
public static NType createParameterizedType(Class rawType,
                                            NType... args)
```
  - getClassLocation
```
public Location getClassLocation(NClass c)
```
    Description copied from interface: Navigator
    
    Returns a location of the specified class.
    
    Specified by:
    
    getClassLocation in interface Navigator<NType,NClass,Void,Void>
  - getFieldLocation
```
public Location getFieldLocation(Void v)
```
    Specified by:
    
    getFieldLocation in interface Navigator<NType,NClass,Void,Void>
  - getMethodLocation
```
public Location getMethodLocation(Void v)
```
    Specified by:
    
    getMethodLocation in interface Navigator<NType,NClass,Void,Void>
  - hasDefaultConstructor
```
public boolean hasDefaultConstructor(NClass nClass)
```
    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<NType,NClass,Void,Void>
  - isStaticField
```
public boolean isStaticField(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns true if the field is static.
    
    Specified by:
    
    isStaticField in interface Navigator<NType,NClass,Void,Void>
  - isPublicMethod
```
public boolean isPublicMethod(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns true if the method is public.
    
    Specified by:
    
    isPublicMethod in interface Navigator<NType,NClass,Void,Void>
  - isPublicField
```
public boolean isPublicField(Void aVoid)
```
    Description copied from interface: Navigator
    
    Returns true if the field is public.
    
    Specified by:
    
    isPublicField in interface Navigator<NType,NClass,Void,Void>
  - isEnum
```
public boolean isEnum(NClass c)
```
    Description copied from interface: Navigator
    
    Returns true if this is an enum class.
    
    Specified by:
    
    isEnum in interface Navigator<NType,NClass,Void,Void>
  - erasure
```
public <T> NType erasure(NType type)
```
    Description copied from interface: Navigator
    
    Computes the erasure
    
    Specified by:
    
    erasure in interface Navigator<NType,NClass,Void,Void>
  - isAbstract
```
public boolean isAbstract(NClass clazz)
```
    Description copied from interface: Navigator
    
    Returns true if this is an abstract class.
    
    Specified by:
    
    isAbstract in interface Navigator<NType,NClass,Void,Void>
  - isFinal
```
public boolean isFinal(NClass clazz)
```
    Deprecated. no class generated by XJC is final.
    
    Description copied from interface: Navigator
    
    Returns true if this is a final class.
    
    Specified by:
    
    isFinal in interface Navigator<NType,NClass,Void,Void>
  - getEnumConstants
```
public Void[] getEnumConstants(NClass clazz)
```
    Description copied from interface: Navigator
    
    Gets the enumeration constants from an enum class.
    
    Specified by:
    
    getEnumConstants in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    clazz - must derive from Enum.
    
    Returns:
    
    can be empty but never null.
  - getVoidType
```
public NType getVoidType()
```
    Description copied from interface: Navigator
    
    Gets the representation of the primitive "void" type.
    
    Specified by:
    
    getVoidType in interface Navigator<NType,NClass,Void,Void>
  - getPackageName
```
public String getPackageName(NClass clazz)
```
    Description copied from interface: Navigator
    
    Gets the package name of the given class.
    
    Specified by:
    
    getPackageName in interface Navigator<NType,NClass,Void,Void>
    
    Returns:
    
    i.e. "", "java.lang" but not null.
  - loadObjectFactory
```
public NClass loadObjectFactory(NClass referencePoint,
                                String pkg)
```
    Description copied from interface: Navigator
    
    Finds ObjectFactory for the given referencePoint.
    
    Specified by:
    
    loadObjectFactory in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    referencePoint - The class that refers to the specified class.
    
    Returns:
    
    null if not found.
  - isBridgeMethod
```
public boolean isBridgeMethod(Void 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<NType,NClass,Void,Void>
  - isOverriding
```
public boolean isOverriding(Void method,
                            NClass clazz)
```
    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<NType,NClass,Void,Void>
  - isInterface
```
public boolean isInterface(NClass clazz)
```
    Description copied from interface: Navigator
    
    Returns true if 'clazz' is an interface.
    
    Specified by:
    
    isInterface in interface Navigator<NType,NClass,Void,Void>
  - isTransient
```
public boolean isTransient(Void f)
```
    Description copied from interface: Navigator
    
    Returns true if the field is transient.
    
    Specified by:
    
    isTransient in interface Navigator<NType,NClass,Void,Void>
  - isInnerClass
```
public boolean isInnerClass(NClass 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<NType,NClass,Void,Void>
  - isSameType
```
public boolean isSameType(NType t1,
                          NType t2)
```
    Description copied from interface: Navigator
    
    Checks if types are the same
    
    Specified by:
    
    isSameType in interface Navigator<NType,NClass,Void,Void>
    
    Parameters:
    
    t1 - type
    
    t2 - type
    
    Returns:
    
    true if types are the same

Class NavigatorImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

theInstance

Method Detail

getSuperClass

getBaseClass

getClassName

getTypeName

getClassShortName

getDeclaredFields

getDeclaredField

getDeclaredMethods

getDeclaringClassForField

getDeclaringClassForMethod

getFieldType

getFieldName

getMethodName

getReturnType

getMethodParameters

isStaticMethod

isFinalMethod

isSubClassOf

ref

ref

use

asDecl

asDecl

isArray

isArrayButNotByteArray

getComponentType

getTypeArgument

isParameterizedType

isPrimitive

getPrimitive

create

create

createParameterizedType

createParameterizedType

getClassLocation

getFieldLocation

getMethodLocation

hasDefaultConstructor

isStaticField

isPublicMethod

isPublicField

isEnum

erasure

isAbstract

isFinal

getEnumConstants

getVoidType

getPackageName

loadObjectFactory

isBridgeMethod

isOverriding

isInterface

isTransient

isInnerClass

isSameType