Module org.eclipse.persistence.moxy

Package org.eclipse.persistence.jaxb

Class JAXBMarshaller

java.lang.Object

org.eclipse.persistence.jaxb.JAXBMarshaller

All Implemented Interfaces:

Marshaller

public class JAXBMarshaller
extends Object
implements Marshaller

INTERNAL:

Purpose:To Provide an implementation of the JAXB 2.0 Marshaller Interface

Responsibilities:

• Provide a JAXB wrapper on the XMLMarshaller API
• Perform Object to XML Conversions

This implementation of the JAXB 2.1/2.2 Marshaller interface provides the required functionality by acting as a thin wrapper on the existing XMLMarshaller API.

Since:

Oracle TopLink 11.1.1.0.0

See Also:

• Marshaller
• MarshallerProperties
• XMLMarshaller

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.xml.bind.Marshaller

Marshaller.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_JAVATYPE_ADAPTERS

Fields inherited from interface jakarta.xml.bind.Marshaller

JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

Constructor Summary

Constructors

Constructor	Description
JAXBMarshaller(XMLMarshaller newXMLMarshaller, JAXBContext jaxbContext)	This constructor initializes various settings on the XML marshaller.

Method Summary

Modifier and Type	Method	Description
XmlAdapter	getAdapter(Class javaClass)
AttachmentMarshaller	getAttachmentMarshaller()
Set<ConstraintViolationWrapper<Object>>	getConstraintViolations()	Returns constraint violations stored in the underlying JAXBBeanValidator instance.
ValidationEventHandler	getEventHandler()
JAXBContext	getJaxbContext()
Marshaller.Listener	getListener()
Node	getNode(Object object)
Object	getProperty(String key)	Get a property from the JAXBMarshaller.
Schema	getSchema()
XMLMarshaller	getXMLMarshaller()
void	marshal(Object object, File file)
void	marshal(Object object, OutputStream outputStream)
void	marshal(Object object, Writer writer)
void	marshal(Object object, XMLEventWriter eventWriter)
void	marshal(Object object, XMLEventWriter eventWriter, TypeMappingInfo type)
void	marshal(Object object, XMLStreamWriter streamWriter)
void	marshal(Object object, XMLStreamWriter streamWriter, TypeMappingInfo type)
void	marshal(Object object, Result result)
void	marshal(Object object, Result result, TypeMappingInfo type)
void	marshal(Object object, MarshalRecord record)
void	marshal(Object object, MarshalRecord record, TypeMappingInfo type)
void	marshal(Object object, Node node)
void	marshal(Object object, ContentHandler contentHandler)
void	setAdapter(XmlAdapter adapter)
void	setAdapter(Class javaClass, XmlAdapter adapter)
void	setAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller)
void	setEventHandler(ValidationEventHandler newValidationEventHandler)
void	setListener(Marshaller.Listener listener)
void	setMarshalCallbacks(Map callbacks)
void	setProperty(String key, Object value)	Set a property on the JAXBMarshaller.
void	setSchema(Schema schema)

Methods inherited from class java.lang.Object

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

Field Details

XML_JAVATYPE_ADAPTERS

public static final String XML_JAVATYPE_ADAPTERS

See Also:

• Constant Field Values

Constructor Details

JAXBMarshaller

public JAXBMarshaller(XMLMarshaller newXMLMarshaller,
 JAXBContext jaxbContext)

This constructor initializes various settings on the XML marshaller.

Parameters:

newXMLMarshaller - xml marshaller

jaxbContext - jaxb context

Method Details

getAdapter

public XmlAdapter getAdapter(Class javaClass)

Specified by:

getAdapter in interface Marshaller

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

Specified by:

getAttachmentMarshaller in interface Marshaller

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Specified by:

getEventHandler in interface Marshaller

Throws:

JAXBException

getListener

public Marshaller.Listener getListener()

Specified by:

getListener in interface Marshaller

getNode

public Node getNode(Object object)
             throws JAXBException

Specified by:

getNode in interface Marshaller

Throws:

JAXBException

getProperty

public Object getProperty(String key)
                   throws PropertyException

Get a property from the JAXBMarshaller. Attempting to get any unsupported property will result in a jakarta.xml.bind.PropertyException

Specified by:

getProperty in interface Marshaller

Throws:

PropertyException

See Also:

• MarshallerProperties

getSchema

public Schema getSchema()

Specified by:

getSchema in interface Marshaller

marshal

public void marshal(Object object,
 ContentHandler contentHandler)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLEventWriter eventWriter)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLEventWriter eventWriter,
 TypeMappingInfo type)
             throws JAXBException

Throws:

JAXBException

marshal

public void marshal(Object object,
 Node node)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 OutputStream outputStream)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 File file)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 Result result)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 Result result,
 TypeMappingInfo type)
             throws JAXBException

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLStreamWriter streamWriter)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLStreamWriter streamWriter,
 TypeMappingInfo type)
             throws JAXBException

Throws:

JAXBException

marshal

public void marshal(Object object,
 Writer writer)
             throws JAXBException

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 MarshalRecord record)
             throws JAXBException

Throws:

JAXBException

marshal

public void marshal(Object object,
 MarshalRecord record,
 TypeMappingInfo type)
             throws JAXBException

Throws:

JAXBException

setAdapter

public void setAdapter(Class javaClass,
 XmlAdapter adapter)

Specified by:

setAdapter in interface Marshaller

setAdapter

public void setAdapter(XmlAdapter adapter)

Specified by:

setAdapter in interface Marshaller

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller)

Specified by:

setAttachmentMarshaller in interface Marshaller

setEventHandler

public void setEventHandler(ValidationEventHandler newValidationEventHandler)
                     throws JAXBException

Specified by:

setEventHandler in interface Marshaller

Throws:

JAXBException

setListener

public void setListener(Marshaller.Listener listener)

Specified by:

setListener in interface Marshaller

setMarshalCallbacks

public void setMarshalCallbacks(Map callbacks)

setProperty

public void setProperty(String key,
 Object value)
                 throws PropertyException

Set a property on the JAXBMarshaller. Attempting to set any unsupported property will result in a jakarta.xml.bind.PropertyException

Specified by:

setProperty in interface Marshaller

Throws:

PropertyException

See Also:

• MarshallerProperties

setSchema

public void setSchema(Schema schema)

Specified by:

setSchema in interface Marshaller

getJaxbContext

public JAXBContext getJaxbContext()

getXMLMarshaller

public XMLMarshaller getXMLMarshaller()

getConstraintViolations

public Set<ConstraintViolationWrapper<Object>> getConstraintViolations()

Returns constraint violations stored in the underlying JAXBBeanValidator instance.

Returns:

set of constraint violations from last unmarshal