Module com.sun.xml.bind.osgi

Package org.glassfish.jaxb.runtime.v2.model.impl

Class ModelBuilder<T,C,F,M>

java.lang.Object

org.glassfish.jaxb.runtime.v2.model.impl.ModelBuilder<T,C,F,M>

All Implemented Interfaces:

ModelBuilderI<T,C,F,M>

Direct Known Subclasses:

RuntimeModelBuilder

public class ModelBuilder<T,C,F,M>
extends Object
implements ModelBuilderI<T,C,F,M>

Builds a TypeInfoSet (a set of JAXB properties) by using ElementInfoImpl and ClassInfoImpl. from annotated Java classes.

This class uses Navigator and AnnotationReader to work with arbitrary annotation source and arbitrary Java model. For this purpose this class is parameterized.

Author:

Kohsuke Kawaguchi ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
String	defaultNsUri	JAXB doesn't want to use namespaces unless we are told to, but WS-I BP conformace requires JAX-RPC to always use a non-empty namespace URI.
boolean	hasSwaRef	Set to true if the model includes XmlAttachmentRef.
Navigator<T,C,F,M>	nav
AnnotationReader<T,C,F,M>	reader

Constructor Summary

Constructors

Constructor	Description
ModelBuilder(AnnotationReader<T,C,F,M> reader, Navigator<T,C,F,M> navigator, Map<C,C> subclassReplacements, String defaultNamespaceRemap)

Method Summary

Modifier and Type	Method	Description
RegistryInfo<T,C>	addRegistry(C registryClass, Locatable upstream)	Visits a class with XmlRegistry and records all the element mappings in it.
protected ArrayInfo<T,C>	createArrayInfo(Locatable upstream, T arrayType)
protected ClassInfo<T,C>	createClassInfo(C clazz, Locatable upstream)
protected ElementInfo<T,C>	createElementInfo(RegistryInfo<T,C> registryInfo, M m)
protected EnumLeafInfo<T,C>	createEnumLeafInfo(C clazz, Locatable upstream)
protected TypeInfoSet<T,C,F,M>	createTypeInfoSet()
NonElement<T,C>	getClassInfo(C clazz, boolean searchForSuperClass, Locatable upstream)	For limited cases where the caller needs to search for a super class.
NonElement<T,C>	getClassInfo(C clazz, Locatable upstream)	Builds a JAXB ClassInfo model from a given class declaration and adds that to this model owner.
Navigator<T,C,F,M>	getNavigator()
AnnotationReader<T,C,F,M>	getReader()
RegistryInfo<T,C>	getRegistry(String packageName)	Gets a RegistryInfo for the given package.
NonElement<T,C>	getTypeInfo(Ref<T,C> ref)	This method is used to add a root reference to a model.
NonElement<T,C>	getTypeInfo(T t, Locatable upstream)	Have the builder recognize the type (if it hasn't done so yet), and returns a NonElement that represents it.
boolean	isReplaced(C sc)
TypeInfoSet<T,C,F,M>	link()	Called after all the classes are added to the type set to "link" them together.
void	reportError(IllegalAnnotationException e)
void	setErrorHandler(ErrorHandler errorHandler)	Sets the error handler that receives errors discovered during the model building.

Methods inherited from class java.lang.Object

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

Field Detail

reader

public final AnnotationReader<T,C,F,M> reader

nav

public final Navigator<T,C,F,M> nav

defaultNsUri

public final String defaultNsUri

JAXB doesn't want to use namespaces unless we are told to, but WS-I BP conformace requires JAX-RPC to always use a non-empty namespace URI. (see http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html#WSDLTYPES R2105)

To work around this issue, we allow the use of the empty namespaces to be replaced by a particular designated namespace URI.

This field keeps the value of that replacing namespace URI. When there's no replacement, this field is set to "".

hasSwaRef

public boolean hasSwaRef

Set to true if the model includes XmlAttachmentRef. JAX-WS needs to know this information.

Constructor Detail

ModelBuilder

public ModelBuilder(AnnotationReader<T,C,F,M> reader,
                    Navigator<T,C,F,M> navigator,
                    Map<C,C> subclassReplacements,
                    String defaultNamespaceRemap)

Method Detail

createTypeInfoSet

protected TypeInfoSet<T,C,F,M> createTypeInfoSet()

getClassInfo

public NonElement<T,C> getClassInfo(C clazz,
                                          Locatable upstream)

Builds a JAXB ClassInfo model from a given class declaration and adds that to this model owner.

Return type is either ClassInfo or LeafInfo (for types like String or Enum-derived ones)

getClassInfo

public NonElement<T,C> getClassInfo(C clazz,
                                          boolean searchForSuperClass,
                                          Locatable upstream)

For limited cases where the caller needs to search for a super class. This is necessary because we don't want subclassReplacements to kick in for the super class search, which will cause infinite recursion.

getTypeInfo

public NonElement<T,C> getTypeInfo(T t,
                                         Locatable upstream)

Have the builder recognize the type (if it hasn't done so yet), and returns a NonElement that represents it.

Returns:

always non-null.

getTypeInfo

public NonElement<T,C> getTypeInfo(Ref<T,C> ref)

This method is used to add a root reference to a model.

createEnumLeafInfo

protected EnumLeafInfo<T,C> createEnumLeafInfo(C clazz,
                                                     Locatable upstream)

createClassInfo

protected ClassInfo<T,C> createClassInfo(C clazz,
                                               Locatable upstream)

createElementInfo

protected ElementInfo<T,C> createElementInfo(RegistryInfo<T,C> registryInfo,
                                                   M m)
                                            throws IllegalAnnotationException

Throws:

IllegalAnnotationException

createArrayInfo

protected ArrayInfo<T,C> createArrayInfo(Locatable upstream,
                                               T arrayType)

addRegistry

public RegistryInfo<T,C> addRegistry(C registryClass,
                                           Locatable upstream)

Visits a class with XmlRegistry and records all the element mappings in it.

getRegistry

public RegistryInfo<T,C> getRegistry(String packageName)

Gets a RegistryInfo for the given package.

Returns:

null if no registry exists for the package. unlike other getXXX methods on this class, this method is side-effect free.

link

public TypeInfoSet<T,C,F,M> link()

Called after all the classes are added to the type set to "link" them together.

Don't expose implementation classes in the signature.

Returns:

fully built TypeInfoSet that represents the model, or null if there was an error.

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Sets the error handler that receives errors discovered during the model building.

Parameters:

errorHandler - can be null.

reportError

public final void reportError(IllegalAnnotationException e)

isReplaced

public boolean isReplaced(C sc)

getNavigator

public Navigator<T,C,F,M> getNavigator()

Specified by:

getNavigator in interface ModelBuilderI<T,C,F,M>

getReader

public AnnotationReader<T,C,F,M> getReader()

Specified by:

getReader in interface ModelBuilderI<T,C,F,M>