org.openhubframework.openhub.common.jaxb

Class JaxbDataFormatHelper

java.lang.Object

org.openhubframework.openhub.common.jaxb.JaxbDataFormatHelper

public class JaxbDataFormatHelper
extends Object

Helper class for creating Camel JaxbDataFormat used for marshalling and unmarshalling.

Constructor Summary

Constructors

Constructor and Description
JaxbDataFormatHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.camel.model.dataformat.JaxbDataFormat	jaxb(Class<?> xmlClass) Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation.
static org.apache.camel.model.dataformat.JaxbDataFormat	jaxb(Class<?> xmlClass, QName rootQName) Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation.
static org.apache.camel.model.dataformat.JaxbDataFormat	jaxbFragment(Class<?> xmlClass) Creates a JAXB data format for unmarshalling (only) the specified class to/from its native XML representation.
static org.apache.camel.model.dataformat.JaxbDataFormat	jaxbFragment(Class<?> xmlClass, String partNamespace) Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxbDataFormatHelper

public JaxbDataFormatHelper()

Method Detail

jaxb

public static org.apache.camel.model.dataformat.JaxbDataFormat jaxb(Class<?> xmlClass)

Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation.

Parameters:

xmlClass - the class that this data format will be able to marshal and unmarshal

Returns:

the Camel DataFormatDefinition instance for use in routes

jaxb

public static org.apache.camel.model.dataformat.JaxbDataFormat jaxb(Class<?> xmlClass,
                                                    @Nullable
                                                    QName rootQName)

Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation.

If rootQName is provided, this data format will work with classes that are not root elements (not annotated with XmlRootElement).

Parameters:

xmlClass - the class that this data format will be able to marshal and unmarshal

rootQName - the QName (optional) of the root element in XML, which is necessary for marshalling classes without XmlRootElement to XML

Returns:

the Camel DataFormatDefinition instance for use in routes

jaxbFragment

public static org.apache.camel.model.dataformat.JaxbDataFormat jaxbFragment(Class<?> xmlClass)

Creates a JAXB data format for unmarshalling (only) the specified class to/from its native XML representation. Unlike data format returned by jaxb(Class), this data format works with classes that are not root elements (e.g., not annotated with XmlRootElement).

Parameters:

xmlClass - the class that this data format will be able to marshal and unmarshal

Returns:

the Camel DataFormatDefinition instance for use in routes

See Also:

for marshalling fragments (as this one can only unmarshal)

jaxbFragment

public static org.apache.camel.model.dataformat.JaxbDataFormat jaxbFragment(Class<?> xmlClass,
                                                            String partNamespace)

Creates a JAXB data format for marshalling and unmarshalling the specified class to/from its native XML representation. Unlike data format returned by jaxb(Class), this data format works with classes that are not root elements (e.g., not annotated with XmlRootElement).

Parameters:

xmlClass - the class that this data format will be able to marshal and unmarshal

partNamespace - the namespace (optional) with the name of the root element (name in XML, not its Java class name), which is necessary for marshalling the class to XML

Returns:

the Camel DataFormatDefinition instance for use in routes