com.phloc.commons.jaxb

Class JAXBMarshallerUtils

java.lang.Object

com.phloc.commons.jaxb.JAXBMarshallerUtils

@Immutable
public final class JAXBMarshallerUtils
extends Object

This class contains utility methods for JAXB Marshaller objects. It allows for setting type-safe properties.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static String	getEncoding(Marshaller aMarshaller)
static String	getNoNamespaceSchemaLocation(Marshaller aMarshaller)
static String	getSchemaLocation(Marshaller aMarshaller)
static Object	getSunCharacterEscapeHandler(Marshaller aMarshaller)
static String	getSunIndentString(Marshaller aMarshaller)
static Object	getSunNamespacePrefixMapper(Marshaller aMarshaller)
static String	getSunXMLHeaders(Marshaller aMarshaller)
static boolean	isExternalSunJAXB2Marshaller(Marshaller aMarshaller) Check if the passed marshaller is external to the one contained in the runtime.
static boolean	isFormattedOutput(Marshaller aMarshaller)
static boolean	isFragment(Marshaller aMarshaller)
static boolean	isInternalSunJAXB2Marshaller(Marshaller aMarshaller) Check if the passed marshaller is an internal one contained in the runtime.
static boolean	isSunCanonicalization(Marshaller aMarshaller)
static boolean	isSunJAXB2Marshaller(Marshaller aMarshaller) Check if the passed Marshaller is a Sun JAXB v2 marshaller.
static boolean	isSunObjectIdentityCycleDetection(Marshaller aMarshaller)
static void	setEncoding(Marshaller aMarshaller, Charset aEncoding) Set the standard property for the encoding charset.
static void	setEncoding(Marshaller aMarshaller, String sEncoding) Set the standard property for the encoding charset.
static void	setFormattedOutput(Marshaller aMarshaller, boolean bFormattedOutput) Set the standard property for formatting the output or not.
static void	setFragment(Marshaller aMarshaller, boolean bFragment) Set the standard property for marshalling a fragment only.
static void	setNoNamespaceSchemaLocation(Marshaller aMarshaller, String sSchemaLocation) Set the standard property for setting the no-namespace schema location
static void	setSchemaLocation(Marshaller aMarshaller, String sSchemaLocation) Set the standard property for setting the namespace schema location
static void	setSunCanonicalization(Marshaller aMarshaller, boolean bCanonicalize) Set the Sun specific canonicalization property.
static void	setSunCharacterEscapeHandler(Marshaller aMarshaller, Object aCharacterEscapeHandler) Set the Sun specific encoding handler.
static void	setSunIndentString(Marshaller aMarshaller, String sIndentString) Set the Sun specific property for the indent string.
static void	setSunNamespacePrefixMapper(Marshaller aMarshaller, Object aNamespacePrefixMapper) Set the Sun specific namespace prefix mapper.
static void	setSunObjectIdentityCycleDetection(Marshaller aMarshaller, boolean bObjectIdentityCycleDetection) Set the Sun specific canonicalization property.
static void	setSunXMLHeaders(Marshaller aMarshaller, String sXMLHeaders) Set the Sun specific XML header string.

Methods inherited from class java.lang.Object

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

Method Detail

setEncoding

public static void setEncoding(@Nonnull
               Marshaller aMarshaller,
               @Nullable
               Charset aEncoding)

Set the standard property for the encoding charset.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

aEncoding - the value to be set

setEncoding

public static void setEncoding(@Nonnull
               Marshaller aMarshaller,
               @Nullable
               String sEncoding)

Set the standard property for the encoding charset.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

sEncoding - the value to be set

getEncoding

public static String getEncoding(@Nonnull
                 Marshaller aMarshaller)

setFormattedOutput

public static void setFormattedOutput(@Nonnull
                      Marshaller aMarshaller,
                      boolean bFormattedOutput)

Set the standard property for formatting the output or not.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

bFormattedOutput - the value to be set

isFormattedOutput

public static boolean isFormattedOutput(@Nonnull
                        Marshaller aMarshaller)

setSchemaLocation

public static void setSchemaLocation(@Nonnull
                     Marshaller aMarshaller,
                     @Nullable
                     String sSchemaLocation)

Set the standard property for setting the namespace schema location

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

sSchemaLocation - the value to be set

getSchemaLocation

public static String getSchemaLocation(@Nonnull
                       Marshaller aMarshaller)

setNoNamespaceSchemaLocation

public static void setNoNamespaceSchemaLocation(@Nonnull
                                Marshaller aMarshaller,
                                @Nullable
                                String sSchemaLocation)

