com.helger.jaxb.builder

Class JAXBDocumentType

java.lang.Object

com.helger.jaxb.builder.JAXBDocumentType

All Implemented Interfaces:

IJAXBDocumentType

@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

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAXB_DEFAULT

Constructor Summary

Constructors

Constructor and Description
JAXBDocumentType(Class<?> aClass, List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs, Function<? super String,? extends String> aTypeToElementNameMapper) Constructor
JAXBDocumentType(Class<?> aClass, List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs, String sNamespaceURI, String sLocalName) Simple constructor when you know what you are doing.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource>	getAllXSDResources()
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Schema	getSchema()
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

getValidator, getValidator, validateXML

Field Detail

JAXB_DEFAULT

public static final String JAXB_DEFAULT

See Also:

Constant Field Values

Constructor Detail

JAXBDocumentType

public JAXBDocumentType(@Nonnull
                        Class<?> aClass,
                        @Nullable
                        List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs,
                        @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!

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

JAXBDocumentType

public JAXBDocumentType(@Nonnull
                        Class<?> aClass,
                        @Nullable
                        List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs,
                        @Nullable
                        String sNamespaceURI,
                        @Nonnull @Nonempty
                        String sLocalName)

Simple constructor when you know what you are doing.

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!

aXSDs - 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!

sNamespaceURI - The namespace URI to use. May be null.

sLocalName - The locale name of the element. May neither be null nor empty.

Since:

9.4.0

Method Detail

getImplementationClass

@Nonnull
public Class<?> getImplementationClass()

Specified by:

getImplementationClass in interface IJAXBDocumentType

Returns:

The class implementing this document type. Never null.

getAllXSDResources

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource> getAllXSDResources()

Specified by:

getAllXSDResources 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).

getSchema

@Nullable
public Schema getSchema()

Specified by:

getSchema in interface IJAXBDocumentType

Returns:

The compiled Schema object.

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