Class BaseJsonMarshaller
java.lang.Object
org.glassfish.jersey.jettison.internal.BaseJsonMarshaller
- All Implemented Interfaces:
JettisonConfigured
,JettisonMarshaller
- Direct Known Subclasses:
JettisonJaxbMarshaller
Base JSON marshaller implementation class.
- Author:
- Jakub Podlesak, Michal Gajdos
-
Field Summary
Modifier and TypeFieldDescriptionprotected final jakarta.xml.bind.Marshaller
protected JettisonConfig
Fields inherited from interface org.glassfish.jersey.jettison.JettisonMarshaller
FORMATTED
-
Constructor Summary
ConstructorDescriptionBaseJsonMarshaller
(jakarta.xml.bind.JAXBContext jaxbContext, JettisonConfig jsonConfig) BaseJsonMarshaller
(jakarta.xml.bind.Marshaller jaxbMarshaller, JettisonConfig jsonConfig) -
Method Summary
Modifier and TypeMethodDescriptionProvides information on current JSON configuration options for this object.void
marshallToJSON
(Object o, OutputStream outputStream) Marshall the content tree rooted atjaxbElement
into an output stream.void
marshallToJSON
(Object o, Writer writer) Marshall the content tree rooted atjaxbElement
into an output stream.void
setProperty
(String key, Object value) Set the particular property in the underlying implementation ofJettisonMarshaller
.
-
Field Details
-
jaxbMarshaller
protected final jakarta.xml.bind.Marshaller jaxbMarshaller -
jsonConfig
-
-
Constructor Details
-
BaseJsonMarshaller
public BaseJsonMarshaller(jakarta.xml.bind.JAXBContext jaxbContext, JettisonConfig jsonConfig) throws jakarta.xml.bind.JAXBException - Throws:
jakarta.xml.bind.JAXBException
-
BaseJsonMarshaller
-
-
Method Details
-
getJSONConfiguration
Description copied from interface:JettisonConfigured
Provides information on current JSON configuration options for this object.- Specified by:
getJSONConfiguration
in interfaceJettisonConfigured
- Returns:
- a non-null
JettisonConfig
instance.
-
marshallToJSON
public void marshallToJSON(Object o, OutputStream outputStream) throws jakarta.xml.bind.JAXBException Description copied from interface:JettisonMarshaller
Marshall the content tree rooted atjaxbElement
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 withXmlRootElement
) or an instance ofJAXBElement
.The UTF-8 character encoding scheme will be used to encode the characters of the JSON data.
- Specified by:
marshallToJSON
in interfaceJettisonMarshaller
- Parameters:
o
- the root of the content tree to be marshalled.outputStream
- the JSON will be added to this stream.- Throws:
jakarta.xml.bind.JAXBException
- if any unexpected problem occurs during the marshalling.jakarta.xml.bind.MarshalException
- if theJsonMarshaller
is unable to marshaljaxbElement
(or any object reachable from obj)
-
marshallToJSON
Description copied from interface:JettisonMarshaller
Marshall the content tree rooted atjaxbElement
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 withXmlRootElement
) or an instance ofJAXBElement
.The character encoding scheme of the
writer
will be used to encode the characters of the JSON data.- Specified by:
marshallToJSON
in interfaceJettisonMarshaller
- Parameters:
o
- the root of the content tree to be marshalled.writer
- the JSON will be added to this writer.- Throws:
jakarta.xml.bind.JAXBException
- if any unexpected problem occurs during the marshalling.jakarta.xml.bind.MarshalException
- if theJsonMarshaller
is unable to marshaljaxbElement
(or any object reachable from obj)
-
setProperty
Description copied from interface:JettisonMarshaller
Set the particular property in the underlying implementation ofJettisonMarshaller
. Attempting to set an undefined property will result in a PropertyException being thrown.- Specified by:
setProperty
in interfaceJettisonMarshaller
- 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:
jakarta.xml.bind.PropertyException
- when there is an error processing the given property or value
-