Package org.glassfish.jaxb.runtime.v2.runtime

Class MarshallerImpl

java.lang.Object

jakarta.xml.bind.helpers.AbstractMarshallerImpl

org.glassfish.jaxb.runtime.v2.runtime.MarshallerImpl

All Implemented Interfaces:

Marshaller, ValidationEventHandler

public final class MarshallerImpl
extends AbstractMarshallerImpl
implements ValidationEventHandler

Implementation of Marshaller interface for the JAXB RI.

Eventually all the marshal(java.lang.Object, java.io.OutputStream, javax.xml.namespace.NamespaceContext) methods call into the write(org.glassfish.jaxb.runtime.v2.runtime.Name, org.glassfish.jaxb.runtime.v2.runtime.JaxBeanInfo<T>, T, org.glassfish.jaxb.runtime.v2.runtime.output.XmlOutput, java.lang.Runnable) method.

Author:

Kohsuke Kawaguchi, Vivek Pandey

Nested Class Summary

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

Marshaller.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	C14N
protected static final String	ENCODING_HANDLER
protected static final String	ENCODING_HANDLER2
protected static final String	INDENT_STRING
protected static final String	OBJECT_IDENTITY_CYCLE_DETECTION
protected static final String	PREFIX_MAPPER
protected final XMLSerializer	serializer
protected static final String	XML_HEADERS
protected static final String	XMLDECLARATION

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
MarshallerImpl(JAXBContextImpl c, AssociationMap assoc)

Method Summary

Modifier and Type	Method	Description
protected CharacterEscapeHandler	createEscapeHandler(String encoding)
XmlOutput	createWriter(OutputStream os)
XmlOutput	createWriter(OutputStream os, String encoding)
XmlOutput	createWriter(Writer w)
XmlOutput	createWriter(Writer w, String encoding)
<A extends XmlAdapter<?, ?>> A	getAdapter(Class<A> type)	Gets the adapter associated with the specified type.
AttachmentMarshaller	getAttachmentMarshaller()
JAXBContextImpl	getContext()
Marshaller.Listener	getListener()	Return Marshaller.Listener registered with this Marshaller.
Object	getProperty(String name)	Default implementation of the getProperty method handles the four defined properties in Marshaller.
Schema	getSchema()	Get the JAXP Schema object being used to perform marshal-time validation.
boolean	handleEvent(ValidationEvent event)	Default error handling behavior fot Marshaller.
void	marshal(Object obj, OutputStream out, NamespaceContext inscopeNamespace)	Marshals to OutputStream with the given in-scope namespaces taken into account.
void	marshal(Object obj, XMLEventWriter writer)	Marshal the content tree rooted at jaxbElement into a XMLEventWriter.
void	marshal(Object obj, XMLStreamWriter writer)	Marshal the content tree rooted at jaxbElement into a XMLStreamWriter.
void	marshal(Object target, Result result)	Marshal the content tree rooted at jaxbElement into the specified javax.xml.transform.Result.
void	marshal(Object obj, XmlOutput output)
<A extends XmlAdapter<?, ?>> void	setAdapter(Class<A> type, A adapter)	Associates a configured instance of XmlAdapter with this marshaller.
void	setAttachmentMarshaller(AttachmentMarshaller am)	Associate a context that enables binary data within an XML document to be transmitted as XML-binary optimized attachment.
void	setListener(Marshaller.Listener listener)	Register marshal event callback Marshaller.Listener with this Marshaller.
void	setProperty(String name, Object value)	Default implementation of the setProperty method handles the four defined properties in Marshaller.
void	setSchema(Schema s)	Specify the JAXP Schema object that should be used to validate subsequent marshal operations against.
protected <T> void	write(Name rootTagName, JaxBeanInfo<T> bi, T obj, XmlOutput out, Runnable postInitAction)	Used by BridgeImpl to write an arbitrary object as a fragment.

Methods inherited from class jakarta.xml.bind.helpers.AbstractMarshallerImpl

getEncoding, getEventHandler, getJavaEncoding, getNode, getNoNSSchemaLocation, getSchemaLocation, isFormattedOutput, isFragment, marshal, marshal, marshal, marshal, marshal, setAdapter, setEncoding, setEventHandler, setFormattedOutput, setFragment, setNoNSSchemaLocation, setSchemaLocation

Methods inherited from class java.lang.Object

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

Field Details

serializer

protected final XMLSerializer serializer