Set the standard property for setting the no-namespace schema location

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

sSchemaLocation - the value to be set

getNoNamespaceSchemaLocation

public static String getNoNamespaceSchemaLocation(@Nonnull
                                  Marshaller aMarshaller)

setFragment

public static void setFragment(@Nonnull
               Marshaller aMarshaller,
               boolean bFragment)

Set the standard property for marshalling a fragment only.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

bFragment - the value to be set

isFragment

public static boolean isFragment(@Nonnull
                 Marshaller aMarshaller)

setSunIndentString

public static void setSunIndentString(@Nonnull
                      Marshaller aMarshaller,
                      @Nullable
                      String sIndentString)

Set the Sun specific property for the indent string.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

sIndentString - the value to be set

getSunIndentString

public static String getSunIndentString(@Nonnull
                        Marshaller aMarshaller)

setSunCharacterEscapeHandler

public static void setSunCharacterEscapeHandler(@Nonnull
                                Marshaller aMarshaller,
                                @Nonnull
                                Object aCharacterEscapeHandler)

Set the Sun specific encoding handler. Value must implement com.sun.xml.bind.marshaller.CharacterEscapeHandler

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

aCharacterEscapeHandler - the value to be set

getSunCharacterEscapeHandler

public static Object getSunCharacterEscapeHandler(@Nonnull
                                  Marshaller aMarshaller)

setSunNamespacePrefixMapper

public static void setSunNamespacePrefixMapper(@Nonnull
                               Marshaller aMarshaller,
                               @Nonnull
                               Object aNamespacePrefixMapper)

Set the Sun specific namespace prefix mapper. Value must implement either com.sun.xml.bind.marshaller.NamespacePrefixMapper or com.sun.xml.internal.bind.marshaller.NamespacePrefixMapper depending on the implementation type of Marshaller.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

aNamespacePrefixMapper - the value to be set

See Also:

isExternalSunJAXB2Marshaller(Marshaller), isInternalSunJAXB2Marshaller(Marshaller)

getSunNamespacePrefixMapper

public static Object getSunNamespacePrefixMapper(@Nonnull
                                 Marshaller aMarshaller)

setSunXMLHeaders

public static void setSunXMLHeaders(@Nonnull
                    Marshaller aMarshaller,
                    @Nonnull
                    String sXMLHeaders)

Set the Sun specific XML header string.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

sXMLHeaders - the value to be set

getSunXMLHeaders

public static String getSunXMLHeaders(@Nonnull
                      Marshaller aMarshaller)

setSunCanonicalization

public static void setSunCanonicalization(@Nonnull
                          Marshaller aMarshaller,
                          boolean bCanonicalize)

Set the Sun specific canonicalization property.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

bCanonicalize - the value to be set

isSunCanonicalization

public static boolean isSunCanonicalization(@Nonnull
                            Marshaller aMarshaller)

setSunObjectIdentityCycleDetection

public static void setSunObjectIdentityCycleDetection(@Nonnull
                                      Marshaller aMarshaller,
                                      boolean bObjectIdentityCycleDetection)

Set the Sun specific canonicalization property.

Parameters:

aMarshaller - The marshaller to set the property. May not be null.

bObjectIdentityCycleDetection - the value to be set

isSunObjectIdentityCycleDetection

public static boolean isSunObjectIdentityCycleDetection(@Nonnull
                                        Marshaller aMarshaller)

isSunJAXB2Marshaller

public static boolean isSunJAXB2Marshaller(@Nullable
                           Marshaller aMarshaller)

Check if the passed Marshaller is a Sun JAXB v2 marshaller. Use this method to determined, whether the Sun specific methods may be invoked or not.

Parameters:

aMarshaller - The marshaller to be checked. May be null.

Returns:

true if the passed marshaller is not null and is of the Sun class.

isExternalSunJAXB2Marshaller

public static boolean isExternalSunJAXB2Marshaller(@Nullable
                                   Marshaller aMarshaller)

Check if the passed marshaller is external to the one contained in the runtime.

Parameters:

aMarshaller - The marshaller to check. May be null.

Returns:

true if it is a JAXB marshaller from an external package (e.g. by having jaxb-impl in the dependencies)

isInternalSunJAXB2Marshaller

public static boolean isInternalSunJAXB2Marshaller(@Nullable
                                   Marshaller aMarshaller)

Check if the passed marshaller is an internal one contained in the runtime.

Parameters:

aMarshaller - The marshaller to check. May be null.

Returns:

true if it is a JAXB marshaller from the runtime library package