Package org.dellroad.stuff.jibx

Class JibxMarshaller

java.lang.Object

org.springframework.oxm.support.AbstractMarshaller

org.dellroad.stuff.jibx.JibxMarshaller

All Implemented Interfaces:

InitializingBean, Marshaller, Unmarshaller

public class JibxMarshaller
extends AbstractMarshaller
implements InitializingBean

Implementation of the Marshaller and Unmarshaller interfaces for JiBX.

The typical usage will be to set the targetClass and optionally the bindingName property on this bean. NOTE: This is copied from Spring commit 3c8724ba3d0375e4a50354c15383972fee788e9c which is the one that removed this class from Spring.

Author:

Arjen Poutsma

See Also:

• IMarshallingContext
• IUnmarshallingContext

Field Summary

Fields inherited from class org.springframework.oxm.support.AbstractMarshaller

logger

Constructor Summary

Constructors

Constructor	Description
JibxMarshaller()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
XmlMappingException	convertJibxException(JiBXException ex, boolean marshalling)	Convert the given JiBXException to an appropriate exception from the org.springframework.oxm hierarchy.
protected IMarshallingContext	createMarshallingContext()	Create a new IMarshallingContext, configured with the correct indentation.
protected IUnmarshallingContext	createUnmarshallingContext()	Create a new IUnmarshallingContext.
protected String	getDefaultEncoding()
protected void	marshalDomNode(Object graph, Node node)
protected void	marshalOutputStream(Object graph, OutputStream outputStream)
protected void	marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
protected void	marshalWriter(Object graph, Writer writer)
protected void	marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter)
protected void	marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter)
void	setBindingName(String bindingName)	Set the optional binding name for this instance.
void	setDocTypeInternalSubset(String docTypeInternalSubset)	Set the internal subset Id for the DTD declaration written when marshalling.
void	setDocTypePublicId(String docTypePublicId)	Set the public id for the DTD declaration written when marshalling.
void	setDocTypeRootElementName(String docTypeRootElementName)	Set the root element name for the DTD declaration written when marshalling.
void	setDocTypeSystemId(String docTypeSystemId)	Set the system id for the DTD declaration written when marshalling.
void	setEncoding(String encoding)	Set the document encoding using for marshalling.
void	setIndent(int indent)	Set the number of nesting indent spaces.
void	setStandalone(Boolean standalone)	Set the document standalone flag for marshalling.
void	setTargetClass(Class<?> targetClass)	Set the target class for this instance.
void	setTargetPackage(String targetPackage)	Set the target package for this instance.
boolean	supports(Class<?> clazz)
protected Object	unmarshalDomNode(Node node)
protected Object	unmarshalInputStream(InputStream inputStream)
protected Object	unmarshalReader(Reader reader)
protected Object	unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
protected Object	unmarshalXmlEventReader(XMLEventReader eventReader)
protected Object	unmarshalXmlStreamReader(XMLStreamReader streamReader)

Methods inherited from class org.springframework.oxm.support.AbstractMarshaller

buildDocument, createDocumentBuilder, createDocumentBuilderFactory, createXmlReader, isProcessExternalEntities, isSupportDtd, marshal, marshalDomResult, marshalSaxResult, marshalStaxResult, marshalStreamResult, setProcessExternalEntities, setSupportDtd, unmarshal, unmarshalDomSource, unmarshalSaxSource, unmarshalStaxSource, unmarshalStreamSource

Methods inherited from class java.lang.Object

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

Constructor Details

JibxMarshaller

public JibxMarshaller()

Method Details

setTargetClass

public void setTargetClass(Class<?> targetClass)

Set the target class for this instance. Setting either this property or the targetPackage property is required.

If this property is set, targetPackage is ignored.

setTargetPackage

public void setTargetPackage(String targetPackage)

Set the target package for this instance. Setting either this property or the targetClass property is required.

If targetClass is set, this property is ignored.

setBindingName

public void setBindingName(String bindingName)

Set the optional binding name for this instance.

setIndent

public void setIndent(int indent)

Set the number of nesting indent spaces. Default is -1, i.e. no indentation.

setEncoding

public void setEncoding(String encoding)

Set the document encoding using for marshalling. Default is UTF-8.

getDefaultEncoding

protected String getDefaultEncoding()

Overrides:

getDefaultEncoding in class AbstractMarshaller

setStandalone

public void setStandalone(Boolean standalone)

Set the document standalone flag for marshalling. By default, this flag is not present.

setDocTypeRootElementName

public void setDocTypeRootElementName(String docTypeRootElementName)

Set the root element name for the DTD declaration written when marshalling. By default, this is null (i.e. no DTD declaration is written).

If set to a value, the system ID or public ID also need to be set.

See Also:

• setDocTypeSystemId(String)
• setDocTypePublicId(String)

