org.jboss.resteasy.plugins.providers.jaxb.json

Class JettisonMappedMarshaller

java.lang.Object

org.jboss.resteasy.plugins.providers.jaxb.BaseMarshaller

org.jboss.resteasy.plugins.providers.jaxb.json.JettisonMappedMarshaller

All Implemented Interfaces:

Marshaller

public class JettisonMappedMarshaller
extends BaseMarshaller

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

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

Marshaller.Listener

Field Summary

Fields inherited from class org.jboss.resteasy.plugins.providers.jaxb.BaseMarshaller

charset, marshaller

Fields inherited from interface javax.xml.bind.Marshaller

JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

Constructor Summary

Constructors

Constructor and Description
JettisonMappedMarshaller(JAXBContext context, Map<String,String> xmlToJSON, List<String> attributeMapping, List<String> ignoredElements)
JettisonMappedMarshaller(JAXBContext context, org.codehaus.jettison.mapped.MappedNamespaceConvention convention)

Method Summary

Modifier and Type	Method and Description
<A extends XmlAdapter> A	getAdapter(Class<A> aClass) Gets the adapter associated with the specified type.
AttachmentMarshaller	getAttachmentMarshaller()
ValidationEventHandler	getEventHandler() Return the current event handler or the default event handler if one hasn't been set.
Marshaller.Listener	getListener() Return Marshaller.Listener registered with this Marshaller.
Node	getNode(Object o) Get a DOM tree view of the content tree(Optional).
Object	getProperty(String s) Get the particular property in the underlying implementation of Marshaller.
Schema	getSchema() Get the JAXP 1.3 Schema object being used to perform marshal-time validation.
void	marshal(Object o, ContentHandler contentHandler) Marshal the content tree rooted at jaxbElement into SAX2 events.
void	marshal(Object o, File file) Marshal the content tree rooted at jaxbElement into a file.
void	marshal(Object o, Node node) Marshal the content tree rooted at jaxbElement into a DOM tree.
void	marshal(Object o, Result result) Marshal the content tree rooted at jaxbElement into the specified javax.xml.transform.Result.
void	marshal(Object o, Writer writer) Marshal the content tree rooted at jaxbElement into a Writer.
void	marshal(Object o, XMLEventWriter xmlEventWriter) Marshal the content tree rooted at jaxbElement into a XMLEventWriter.
void	marshal(Object o, XMLStreamWriter xmlStreamWriter) Marshal the content tree rooted at jaxbElement into a XMLStreamWriter.
<A extends XmlAdapter> void	setAdapter(Class<A> aClass, A a) Associates a configured instance of XmlAdapter with this marshaller.
void	setAdapter(XmlAdapter xmlAdapter) Associates a configured instance of XmlAdapter with this marshaller.
void	setAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller) Associate a context that enables binary data within an XML document to be transmitted as XML-binary optimized attachment.
void	setEventHandler(ValidationEventHandler validationEventHandler) Allow an application to register a validation event handler.
void	setListener(Marshaller.Listener listener) Register marshal event callback Marshaller.Listener with this Marshaller.
void	setSchema(Schema schema) Specify the JAXP 1.3 Schema object that should be used to validate subsequent marshal operations against.

Methods inherited from class org.jboss.resteasy.plugins.providers.jaxb.BaseMarshaller

marshal, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

JettisonMappedMarshaller

public JettisonMappedMarshaller(JAXBContext context,
                                Map<String,String> xmlToJSON,
                                List<String> attributeMapping,
                                List<String> ignoredElements)
                         throws JAXBException

Throws:

JAXBException

JettisonMappedMarshaller

public JettisonMappedMarshaller(JAXBContext context,
                                org.codehaus.jettison.mapped.MappedNamespaceConvention convention)
                         throws JAXBException

Throws:

JAXBException

Method Detail

marshal

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

Description copied from interface: Marshaller

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

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

Parameters:

o - 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 obj (or any object reachable from obj). See Marshalling a JAXB element.

marshal

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

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a file.

Parameters:

o - The root of content tree to be marshalled.

file - File to be written. If this file already exists, it will be overwritten.

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 obj (or any object reachable from obj). See Marshalling a JAXB element.

