com.helger.jaxb.JAXBMarshallerHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-jaxb Show documentation
Show all versions of ph-jaxb Show documentation
Special Java 1.8+ Library with extended JAXB support
/**
* Copyright (C) 2014-2015 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.jaxb;
import java.nio.charset.Charset;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.xml.bind.Marshaller;
import javax.xml.bind.PropertyException;
import javax.xml.namespace.NamespaceContext;
/**
* This class contains utility methods for JAXB {@link Marshaller} objects. It
* allows for setting type-safe properties.
*
* @author Philip Helger
*/
@Immutable
public final class JAXBMarshallerHelper
{
private static final String JAXB_EXTERNAL_CLASS_NAME = "com.sun.xml.bind.v2.runtime.MarshallerImpl";
private static final String JAXB_INTERNAL_CLASS_NAME = "com.sun.xml.internal.bind.v2.runtime.MarshallerImpl";
// Sun specific property name (ripped from
// com.sun.xml.bind.v2.runtime.MarshallerImpl)
private static final String SUN_INDENT_STRING = "com.sun.xml.bind.indentString";
private static final String SUN_PREFIX_MAPPER = "com.sun.xml.bind.namespacePrefixMapper";
private static final String SUN_ENCODING_HANDLER2 = "com.sun.xml.bind.marshaller.CharacterEscapeHandler";
private static final String SUN_XML_HEADERS = "com.sun.xml.bind.xmlHeaders";
private static final String SUN_C14N = "com.sun.xml.bind.c14n";
private static final String SUN_OBJECT_IDENTITY_CYCLE_DETECTION = "com.sun.xml.bind.objectIdentitityCycleDetection";
private static final String SUN_INDENT_STRING_INTERNAL = "com.sun.xml.internal.bind.indentString";
private static final String SUN_PREFIX_MAPPER_INTERNAL = "com.sun.xml.bind.namespacePrefixMapper";
private static final String SUN_ENCODING_HANDLER2_INTERNAL = "com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler";
private static final String SUN_XML_HEADERS_INTERNAL = "com.sun.xml.internal.bind.xmlHeaders";
private static final String SUN_C14N_INTERNAL = "com.sun.xml.internal.bind.c14n";
private static final String SUN_OBJECT_IDENTITY_CYCLE_DETECTION_INTERNAL = "com.sun.xml.internal.bind.objectIdentitityCycleDetection";
private JAXBMarshallerHelper ()
{}
private static void _setProperty (@Nonnull final Marshaller aMarshaller,
@Nonnull final String sPropertyName,
@Nullable final Object aValue) throws IllegalArgumentException
{
try
{
aMarshaller.setProperty (sPropertyName, aValue);
}
catch (final PropertyException ex)
{
throw new IllegalArgumentException ("Failed to set JAXB property '" + sPropertyName + "' to " + aValue, ex);
}
}
@Nullable
private static Object _getProperty (@Nonnull final Marshaller aMarshaller,
@Nonnull final String sPropertyName) throws IllegalArgumentException
{
try
{
return aMarshaller.getProperty (sPropertyName);
}
catch (final PropertyException ex)
{
throw new IllegalArgumentException ("Failed to get JAXB property '" + sPropertyName + "'", ex);
}
}
private static boolean _getBooleanProperty (@Nonnull final Marshaller aMarshaller,
@Nonnull final String sPropertyName) throws IllegalArgumentException
{
return ((Boolean) _getProperty (aMarshaller, sPropertyName)).booleanValue ();
}
@Nullable
private static String _getStringProperty (@Nonnull final Marshaller aMarshaller,
@Nonnull final String sPropertyName) throws IllegalArgumentException
{
return (String) _getProperty (aMarshaller, sPropertyName);
}
/**
* Set the standard property for the encoding charset.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param aEncoding
* the value to be set
*/
public static void setEncoding (@Nonnull final Marshaller aMarshaller, @Nullable final Charset aEncoding)
{
setEncoding (aMarshaller, aEncoding == null ? null : aEncoding.name ());
}
/**
* Set the standard property for the encoding charset.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param sEncoding
* the value to be set
*/
public static void setEncoding (@Nonnull final Marshaller aMarshaller, @Nullable final String sEncoding)
{
_setProperty (aMarshaller, Marshaller.JAXB_ENCODING, sEncoding);
}
@Nullable
public static String getEncoding (@Nonnull final Marshaller aMarshaller)
{
return _getStringProperty (aMarshaller, Marshaller.JAXB_ENCODING);
}
/**
* Set the standard property for formatting the output or not.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param bFormattedOutput
* the value to be set
*/
public static void setFormattedOutput (@Nonnull final Marshaller aMarshaller, final boolean bFormattedOutput)
{
_setProperty (aMarshaller, Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.valueOf (bFormattedOutput));
}
public static boolean isFormattedOutput (@Nonnull final Marshaller aMarshaller)
{
return _getBooleanProperty (aMarshaller, Marshaller.JAXB_FORMATTED_OUTPUT);
}
/**
* Set the standard property for setting the namespace schema location
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param sSchemaLocation
* the value to be set
*/
public static void setSchemaLocation (@Nonnull final Marshaller aMarshaller, @Nullable final String sSchemaLocation)
{
_setProperty (aMarshaller, Marshaller.JAXB_SCHEMA_LOCATION, sSchemaLocation);
}
@Nullable
public static String getSchemaLocation (@Nonnull final Marshaller aMarshaller)
{
return _getStringProperty (aMarshaller, Marshaller.JAXB_SCHEMA_LOCATION);
}
/**
* Set the standard property for setting the no-namespace schema location
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param sSchemaLocation
* the value to be set
*/
public static void setNoNamespaceSchemaLocation (@Nonnull final Marshaller aMarshaller,
@Nullable final String sSchemaLocation)
{
_setProperty (aMarshaller, Marshaller.JAXB_NO_NAMESPACE_SCHEMA_LOCATION, sSchemaLocation);
}
@Nullable
public static String getNoNamespaceSchemaLocation (@Nonnull final Marshaller aMarshaller)
{
return _getStringProperty (aMarshaller, Marshaller.JAXB_NO_NAMESPACE_SCHEMA_LOCATION);
}
/**
* Set the standard property for marshalling a fragment only.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param bFragment
* the value to be set
*/
public static void setFragment (@Nonnull final Marshaller aMarshaller, final boolean bFragment)
{
_setProperty (aMarshaller, Marshaller.JAXB_FRAGMENT, Boolean.valueOf (bFragment));
}
public static boolean isFragment (@Nonnull final Marshaller aMarshaller)
{
return _getBooleanProperty (aMarshaller, Marshaller.JAXB_FRAGMENT);
}
/**
* Set the Sun specific property for the indent string.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param sIndentString
* the value to be set
*/
public static void setSunIndentString (@Nonnull final Marshaller aMarshaller, @Nullable final String sIndentString)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_INDENT_STRING_INTERNAL
: SUN_INDENT_STRING;
_setProperty (aMarshaller, sPropertyName, sIndentString);
}
@Nullable
public static String getSunIndentString (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_INDENT_STRING_INTERNAL
: SUN_INDENT_STRING;
return _getStringProperty (aMarshaller, sPropertyName);
}
/**
* Set the Sun specific encoding handler. Value must implement
* com.sun.xml.bind.marshaller.CharacterEscapeHandler
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param aCharacterEscapeHandler
* the value to be set
*/
public static void setSunCharacterEscapeHandler (@Nonnull final Marshaller aMarshaller,
@Nonnull final Object aCharacterEscapeHandler)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_ENCODING_HANDLER2_INTERNAL
: SUN_ENCODING_HANDLER2;
_setProperty (aMarshaller, sPropertyName, aCharacterEscapeHandler);
}
@Nullable
public static Object getSunCharacterEscapeHandler (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_ENCODING_HANDLER2_INTERNAL
: SUN_ENCODING_HANDLER2;
return _getProperty (aMarshaller, sPropertyName);
}
/**
* Set the Sun specific namespace prefix mapper based on a generic
* {@link NamespaceContext}. This method instantiates either
* {@link JAXBNamespacePrefixMapper} or
* {@link JAXBNamespacePrefixMapperOracleRT} depending whether it is an
* internal JAXB runtime or an external JAXB runtime.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param aNamespaceContext
* The namespace context to be used. May not be null.
* @see #isExternalSunJAXB2Marshaller(Marshaller)
* @see #isInternalSunJAXB2Marshaller(Marshaller)
* @throws IllegalArgumentException
*/
public static void setSunNamespacePrefixMapper (@Nonnull final Marshaller aMarshaller,
@Nonnull final NamespaceContext aNamespaceContext) throws IllegalArgumentException
{
Object aNamespacePrefixMapper;
if (isInternalSunJAXB2Marshaller (aMarshaller))
aNamespacePrefixMapper = new JAXBNamespacePrefixMapperOracleRT (aNamespaceContext);
else
aNamespacePrefixMapper = new JAXBNamespacePrefixMapper (aNamespaceContext);
setSunNamespacePrefixMapper (aMarshaller, 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.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param aNamespacePrefixMapper
* the value to be set
* @see #isExternalSunJAXB2Marshaller(Marshaller)
* @see #isInternalSunJAXB2Marshaller(Marshaller)
*/
public static void setSunNamespacePrefixMapper (@Nonnull final Marshaller aMarshaller,
@Nonnull final Object aNamespacePrefixMapper)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_PREFIX_MAPPER_INTERNAL
: SUN_PREFIX_MAPPER;
_setProperty (aMarshaller, sPropertyName, aNamespacePrefixMapper);
}
@Nullable
public static Object getSunNamespacePrefixMapper (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_PREFIX_MAPPER_INTERNAL
: SUN_PREFIX_MAPPER;
return _getProperty (aMarshaller, sPropertyName);
}
/**
* Set the Sun specific XML header string.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param sXMLHeaders
* the value to be set
*/
public static void setSunXMLHeaders (@Nonnull final Marshaller aMarshaller, @Nonnull final String sXMLHeaders)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_XML_HEADERS_INTERNAL
: SUN_XML_HEADERS;
_setProperty (aMarshaller, sPropertyName, sXMLHeaders);
}
@Nullable
public static String getSunXMLHeaders (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_XML_HEADERS_INTERNAL
: SUN_XML_HEADERS;
return _getStringProperty (aMarshaller, sPropertyName);
}
/**
* Set the Sun specific canonicalization property.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param bCanonicalize
* the value to be set
*/
public static void setSunCanonicalization (@Nonnull final Marshaller aMarshaller, final boolean bCanonicalize)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_C14N_INTERNAL : SUN_C14N;
_setProperty (aMarshaller, sPropertyName, Boolean.valueOf (bCanonicalize));
}
public static boolean isSunCanonicalization (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_C14N_INTERNAL : SUN_C14N;
return _getBooleanProperty (aMarshaller, sPropertyName);
}
/**
* Set the Sun specific canonicalization property.
*
* @param aMarshaller
* The marshaller to set the property. May not be null.
* @param bObjectIdentityCycleDetection
* the value to be set
*/
public static void setSunObjectIdentityCycleDetection (@Nonnull final Marshaller aMarshaller,
final boolean bObjectIdentityCycleDetection)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_OBJECT_IDENTITY_CYCLE_DETECTION_INTERNAL
: SUN_OBJECT_IDENTITY_CYCLE_DETECTION;
_setProperty (aMarshaller, sPropertyName, Boolean.valueOf (bObjectIdentityCycleDetection));
}
public static boolean isSunObjectIdentityCycleDetection (@Nonnull final Marshaller aMarshaller)
{
final String sPropertyName = isInternalSunJAXB2Marshaller (aMarshaller) ? SUN_OBJECT_IDENTITY_CYCLE_DETECTION_INTERNAL
: SUN_OBJECT_IDENTITY_CYCLE_DETECTION;
return _getBooleanProperty (aMarshaller, sPropertyName);
}
/**
* 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.
*
* @param aMarshaller
* The marshaller to be checked. May be null.
* @return true if the passed marshaller is not null
* and is of the Sun class.
*/
public static boolean isSunJAXB2Marshaller (@Nullable final Marshaller aMarshaller)
{
if (aMarshaller == null)
return false;
final String sClassName = aMarshaller.getClass ().getName ();
// When using jaxb-impl explicitly
return sClassName.equals (JAXB_EXTERNAL_CLASS_NAME) ||
// When using the JAXB version integrated in the runtime
sClassName.equals (JAXB_INTERNAL_CLASS_NAME);
}
/**
* Check if the passed marshaller is external to the one contained in the
* runtime.
*
* @param aMarshaller
* The marshaller to check. May be null.
* @return true if it is a JAXB marshaller from an external
* package (e.g. by having jaxb-impl in the dependencies)
*/
public static boolean isExternalSunJAXB2Marshaller (@Nullable final Marshaller aMarshaller)
{
return aMarshaller != null && aMarshaller.getClass ().getName ().equals (JAXB_EXTERNAL_CLASS_NAME);
}
/**
* Check if the passed marshaller is an internal one contained in the runtime.
*
* @param aMarshaller
* The marshaller to check. May be null.
* @return true if it is a JAXB marshaller from the runtime
* library package
*/
public static boolean isInternalSunJAXB2Marshaller (@Nullable final Marshaller aMarshaller)
{
return aMarshaller != null && aMarshaller.getClass ().getName ().equals (JAXB_INTERNAL_CLASS_NAME);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy