com.helger.jaxb.builder

Interface IJAXBDocumentType

All Known Implementing Classes:

JAXBDocumentType

@MustImplementEqualsAndHashcode
public interface IJAXBDocumentType

Base interface describing a single JAXB based document type, independent of the version and implementation.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource>	getAllXSDResources()
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Schema	getSchema()
default Validator	getValidator()
default Validator	getValidator(Locale aLocale)
default com.helger.commons.error.list.IErrorList	validateXML(com.helger.commons.io.resource.IReadableResource aXML) Validate the passed XML instance against the XML Schema of this document type using the default class loader.

Method Detail

getSchema

Schema getSchema()

Returns:

The compiled Schema object.

getImplementationClass

@Nonnull
Class<?> getImplementationClass()

Returns:

The class implementing this document type. Never null.

getAllXSDResources

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

Returns:

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

getNamespaceURI

@Nonnull
String getNamespaceURI()

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
String getLocalName()

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

getValidator

@Nullable
default Validator getValidator()

Returns:

The compiled Validator object retrieved from the schema to be obtained from getSchema().If this document type has no XML Schema that no Validator can be created and the return value is null.

getValidator

@Nullable
default Validator getValidator(@Nullable
                                          Locale aLocale)

Parameters:

aLocale - The locale to use for error message creation. May be null to use the system locale.

Returns:

The compiled Validator object retrieved from the schema to be obtained from getSchema(). If this document type has no XML Schema that no Validator can be created and the return value is null.

Since:

9.0.1

validateXML

@Nullable
default com.helger.commons.error.list.IErrorList validateXML(@Nonnull
                                                                        com.helger.commons.io.resource.IReadableResource aXML)

Validate the passed XML instance against the XML Schema of this document type using the default class loader.

Parameters:

aXML - The XML resource to be validated. May not be null.

Returns:

A group of validation errors. Is empty if no error occurred. null is returned if this document type has no XSDs assigned and therefore not validation can take place.