com.helger.jaxb.builder

Interface IJAXBDocumentType

All Superinterfaces:

com.helger.xml.schema.IHasSchema, Serializable

All Known Implementing Classes:

JAXBDocumentType

@MustImplementEqualsAndHashcode
public interface IJAXBDocumentType
extends com.helger.xml.schema.IHasSchema, Serializable

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<String>	getAllXSDPaths()
default com.helger.commons.collection.impl.ICommonsList<? extends com.helger.commons.io.resource.IReadableResource>	getAllXSDResources()
default com.helger.commons.collection.impl.ICommonsList<? extends com.helger.commons.io.resource.IReadableResource>	getAllXSDResources(ClassLoader aClassLoader)
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Schema	getSchema(ClassLoader aClassLoader)
default Validator	getValidator()
default Validator	getValidator(ClassLoader aClassLoader)
default Validator	getValidator(ClassLoader aClassLoader, 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.
default com.helger.commons.error.list.IErrorList	validateXML(com.helger.commons.io.resource.IReadableResource aXML, ClassLoader aClassLoader) Validate the passed XML instance against the XML Schema of this document type.

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

getSchema, getSchema

Method Detail

getImplementationClass

@Nonnull
Class<?> getImplementationClass()

Returns:

The class implementing this document type. Never null.

getAllXSDPaths

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

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

getAllXSDResources

@Nonnull
 @ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<? extends com.helger.commons.io.resource.IReadableResource> getAllXSDResources()

Returns:

The resources from which the XSD can be read using the current class loader. Never null but maybe empty.

getAllXSDResources

@Nonnull
 @ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<? extends com.helger.commons.io.resource.IReadableResource> getAllXSDResources(@Nullable
                                                                                                                                                                       ClassLoader aClassLoader)

Parameters:

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

Returns:

The resources from which the XSD can be read. Never null but maybe empty.

getSchema

@Nullable
Schema getSchema(@Nullable
                            ClassLoader aClassLoader)

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.

getValidator

@Nullable
default Validator getValidator()

Returns:

The compiled Validator object retrieved from the schema to be obtained from IHasSchema.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
                                          ClassLoader aClassLoader)

Parameters:

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

Returns:

The compiled Validator object retrieved from the schema to be obtained from getSchema(ClassLoader). 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
                                          ClassLoader aClassLoader,
                                          @Nullable
                                          Locale aLocale)

Parameters:

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

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

validateXML

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

Validate the passed XML instance against the XML Schema of this document type.

Parameters:

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

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

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.