INDENT_STRING

protected static final String INDENT_STRING

See Also:

• Constant Field Values

PREFIX_MAPPER

protected static final String PREFIX_MAPPER

See Also:

• Constant Field Values

ENCODING_HANDLER

protected static final String ENCODING_HANDLER

See Also:

• Constant Field Values

ENCODING_HANDLER2

protected static final String ENCODING_HANDLER2

See Also:

• Constant Field Values

XMLDECLARATION

protected static final String XMLDECLARATION

See Also:

• Constant Field Values

XML_HEADERS

protected static final String XML_HEADERS

See Also:

• Constant Field Values

C14N

protected static final String C14N

See Also:

• Constant Field Values

OBJECT_IDENTITY_CYCLE_DETECTION

protected static final String OBJECT_IDENTITY_CYCLE_DETECTION

See Also:

• Constant Field Values

Constructor Details

MarshallerImpl

public MarshallerImpl(JAXBContextImpl c,
 AssociationMap assoc)

Parameters:

assoc - non-null if the marshaller is working inside BinderImpl.

Method Details

getContext

public JAXBContextImpl getContext()

marshal

public void marshal(Object obj,
 OutputStream out,
 NamespaceContext inscopeNamespace)
             throws JAXBException

Marshals to OutputStream with the given in-scope namespaces taken into account.

Throws:

JAXBException

Since:

2.1.5

marshal

public void marshal(Object obj,
 XMLStreamWriter writer)
             throws JAXBException

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a XMLStreamWriter.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class AbstractMarshallerImpl

Parameters:

obj - The content tree to be marshalled.

writer - XML will be sent to this writer.

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

MarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Marshaller is unable to marshal jaxbElement (or any object reachable from jaxbElement). See Marshalling a Jakarta XML Binding element.

marshal

public void marshal(Object obj,
 XMLEventWriter writer)
             throws JAXBException

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a XMLEventWriter.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class AbstractMarshallerImpl

Parameters:

obj - The content tree rooted at jaxbElement to be marshalled.

writer - XML will be sent to this writer.

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

MarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Marshaller is unable to marshal jaxbElement (or any object reachable from jaxbElement). See Marshalling a Jakarta XML Binding element.

marshal

public void marshal(Object obj,
 XmlOutput output)
             throws JAXBException

Throws:

JAXBException

marshal

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

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into the specified javax.xml.transform.Result.

All Jakarta XML Binding Providers must at least support DOMResult, SAXResult, and StreamResult. It can support other derived classes of Result as well.

Specified by:

marshal in interface Marshaller

Parameters:

target - The root of content tree to be marshalled.

result - XML will be sent to this Result

Throws:

JAXBException - If any unexpected problem occurs during the marshalling.

MarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Marshaller is unable to marshal jaxbElement (or any object reachable from jaxbElement). See Marshalling a Jakarta XML Binding element.

write

protected <T> void write(Name rootTagName,
 JaxBeanInfo<T> bi,
 T obj,
 XmlOutput out,
 Runnable postInitAction)
                  throws JAXBException

Used by BridgeImpl to write an arbitrary object as a fragment.

Throws:

JAXBException

createEscapeHandler

protected CharacterEscapeHandler createEscapeHandler(String encoding)

createWriter

public XmlOutput createWriter(Writer w,
 String encoding)

createWriter

public XmlOutput createWriter(Writer w)

createWriter

public XmlOutput createWriter(OutputStream os)
                       throws JAXBException

Throws:

JAXBException

createWriter

public XmlOutput createWriter(OutputStream os,
 String encoding)
                       throws JAXBException

Throws:

JAXBException

getProperty

public Object getProperty(String name)
                   throws PropertyException

Description copied from class: AbstractMarshallerImpl

Default implementation of the getProperty method handles the four defined properties in Marshaller. If a provider needs to support additional provider specific properties, it should override this method in a derived class.

Specified by:

getProperty in interface Marshaller

Overrides:

getProperty in class AbstractMarshallerImpl

Parameters:

name - the name of the property to retrieve

Returns:

the value of the requested property

Throws:

PropertyException - when there is an error retrieving the given property or value property name

setProperty

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

Description copied from class: AbstractMarshallerImpl

Default implementation of the setProperty method handles the four defined properties in Marshaller. If a provider needs to handle additional properties, it should override this method in a derived class.

Specified by:

setProperty in interface Marshaller

Overrides:

