JAXB OSGI 4.0.9 · org.glassfish.jaxb.core.v2.model.nav.ReflectionNavigator

Modifier and Type	Class and Description
private static class	ReflectionNavigator.BinderArg

Modifier and Type	Field and Description
private static final TypeVisitor<Type, Class<?>>	baseClassFinder
private static final TypeVisitor<Type, ReflectionNavigator.BinderArg>	binder
private static final TypeVisitor<Class<T>, Void>	eraser Implements the logic for `erasure(Type)`.
private static final ReflectionNavigator	INSTANCE

Access	Constructor and Description
private	ReflectionNavigator()

Method Summary

Modifier and Type	Method and Description
public Class<?>	asDecl(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. If the given type is an use of class declaration, returns the type casted as `C`.
public Class<?>	asDecl(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl, org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. Gets the `C` representation for the given class.
public Type	createParameterizedType(Class<?> rawType, Type... arguments) Returns the `Type` object that represents `clazz<T1,T2,T3>`.
public <T> Class<T>	erasure(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.erasure. Returns the runtime representation of the given type.
private Type	fix(Type t) JDK 5.0 has a bug of creating `GenericArrayType` where it shouldn't.
public Type	getBaseClass(Type t, Class<?> sup) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getBaseClass. Gets the parameterization of the given base type.
public Location	getClassLocation(final Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getClassLocation. Returns a location of the specified class.
public String	getClassName(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getClassName. Gets the fully-qualified name of the class.
public String	getClassShortName(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getClassShortName. Gets the short name of the class ("Object" for `Object`.) For nested classes, this method should just return the inner name.
public Type	getComponentType(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getComponentType. Gets the component type of the array.
public Field	getDeclaredField(final Class<?> clazz, final String fieldName) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getDeclaredField. Gets the named field declared on the given class.
public Collection<? extends Field>	getDeclaredFields(final Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getDeclaredFields. Gets all the declared fields of the given class.
public Collection<? extends Method>	getDeclaredMethods(final Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getDeclaredMethods. 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.
public Class<?>	getDeclaringClassForField(Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getDeclaringClassForField. Gets the class that declares the given field.
public Class<?>	getDeclaringClassForMethod(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getDeclaringClassForMethod. Gets the class that declares the given method.
public Field[]	getEnumConstants(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getEnumConstants. Gets the enumeration constants from an enum class.
public Location	getFieldLocation(final Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getFieldLocation.
public String	getFieldName(Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getFieldName. Gets the name of the field.
public Type	getFieldType(Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getFieldType. Gets the type of the field.
pack-priv static ReflectionNavigator	getInstance()
public Location	getMethodLocation(final Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getMethodLocation.
public String	getMethodName(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getMethodName. Gets the name of the method, such as "toString" or "equals".
public Type[]	getMethodParameters(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getMethodParameters. Returns the list of parameters to the method.
public String	getPackageName(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getPackageName. Gets the package name of the given class.
public Type	getPrimitive(Class<?> primitiveType) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getPrimitive. Returns the representation for the given primitive type.
public Type	getReturnType(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getReturnType. Gets the return type of a method.
public Class<?>	getSuperClass(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getSuperClass. Gets the base class of the specified class.
public Type	getTypeArgument(Type type, int i) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getTypeArgument. Gets the i-th type argument from a parameterized type.
public String	getTypeName(Type type) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getTypeName. Gets the display name of the type object
public Type	getVoidType() Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getVoidType. Gets the representation of the primitive "void" type.
public boolean	hasDefaultConstructor(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.hasDefaultConstructor. Returns true if the given class has a no-arg default constructor.
public boolean	isAbstract(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isAbstract. Returns true if this is an abstract class.
public boolean	isArray(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isArray. Checks if the type is an array type.
public boolean	isArrayButNotByteArray(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isArrayButNotByteArray. Checks if the type is an array type but not byte[].
public boolean	isBridgeMethod(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isBridgeMethod. Returns true if this method is a bridge method as defined in JLS.
public boolean	isEnum(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isEnum. Returns true if this is an enum class.
public boolean	isFinal(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isFinal. Returns true if this is a final class.
public boolean	isFinalMethod(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isFinalMethod. Returns true if the method is final.
public boolean	isInnerClass(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isInnerClass. Returns true if the given class is an inner class.
public boolean	isInterface(Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isInterface. Returns true if 'clazz' is an interface.
public boolean	isOverriding(Method method, final Class<?> base) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isOverriding. Returns true if the given method is overriding another one defined in the base class 'base' or its ancestors.
public boolean	isParameterizedType(Type type) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isParameterizedType. Returns true if t is a parameterized type.
public boolean	isPrimitive(Type type) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isPrimitive. Checks if the given type is a primitive type.
public boolean	isPublicField(Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isPublicField. Returns true if the field is public.
public boolean	isPublicMethod(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isPublicMethod. Returns true if the method is public.
public boolean	isSameType(Type t1, Type t2) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isSameType. Checks if types are the same
public boolean	isStaticField(Field field) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isStaticField. Returns true if the field is static.
public boolean	isStaticMethod(Method method) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isStaticMethod. Returns true if the method is static.
public boolean	isSubClassOf(Type sub, Type sup) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isSubClassOf. Checks if `sub` is a sub-type of `sup`.
public boolean	isTransient(Field f) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.isTransient. Returns true if the field is transient.
public Class<?>	loadObjectFactory(Class<?> referencePoint, String pkg) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.loadObjectFactory. Finds ObjectFactory for the given referencePoint.
public Class<?>	ref(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.ref. Gets the representation of the given Java type in `T`.
public Class<?>	use(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.use. Gets the T for the given C.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

baseClassFinder	back to summary
private static final TypeVisitor<Type, Class<?>> baseClassFinder

binder	back to summary
private static final TypeVisitor<Type, ReflectionNavigator.BinderArg> binder

eraser	back to summary
private static final TypeVisitor<Class<T>, Void> eraser Implements the logic for `erasure(Type)`.

INSTANCE	back to summary
private static final ReflectionNavigator INSTANCE

ReflectionNavigator	back to summary
private ReflectionNavigator()

Method Detail

asDecl back to summary

asDecl	back to summary
public Class<?> asDecl(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. If the given type is an use of class declaration, returns the type casted as `C`. Otherwise null. Todo define the exact semantics. Annotations @Override

public Class<?> asDecl(Type t)

Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl.

Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl.

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

Todo

define the exact semantics.

Annotations

@Override

asDecl back to summary

asDecl	back to summary
public Class<?> asDecl(Class<?> c) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl, org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl. 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. Annotations @Override

public Class<?> asDecl(Class<?> c)

Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl, org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl.

Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.asDecl.

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.

Annotations

@Override

createParameterizedType	back to summary
public Type createParameterizedType(Class<?> rawType, Type... arguments) Returns the `Type` object that represents `clazz<T1,T2,T3>`.

erasure back to summary

erasure	back to summary
public <T> Class<T> erasure(Type t) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.erasure. Returns the runtime representation of the given type. This corresponds to the notion of the erasure in JSR-14. Because of the difference in the way Annotation Processing and the Java reflection treats primitive type and array type, we can't define this method on `Navigator`. It made me realize how difficult it is to define the common navigation layer for two different underlying reflection library. The other way is to throw away the entire parameterization and go to the wrapper approach. Annotations @Override

public <T> Class<T> erasure(Type t)

Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.erasure.

Returns the runtime representation of the given type. This corresponds to the notion of the erasure in JSR-14.

Because of the difference in the way Annotation Processing and the Java reflection treats primitive type and array type, we can't define this method on Navigator.

It made me realize how difficult it is to define the common navigation layer for two different underlying reflection library. The other way is to throw away the entire parameterization and go to the wrapper approach.

Annotations

@Override

fix	back to summary
private Type fix(Type t) JDK 5.0 has a bug of creating `GenericArrayType` where it shouldn't. fix that manually to work around the problem. See bug 6202725.

getBaseClass back to summary

getBaseClass	back to summary
public Type getBaseClass(Type t, Class<?> sup) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getBaseClass. Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.getBaseClass. 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>` Annotations @Override

public Type getBaseClass(Type t, Class<?> sup)

Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getBaseClass.

Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.getBaseClass.

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>

Annotations

@Override

getClassLocation	back to summary
public Location getClassLocation(final Class<?> clazz) Implements org.glassfish.jaxb.core.v2.model.nav.Navigator.getClassLocation. Doc from org.glassfish.jaxb.core.v2.model.nav.Navigator.getClassLocation. Returns a location of the specified class. Annotations @Override

getClassLocation

pack-priv final Class ReflectionNavigator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReflectionNavigator.BinderArg

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail