com.helger.jaxb.builder

Class JAXBDocumentType

java.lang.Object

com.helger.jaxb.builder.JAXBDocumentType

All Implemented Interfaces:

IJAXBDocumentType, com.helger.xml.schema.IHasSchema, Serializable

@NotThreadSafe
public class JAXBDocumentType
extends Object
implements IJAXBDocumentType

Stand alone implementation of IJAXBDocumentType. It is not thread-safe because of the lazily loaded Schema.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JAXBDocumentType(Class<?> aClass, List<String> aXSDPaths, Function<? super String,? extends String> aTypeToElementNameMapper) Constructor

Method Summary

Modifier and Type	Method and Description
protected Schema	createSchema(ClassLoader aClassLoader) Create the schema.
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<String>	getAllXSDPaths()
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Schema	getSchema(ClassLoader aClassLoader)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.jaxb.builder.IJAXBDocumentType

getAllXSDResources, getAllXSDResources, getValidator, getValidator, getValidator, validateXML, validateXML

Methods inherited from interface com.helger.xml.schema.IHasSchema

getSchema, getSchema

Constructor Detail

JAXBDocumentType

public JAXBDocumentType(@Nonnull
                        Class<?> aClass,
                        @Nullable
                        List<String> aXSDPaths,
                        @Nullable
                        Function<? super String,? extends String> aTypeToElementNameMapper)

Constructor

Parameters:

aClass - The JAXB generated class of the root element. May not be null. This class must have the @XmlType annotation and the package the class resides in must have the @XmlSchema annotation with a non-null namespace property!

aXSDPaths - The classpath relative paths to the XML Schema. May not be null but maybe empty. If the main XSD imports another XSD, the imported XSD must come first in the list. So the XSDs without any dependencies must come first!

aTypeToElementNameMapper - An optional function to determine element name from type name. E.g. in UBL the type has an additional "Type" at the end that may not occur here. SBDH in contrary does not have such a suffix. May be null indicating that no name mapping is necessary.

Method Detail

getImplementationClass

@Nonnull
public Class<?> getImplementationClass()

Specified by:

getImplementationClass in interface IJAXBDocumentType

Returns:

The class implementing this document type. Never null.

getAllXSDPaths

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<String> getAllXSDPaths()

Specified by:

getAllXSDPaths in interface IJAXBDocumentType

Returns:

The list of all paths within the classpath where the main XSD file resides. Never null but maybe empty.

getNamespaceURI

@Nonnull
public String getNamespaceURI()

Specified by:

getNamespaceURI in interface IJAXBDocumentType

Returns:

The non-null XML namespace of this JAXB document type. If the element has no namespace this method must also return the empty string.

getLocalName

@Nonnull
 @Nonempty
public String getLocalName()

Specified by:

getLocalName in interface IJAXBDocumentType

Returns:

The local name of the root element of an XML document of this type. Corresponds to the name of the implementation class (without a package).

createSchema

@Nonnull
protected Schema createSchema(@Nullable
                                        ClassLoader aClassLoader)

Create the schema. Overload this method to create the schema differently. The result of this call may be cached.

Parameters:

aClassLoader - Optional class loader to use. May be null.

Returns:

A non-null Schema instance.

getSchema

@Nullable
public Schema getSchema(@Nullable
                                   ClassLoader aClassLoader)

Specified by:

getSchema in interface IJAXBDocumentType

Specified by:

getSchema in interface com.helger.xml.schema.IHasSchema

Parameters:

aClassLoader - The class loader to be used. May be null indicating that the default class loader should be used.

Returns:

The compiled Schema object retrieved by the XMLSchemaCache. May be null if no XSD was provided.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object