setProperty in class AbstractMarshallerImpl

Parameters:

name - the name of the property to be set. This value can either be specified using one of the constant fields or a user supplied string.

value - the value of the property to be set

Throws:

PropertyException - when there is an error processing the given property or value

setAdapter

public <A extends XmlAdapter<?,
?>> void setAdapter(Class<A> type,
 A adapter)

Description copied from interface: Marshaller

Associates a configured instance of XmlAdapter with this marshaller.

Every marshaller internally maintains a Map<Class,XmlAdapter>, which it uses for marshalling classes whose fields/methods are annotated with XmlJavaTypeAdapter.

This method allows applications to use a configured instance of XmlAdapter. When an instance of an adapter is not given, a marshaller will create one by invoking its default constructor.

Specified by:

setAdapter in interface Marshaller

Overrides:

setAdapter in class AbstractMarshallerImpl

Type Parameters:

A - the type of the adapter

Parameters:

type - The type of the adapter. The specified instance will be used when XmlJavaTypeAdapter.value() refers to this type.

adapter - The instance of the adapter to be used. If null, it will un-register the current adapter set for this type.

getAdapter

public <A extends XmlAdapter<?,
?>> A getAdapter(Class<A> type)

Description copied from interface: Marshaller

Gets the adapter associated with the specified type. This is the reverse operation of the Marshaller.setAdapter(A) method.

Specified by:

getAdapter in interface Marshaller

Overrides:

getAdapter in class AbstractMarshallerImpl

Type Parameters:

A - the type of the adapter

Parameters:

type - The type of the adapter. The specified instance will be used when XmlJavaTypeAdapter.value() refers to this type.

Returns:

The adapter associated with the specified type.

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller am)

Description copied from interface: Marshaller

Associate a context that enables binary data within an XML document to be transmitted as XML-binary optimized attachment. The attachment is referenced from the XML document content model by content-id URIs(cid) references stored within the xml document.

Specified by:

setAttachmentMarshaller in interface Marshaller

Overrides:

setAttachmentMarshaller in class AbstractMarshallerImpl

Parameters:

am - the attachment marshaller to be set

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

Specified by:

getAttachmentMarshaller in interface Marshaller

Overrides:

getAttachmentMarshaller in class AbstractMarshallerImpl

getSchema

public Schema getSchema()

Description copied from interface: Marshaller

Get the JAXP Schema object being used to perform marshal-time validation. If there is no Schema set on the marshaller, then this method will return null indicating that marshal-time validation will not be performed.

Specified by:

getSchema in interface Marshaller

Overrides:

getSchema in class AbstractMarshallerImpl

Returns:

the Schema object being used to perform marshal-time validation or null if not present.

setSchema

public void setSchema(Schema s)

Description copied from interface: Marshaller

Specify the JAXP Schema object that should be used to validate subsequent marshal operations against. Passing null into this method will disable validation.

This method allows the caller to validate the marshalled XML as it's marshalled.

Initially this property is set to null.

Specified by:

setSchema in interface Marshaller

Overrides:

setSchema in class AbstractMarshallerImpl

Parameters:

s - Schema object to validate marshal operations against or null to disable validation

handleEvent

public boolean handleEvent(ValidationEvent event)

Default error handling behavior fot Marshaller.

Specified by:

handleEvent in interface ValidationEventHandler

Parameters:

event - the encapsulated validation event information. It is a provider error if this parameter is null.

Returns:

true if the Jakarta XML Binding Provider should attempt to continue the current unmarshal, validate, or marshal operation after handling this warning/error, false if the provider should terminate the current operation with the appropriate UnmarshalException, ValidationException, or MarshalException.

getListener

public Marshaller.Listener getListener()

Description copied from interface: Marshaller

Return Marshaller.Listener registered with this Marshaller.

Specified by:

getListener in interface Marshaller

Overrides:

getListener in class AbstractMarshallerImpl

Returns:

registered Marshaller.Listener or null if no Listener is registered with this Marshaller.

setListener

public void setListener(Marshaller.Listener listener)

Description copied from interface: Marshaller

Register marshal event callback Marshaller.Listener with this Marshaller.

There is only one Listener per Marshaller. Setting a Listener replaces the previous set Listener. One can unregister current Listener by setting listener to null.

Specified by:

setListener in interface Marshaller

Overrides:

setListener in class AbstractMarshallerImpl

Parameters:

listener - an instance of a class that implements Marshaller.Listener