com.helger.ubl

Class UBL21Marshaller

java.lang.Object

com.helger.ubl.UBL21Marshaller

@Immutable
public final class UBL21Marshaller
extends Object

This is the marshaller for UBL documents.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	readUBLDocument(Node aNode, Class<T> aDestClass) Convert the passed XML node into a domain object.
static <T> T	readUBLDocument(Node aNode, Class<T> aDestClass, ValidationEventHandler aCustomEventHandler) Convert the passed XML node into a domain object.
static <T> T	readUBLDocument(Source aSource, Class<T> aDestClass) Convert the passed XML node into a domain object.
static <T> T	readUBLDocument(Source aSource, Class<T> aDestClass, ValidationEventHandler aCustomEventHandler) Convert the passed XML node into a domain object.
static com.helger.commons.error.IResourceErrorGroup	validateUBLObject(Object aUBLDocument, EUBL21DocumentType eDocType) Validate the passed domain object against the XML Schema rules.
static Document	writeUBLDocument(Object aUBLDocument, EUBL21DocumentType eDocType) Convert the passed domain object into an XML node.
static com.helger.commons.state.ESuccess	writeUBLDocument(Object aUBLDocument, EUBL21DocumentType eDocType, Result aResult) Convert the passed domain object into an XML node.
static Document	writeUBLDocument(Object aUBLDocument, EUBL21DocumentType eDocType, ValidationEventHandler aCustomEventHandler) Convert the passed domain object into an XML node.
static com.helger.commons.state.ESuccess	writeUBLDocument(Object aUBLDocument, EUBL21DocumentType eDocType, ValidationEventHandler aCustomEventHandler, Result aResult) Convert the passed domain object into an XML node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readUBLDocument

@Nullable
public static <T> T readUBLDocument(@Nonnull
                             Node aNode,
                             @Nonnull
                             Class<T> aDestClass)

Convert the passed XML node into a domain object.
Note: this is the generic API for reading all types of UBL documents. Please refer to UBL21DocumentMarshaller for a type-safe API for all supported document types.

Parameters:

aNode - The XML node to be converted. May not be null.

aDestClass - The UBL class of the result type. May not be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

readUBLDocument

@Nullable
public static <T> T readUBLDocument(@Nonnull
                             Node aNode,
                             @Nonnull
                             Class<T> aDestClass,
                             @Nullable
                             ValidationEventHandler aCustomEventHandler)

Convert the passed XML node into a domain object.
Note: this is the generic API for reading all types of UBL documents. Please refer to UBL21Reader for a type-safe API for all supported document types.

Parameters:

aNode - The XML node to be converted. May not be null.

aDestClass - The UBL class of the result type. May not be null.

aCustomEventHandler - An optional custom event handler to be used in unmarshalling. May be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

readUBLDocument

@Nullable
public static <T> T readUBLDocument(@Nonnull
                             Source aSource,
                             @Nonnull
                             Class<T> aDestClass)

Convert the passed XML node into a domain object.
Note: this is the generic API for reading all types of UBL documents. Please refer to UBL21Reader for a type-safe API for all supported document types.

Parameters:

aSource - The source object to be converted. May not be null.

aDestClass - The UBL class of the result type. May not be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

readUBLDocument

@Nullable
public static <T> T readUBLDocument(@Nonnull
                             Source aSource,
                             @Nonnull
                             Class<T> aDestClass,
                             @Nullable
                             ValidationEventHandler aCustomEventHandler)

Convert the passed XML node into a domain object.
Note: this is the generic API for reading all types of UBL documents. Please refer to UBL21Reader for a type-safe API for all supported document types.

Parameters:

aSource - The source object to be converted. May not be null.

aDestClass - The UBL class of the result type. May not be null.

aCustomEventHandler - An optional custom event handler to be used in unmarshalling. May be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

writeUBLDocument

@Nullable
public static Document writeUBLDocument(@Nonnull
                                 Object aUBLDocument,
                                 @Nonnull
                                 EUBL21DocumentType eDocType)

Convert the passed domain object into an XML node.
Note: this is the generic API for writing all types of UBL documents. Please refer to UBL21Writer for a type-safe API for all supported document types.

Parameters:

aUBLDocument - The domain object to be converted. May not be null.

eDocType - The UBL document type matching the document. May not be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

writeUBLDocument

@Nullable
public static Document writeUBLDocument(@Nonnull
                                 Object aUBLDocument,
                                 @Nonnull
                                 EUBL21DocumentType eDocType,
                                 @Nullable
                                 ValidationEventHandler aCustomEventHandler)

Convert the passed domain object into an XML node.
Note: this is the generic API for writing all types of UBL documents. Please refer to UBL21Writer for a type-safe API for all supported document types.

Parameters:

aUBLDocument - The domain object to be converted. May not be null.

eDocType - The UBL document type matching the document. May not be null.

aCustomEventHandler - An optional custom event handler to be used in marshalling. May be null.

Returns:

null in case conversion to the specified class failed. See the log output for details.

writeUBLDocument

@Nonnull
public static com.helger.commons.state.ESuccess writeUBLDocument(@Nonnull
                                                         Object aUBLDocument,
                                                         @Nonnull
                                                         EUBL21DocumentType eDocType,
                                                         @Nonnull
                                                         Result aResult)

Convert the passed domain object into an XML node.
Note: this is the generic API for writing all types of UBL documents. Please refer to UBL21Writer for a type-safe API for all supported document types.

Parameters:

aUBLDocument - The domain object to be converted. May not be null.

eDocType - The UBL document type matching the document. May not be null.

aResult - the result object to write the marshaled document to. May not be null.

Returns:

ESuccess.FAILURE in case conversion to the specified class failed.

writeUBLDocument

@Nonnull
public static com.helger.commons.state.ESuccess writeUBLDocument(@Nonnull
                                                         Object aUBLDocument,
                                                         @Nonnull
                                                         EUBL21DocumentType eDocType,
                                                         @Nullable
                                                         ValidationEventHandler aCustomEventHandler,
                                                         @Nonnull
                                                         Result aResult)

Convert the passed domain object into an XML node.
Note: this is the generic API for writing all types of UBL documents. Please refer to UBL21Writer for a type-safe API for all supported document types.

Parameters:

aUBLDocument - The domain object to be converted. May not be null.

eDocType - The UBL document type matching the document. May not be null.

aCustomEventHandler - An optional custom event handler to be used in marshalling. May be null.

aResult - the result object to write the marshaled document to. May not be null.

Returns:

ESuccess.FAILURE in case conversion to the specified class failed.

validateUBLObject

@Nonnull
public static com.helger.commons.error.IResourceErrorGroup validateUBLObject(@Nonnull
                                                                     Object aUBLDocument,
                                                                     @Nonnull
                                                                     EUBL21DocumentType eDocType)

Validate the passed domain object against the XML Schema rules.
Note: this is the generic API for validating all types of UBL documents. Please refer to UBL21Validator for a type-safe API for all supported document types.

Parameters:

aUBLDocument - The domain object to be converted. May not be null.

eDocType - The UBL document type matching the document. May not be null.

Returns:

Never null.