marshal

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

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a Writer.

Parameters:

o - The root of 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 obj (or any object reachable from obj). See Marshalling a JAXB element.

marshal

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

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into SAX2 events.

Parameters:

o - The root of content tree to be marshalled.

contentHandler - XML will be sent to this handler as SAX2 events.

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 obj (or any object reachable from obj). See Marshalling a JAXB element.

marshal

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

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a DOM tree.

Parameters:

o - The content tree to be marshalled.

node - DOM nodes will be added as children of this node. This parameter must be a Node that accepts children (Document, DocumentFragment, or Element)

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 JAXB element.

marshal

public void marshal(Object o,
                    XMLStreamWriter xmlStreamWriter)
             throws JAXBException

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a XMLStreamWriter.

Parameters:

o - The content tree to be marshalled.

xmlStreamWriter - 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 obj (or any object reachable from obj). See Marshalling a JAXB element.

marshal

public void marshal(Object o,
                    XMLEventWriter xmlEventWriter)
             throws JAXBException

Description copied from interface: Marshaller

Marshal the content tree rooted at jaxbElement into a XMLEventWriter.

Parameters:

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

xmlEventWriter - 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 obj (or any object reachable from obj). See Marshalling a JAXB element.

getNode

public Node getNode(Object o)
             throws JAXBException

Description copied from interface: Marshaller

Get a DOM tree view of the content tree(Optional). If the returned DOM tree is updated, these changes are also visible in the content tree. Use Marshaller.marshal(Object, org.w3c.dom.Node) to force a deep copy of the content tree to a DOM representation.

Parameters:

o - - JAXB Java representation of XML content

Returns:

the DOM tree view of the contentTree

Throws:

JAXBException - If any unexpected problem occurs

getProperty

public Object getProperty(String s)
                   throws PropertyException

Description copied from interface: Marshaller

Get the particular property in the underlying implementation of Marshaller. This method can only be used to get one of the standard JAXB defined properties above or a provider specific property. Attempting to get an undefined property will result in a PropertyException being thrown. See Supported Properties.

Parameters:

s - 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

setEventHandler

public void setEventHandler(ValidationEventHandler validationEventHandler)
                     throws JAXBException

Description copied from interface: Marshaller

Allow an application to register a validation event handler.

The validation event handler will be called by the JAXB Provider if any validation errors are encountered during calls to any of the marshal API's. If the client application does not register a validation event handler before invoking one of the marshal methods, then validation events will be handled by the default event handler which will terminate the marshal operation after the first error or fatal error is encountered.

Calling this method with a null parameter will cause the Marshaller to revert back to the default default event handler.

Parameters:

validationEventHandler - the validation event handler

Throws:

JAXBException - if an error was encountered while setting the event handler

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Description copied from interface: Marshaller

Return the current event handler or the default event handler if one hasn't been set.

Returns:

the current ValidationEventHandler or the default event handler if it hasn't been set

Throws:

JAXBException - if an error was encountered while getting the current event handler

setAdapter

public void setAdapter(XmlAdapter xmlAdapter)

Description copied from interface: Marshaller

Associates a configured instance of XmlAdapter with this marshaller.

This is a convenience method that invokes setAdapter(adapter.getClass(),adapter);.

See Also:

Marshaller.setAdapter(Class,XmlAdapter)

setAdapter

public <A extends XmlAdapter> void setAdapter(Class<A> aClass,
                                              A a)

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.

Parameters:

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

a - 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> aClass)

Description copied from interface: Marshaller

Gets the adapter associated with the specified type. This is the reverse operation of the Marshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter) method.

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller)

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.

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

setSchema

public void setSchema(Schema schema)

Description copied from interface: Marshaller

Specify the JAXP 1.3 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.

Parameters:

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

getSchema

public Schema getSchema()

Description copied from interface: Marshaller

Get the JAXP 1.3 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.

Returns:

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

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.

Parameters:

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

getListener

public Marshaller.Listener getListener()

Description copied from interface: Marshaller

Return Marshaller.Listener registered with this Marshaller.

Returns:

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