JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.model.impl.ModelBuilder

Field Summary

Modifier and Type	Field and Description
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.
private ErrorHandler	errorHandler
private boolean	hadError
public boolean	hasSwaRef Set to true if the model includes `XmlAttachmentRef`.
private boolean	linked
private static final Logger	logger
public final Navigator<T, C, F, M>	nav
private final ErrorHandler	proxyErrorHandler
public final AnnotationReader<T, C, F, M>	reader
pack-priv final Map<String, RegistryInfoImpl<T, C, F, M>>	registries Packages whose registries are already added.
private final Map<C, C>	subclassReplacements
pack-priv final TypeInfoSetImpl<T, C, F, M>	typeInfoSet `TypeInfo`s that are built will go into this set.
private final Map<QName, TypeInfo<T, C>>	typeNames Used to detect collisions among global type names.

Constructor Summary

Access	Constructor and Description
public	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 and Description
public RegistryInfo<T, C>	addRegistry(C registryClass, Locatable upstream) Visits a class with `XmlRegistry` and records all the element mappings in it.
private void	addToRegistry(C which package will be used clazz, Locatable location p) Adding package's ObjectFactory methods to registry
private void	addTypeName(NonElement<T, C> r) Checks the uniqueness of the type name.
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()
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.
public NonElement<T, C>	getClassInfo(C clazz, boolean searchForSuperClass, Locatable upstream) For limited cases where the caller needs to search for a super class.
public Navigator<T, C, F, M>	getNavigator() Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getNavigator.
private Class<T>[]	Returns: null - if it's not JAXBElement property, or it's not parametrized, and array of parametrized classes in other case getParametrizedTypes(PropertyInfo<T, C> property which parametrized types we will try to get p) Getting parametrized classes of `JAXBElement<...`
public AnnotationReader<T, C, F, M>	getReader() Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getReader.
public RegistryInfo<T, C>	Returns: null if no registry exists for the package. unlike other getXXX methods on this class, this method is side-effect free. getRegistry(String packageName) Gets a `RegistryInfo` for the given package.
public NonElement<T, C>	Returns: always non-null. 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.
public NonElement<T, C>	getTypeInfo(Ref<T, C> ref) This method is used to add a root reference to a model.
public boolean	isReplaced(C sc)
public TypeInfoSet<T, C, F, M>	Returns: fully built `TypeInfoSet` that represents the model, or null if there was an error. link() Called after all the classes are added to the type set to "link" them together.
public final void	reportError(IllegalAnnotationException e)
public void	setErrorHandler(ErrorHandler can be null. errorHandler) Sets the error handler that receives errors discovered during the model building.

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

Field Detail

defaultNsUri	back to summary
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 "".

defaultNsUri

back to summary

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 "".

errorHandler	back to summary
private ErrorHandler errorHandler See Also `setErrorHandler`

hadError	back to summary
private boolean hadError

hasSwaRef	back to summary
public boolean hasSwaRef Set to true if the model includes `XmlAttachmentRef`. JAX-WS needs to know this information.

linked	back to summary
private boolean linked

logger	back to summary
private static final Logger logger

nav	back to summary
public final Navigator<T, C, F, M> nav

nav

back to summary

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

proxyErrorHandler	back to summary
private final ErrorHandler proxyErrorHandler

reader	back to summary
public final AnnotationReader<T, C, F, M> reader

registries	back to summary
pack-priv final Map<String, RegistryInfoImpl<T, C, F, M>> registries Packages whose registries are already added.

subclassReplacements	back to summary
private final Map<C, C> subclassReplacements

typeInfoSet	back to summary
pack-priv final TypeInfoSetImpl<T, C, F, M> typeInfoSet `TypeInfo`s that are built will go into this set.

typeNames	back to summary
private final Map<QName, TypeInfo<T, C>> typeNames Used to detect collisions among global type names.

Constructor Detail

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

Method Detail

addRegistry	back to summary
public RegistryInfo<T, C> addRegistry(C registryClass, Locatable upstream) Visits a class with `XmlRegistry` and records all the element mappings in it.

addToRegistry	back to summary
private void addToRegistry(C clazz, Locatable p) Adding package's ObjectFactory methods to registry Parameters clazz:C which package will be used p:Locatable location

addToRegistry

back to summary

private void addToRegistry(C clazz, Locatable p)

Adding package's ObjectFactory methods to registry

Parameters

clazz:C: which package will be used
p:Locatable: location

addTypeName	back to summary
private void addTypeName(NonElement<T, C> r) Checks the uniqueness of the type name.

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

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

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

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

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

getClassInfo back to summary

getClassInfo	back to summary
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)

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	back to summary
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.

getNavigator	back to summary
public Navigator<T, C, F, M> getNavigator() Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getNavigator. Annotations @Override

getNavigator

back to summary

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

Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getNavigator.

Annotations

@Override

getParametrizedTypes back to summary

getParametrizedTypes	back to summary
private Class<T>[] getParametrizedTypes(PropertyInfo<T, C> p) Getting parametrized classes of `JAXBElement<...>` property Parameters p:PropertyInfo<T, C> property which parametrized types we will try to get Returns:Class<T>[] null - if it's not JAXBElement property, or it's not parametrized, and array of parametrized classes in other case

private Class<T>[] getParametrizedTypes(PropertyInfo<T, C> p)

Getting parametrized classes of JAXBElement<...> property

Parameters

p:PropertyInfo<T, C>: property which parametrized types we will try to get

Returns:Class<T>[]

null - if it's not JAXBElement property, or it's not parametrized, and array of parametrized classes in other case

getReader	back to summary
public AnnotationReader<T, C, F, M> getReader() Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getReader. Annotations @Override

getReader

back to summary

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

Implements org.glassfish.jaxb.core.v2.model.impl.ModelBuilderI.getReader.

Annotations

@Override

getRegistry back to summary

getRegistry	back to summary
public RegistryInfo<T, C> getRegistry(String packageName) Gets a `RegistryInfo` for the given package. Returns:RegistryInfo<T, C> null if no registry exists for the package. unlike other getXXX methods on this class, this method is side-effect free.

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

Gets a RegistryInfo for the given package.

Returns:RegistryInfo<T, C>: null if no registry exists for the package. unlike other getXXX methods on this class, this method is side-effect free.

getTypeInfo back to summary

getTypeInfo	back to summary
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:NonElement<T, C> always non-null.

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:NonElement<T, C>: always non-null.

getTypeInfo	back to summary
public NonElement<T, C> getTypeInfo(Ref<T, C> ref) This method is used to add a root reference to a model.

isReplaced	back to summary
public boolean isReplaced(C sc)

link back to summary

link	back to summary
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:TypeInfoSet<T, C, F, M> fully built `TypeInfoSet` that represents the model, or null if there was an error.

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:TypeInfoSet<T, C, F, M>: fully built TypeInfoSet that represents the model, or null if there was an error.

reportError	back to summary
public final void reportError(IllegalAnnotationException e)

setErrorHandler	back to summary
public void setErrorHandler(ErrorHandler errorHandler) Sets the error handler that receives errors discovered during the model building. Parameters errorHandler:ErrorHandler can be null.

setErrorHandler

back to summary

public void setErrorHandler(ErrorHandler errorHandler)

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

Parameters

errorHandler:ErrorHandler: can be null.

public Class ModelBuilder<T, C, F, M>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail