com.sun.jersey.json.impl

Class BaseJSONMarshaller

java.lang.Object

com.sun.jersey.json.impl.BaseJSONMarshaller

All Implemented Interfaces:

JSONConfigurated, JSONMarshaller

Direct Known Subclasses:

JSONMarshallerImpl

public class BaseJSONMarshaller
extends Object
implements JSONMarshaller, JSONConfigurated

Author:

Jakub Podlesak (jakub.podlesak at oracle.com), Michal Gajdos (michal.gajdos at oracle.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected Marshaller	jaxbMarshaller
protected JSONConfiguration	jsonConfig

Fields inherited from interface com.sun.jersey.api.json.JSONMarshaller

FORMATTED

Constructor Summary

Constructors

Constructor and Description
BaseJSONMarshaller(JAXBContext jaxbContext, JSONConfiguration jsonConfig)
BaseJSONMarshaller(Marshaller jaxbMarshaller, JAXBContext jaxbContext, JSONConfiguration jsonConfig)

Method Summary

Modifier and Type	Method and Description
JSONConfiguration	getJSONConfiguration() Provides information on current JSON configuration options for this object.
void	marshallToJSON(Object o, OutputStream outputStream) Marshall the content tree rooted at jaxbElement into an output stream.
void	marshallToJSON(Object o, Writer writer) Marshall the content tree rooted at jaxbElement into an output stream.
void	setProperty(String key, Object value) Set the particular property in the underlying implementation of JSONMarshaller.

Methods inherited from class java.lang.Object

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

Field Detail

jaxbMarshaller

protected final Marshaller jaxbMarshaller

jsonConfig

protected JSONConfiguration jsonConfig

Constructor Detail

BaseJSONMarshaller

public BaseJSONMarshaller(JAXBContext jaxbContext,
                          JSONConfiguration jsonConfig)
                   throws JAXBException

Throws:

JAXBException

BaseJSONMarshaller

public BaseJSONMarshaller(Marshaller jaxbMarshaller,
                          JAXBContext jaxbContext,
                          JSONConfiguration jsonConfig)

Method Detail

getJSONConfiguration

public JSONConfiguration getJSONConfiguration()

Description copied from interface: JSONConfigurated

Provides information on current JSON configuration options for this object.

Specified by:

getJSONConfiguration in interface JSONConfigurated

Returns:

a non-null JSONConfiguration instance.

marshallToJSON

public void marshallToJSON(Object o,
                           OutputStream outputStream)
                    throws JAXBException

Description copied from interface: JSONMarshaller

Marshall the content tree rooted at jaxbElement into an output stream. The content tree may be an instance of a class that is mapped to a XML root element (for example, annotated with XmlRootElement) or an instance of JAXBElement.

The UTF-8 character encoding scheme will be used to encode the characters of the JSON data.

Specified by:

marshallToJSON in interface JSONMarshaller

Parameters:

o - the root of the content tree to be marshalled.

outputStream - the JSON will be added to this stream.

Throws:

JAXBException - if any unexpected problem occurs during the marshalling.

MarshalException - if the JSONMarshaller is unable to marshal jaxbElement (or any object reachable from obj)

marshallToJSON

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

Description copied from interface: JSONMarshaller

Marshall the content tree rooted at jaxbElement into an output stream. The content tree may be an instance of a class that is mapped to a XML root element (for example, annotated with XmlRootElement) or an instance of JAXBElement.

The character encoding scheme of the writer will be used to encode the characters of the JSON data.

Specified by:

marshallToJSON in interface JSONMarshaller

Parameters:

o - the root of the content tree to be marshalled.

writer - the JSON will be added to this writer.

Throws:

JAXBException - if any unexpected problem occurs during the marshalling.

MarshalException - if the JSONMarshaller is unable to marshal jaxbElement (or any object reachable from obj)

setProperty

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

Description copied from interface: JSONMarshaller

Set the particular property in the underlying implementation of JSONMarshaller. Attempting to set an undefined property will result in a PropertyException being thrown.

Specified by:

setProperty in interface JSONMarshaller

Parameters:

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