setDocTypeSystemId

public void setDocTypeSystemId(String docTypeSystemId)

Set the system id for the DTD declaration written when marshalling. By default, this is null. Only used when the root element also has been set.

Set either this property or docTypePublicId, not both.

See Also:

• setDocTypeRootElementName(String)

setDocTypePublicId

public void setDocTypePublicId(String docTypePublicId)

Set the public id for the DTD declaration written when marshalling. By default, this is null. Only used when the root element also has been set.

Set either this property or docTypeSystemId, not both.

See Also:

• setDocTypeRootElementName(String)

setDocTypeInternalSubset

public void setDocTypeInternalSubset(String docTypeInternalSubset)

Set the internal subset Id for the DTD declaration written when marshalling. By default, this is null. Only used when the root element also has been set.

See Also:

• setDocTypeRootElementName(String)

afterPropertiesSet

public void afterPropertiesSet()
                        throws JiBXException

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

JiBXException

supports

public boolean supports(Class<?> clazz)

Specified by:

supports in interface Marshaller

Specified by:

supports in interface Unmarshaller

marshalOutputStream

protected void marshalOutputStream(Object graph,
 OutputStream outputStream)
                            throws XmlMappingException,
IOException

Specified by:

marshalOutputStream in class AbstractMarshaller

Throws:

XmlMappingException

IOException

marshalWriter

protected void marshalWriter(Object graph,
 Writer writer)
                      throws XmlMappingException,
IOException

Specified by:

marshalWriter in class AbstractMarshaller

Throws:

XmlMappingException

IOException

marshalDomNode

protected void marshalDomNode(Object graph,
 Node node)
                       throws XmlMappingException

Specified by:

marshalDomNode in class AbstractMarshaller

Throws:

XmlMappingException

marshalXmlEventWriter

protected void marshalXmlEventWriter(Object graph,
 XMLEventWriter eventWriter)

Specified by:

marshalXmlEventWriter in class AbstractMarshaller

marshalXmlStreamWriter

protected void marshalXmlStreamWriter(Object graph,
 XMLStreamWriter streamWriter)
                               throws XmlMappingException

Specified by:

marshalXmlStreamWriter in class AbstractMarshaller

Throws:

XmlMappingException

marshalSaxHandlers

protected void marshalSaxHandlers(Object graph,
 ContentHandler contentHandler,
 @Nullable
 LexicalHandler lexicalHandler)
                           throws XmlMappingException

Specified by:

marshalSaxHandlers in class AbstractMarshaller

Throws:

XmlMappingException

unmarshalXmlEventReader

protected Object unmarshalXmlEventReader(XMLEventReader eventReader)

Specified by:

unmarshalXmlEventReader in class AbstractMarshaller

unmarshalXmlStreamReader

protected Object unmarshalXmlStreamReader(XMLStreamReader streamReader)

Specified by:

unmarshalXmlStreamReader in class AbstractMarshaller

unmarshalInputStream

protected Object unmarshalInputStream(InputStream inputStream)
                               throws XmlMappingException,
IOException

Specified by:

unmarshalInputStream in class AbstractMarshaller

Throws:

XmlMappingException

IOException

unmarshalReader

protected Object unmarshalReader(Reader reader)
                          throws XmlMappingException,
IOException

Specified by:

unmarshalReader in class AbstractMarshaller

Throws:

XmlMappingException

IOException

unmarshalDomNode

protected Object unmarshalDomNode(Node node)
                           throws XmlMappingException

Specified by:

unmarshalDomNode in class AbstractMarshaller

Throws:

XmlMappingException

unmarshalSaxReader

protected Object unmarshalSaxReader(XMLReader xmlReader,
 InputSource inputSource)
                             throws XmlMappingException,
IOException

Specified by:

unmarshalSaxReader in class AbstractMarshaller

Throws:

XmlMappingException

IOException

createMarshallingContext

protected IMarshallingContext createMarshallingContext()
                                                throws JiBXException

Create a new IMarshallingContext, configured with the correct indentation.

Returns:

the created marshalling context

Throws:

JiBXException - in case of errors

createUnmarshallingContext

protected IUnmarshallingContext createUnmarshallingContext()
                                                    throws JiBXException

Create a new IUnmarshallingContext.

Returns:

the created unmarshalling context

Throws:

JiBXException - in case of errors

convertJibxException

public XmlMappingException convertJibxException(JiBXException ex,
 boolean marshalling)

Convert the given JiBXException to an appropriate exception from the org.springframework.oxm hierarchy.

A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since JiBX itself does not make this distinction in its exception hierarchy.

Parameters:

ex - JiBXException that occurred

marshalling - indicates whether the exception occurs during marshalling (true), or unmarshalling (false)

Returns:

the corresponding XmlMappingException