Package org.eclipse.persistence.jaxb
Class JAXBMarshaller
- java.lang.Object
-
- org.eclipse.persistence.jaxb.JAXBMarshaller
-
- All Implemented Interfaces:
jakarta.xml.bind.Marshaller
public class JAXBMarshaller extends Object implements jakarta.xml.bind.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.
- See Also:
Marshaller
,MarshallerProperties
,XMLMarshaller
- Author:
- mmacivor
- Since:
- Oracle TopLink 11.1.1.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
XML_JAVATYPE_ADAPTERS
-
Constructor Summary
Constructors Constructor Description JAXBMarshaller(XMLMarshaller newXMLMarshaller, JAXBContext jaxbContext)
This constructor initializes various settings on the XML marshaller.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description jakarta.xml.bind.annotation.adapters.XmlAdapter
getAdapter(Class javaClass)
jakarta.xml.bind.attachment.AttachmentMarshaller
getAttachmentMarshaller()
Set<ConstraintViolationWrapper<Object>>
getConstraintViolations()
Returns constraint violations stored in the underlyingJAXBBeanValidator
instance.jakarta.xml.bind.ValidationEventHandler
getEventHandler()
JAXBContext
getJaxbContext()
jakarta.xml.bind.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(jakarta.xml.bind.annotation.adapters.XmlAdapter adapter)
void
setAdapter(Class javaClass, jakarta.xml.bind.annotation.adapters.XmlAdapter adapter)
void
setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller attachmentMarshaller)
void
setEventHandler(jakarta.xml.bind.ValidationEventHandler newValidationEventHandler)
void
setListener(jakarta.xml.bind.Marshaller.Listener listener)
void
setMarshalCallbacks(Map callbacks)
void
setProperty(String key, Object value)
Set a property on the JAXBMarshaller.void
setSchema(Schema schema)
-
-
-
Field Detail
-
XML_JAVATYPE_ADAPTERS
public static final String XML_JAVATYPE_ADAPTERS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JAXBMarshaller
public JAXBMarshaller(XMLMarshaller newXMLMarshaller, JAXBContext jaxbContext)
This constructor initializes various settings on the XML marshaller.- Parameters:
newXMLMarshaller
- xml marshallerjaxbContext
- jaxb context
-
-
Method Detail
-
getAdapter
public jakarta.xml.bind.annotation.adapters.XmlAdapter getAdapter(Class javaClass)
- Specified by:
getAdapter
in interfacejakarta.xml.bind.Marshaller
-
getAttachmentMarshaller
public jakarta.xml.bind.attachment.AttachmentMarshaller getAttachmentMarshaller()
- Specified by:
getAttachmentMarshaller
in interfacejakarta.xml.bind.Marshaller
-
getEventHandler
public jakarta.xml.bind.ValidationEventHandler getEventHandler() throws jakarta.xml.bind.JAXBException
- Specified by:
getEventHandler
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
getListener
public jakarta.xml.bind.Marshaller.Listener getListener()
- Specified by:
getListener
in interfacejakarta.xml.bind.Marshaller
-
getNode
public Node getNode(Object object) throws jakarta.xml.bind.JAXBException
- Specified by:
getNode
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
getProperty
public Object getProperty(String key) throws jakarta.xml.bind.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 interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.PropertyException
- See Also:
MarshallerProperties
-
getSchema
public Schema getSchema()
- Specified by:
getSchema
in interfacejakarta.xml.bind.Marshaller
-
marshal
public void marshal(Object object, ContentHandler contentHandler) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, XMLEventWriter eventWriter) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, XMLEventWriter eventWriter, TypeMappingInfo type) throws jakarta.xml.bind.JAXBException
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, Node node) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, OutputStream outputStream) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, File file) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, Result result) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, Result result, TypeMappingInfo type) throws jakarta.xml.bind.JAXBException
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, XMLStreamWriter streamWriter) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, XMLStreamWriter streamWriter, TypeMappingInfo type) throws jakarta.xml.bind.JAXBException
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, Writer writer) throws jakarta.xml.bind.JAXBException
- Specified by:
marshal
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, MarshalRecord record) throws jakarta.xml.bind.JAXBException
- Throws:
jakarta.xml.bind.JAXBException
-
marshal
public void marshal(Object object, MarshalRecord record, TypeMappingInfo type) throws jakarta.xml.bind.JAXBException
- Throws:
jakarta.xml.bind.JAXBException
-
setAdapter
public void setAdapter(Class javaClass, jakarta.xml.bind.annotation.adapters.XmlAdapter adapter)
- Specified by:
setAdapter
in interfacejakarta.xml.bind.Marshaller
-
setAdapter
public void setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter adapter)
- Specified by:
setAdapter
in interfacejakarta.xml.bind.Marshaller
-
setAttachmentMarshaller
public void setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller attachmentMarshaller)
- Specified by:
setAttachmentMarshaller
in interfacejakarta.xml.bind.Marshaller
-
setEventHandler
public void setEventHandler(jakarta.xml.bind.ValidationEventHandler newValidationEventHandler) throws jakarta.xml.bind.JAXBException
- Specified by:
setEventHandler
in interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.JAXBException
-
setListener
public void setListener(jakarta.xml.bind.Marshaller.Listener listener)
- Specified by:
setListener
in interfacejakarta.xml.bind.Marshaller
-
setMarshalCallbacks
public void setMarshalCallbacks(Map callbacks)
-
setProperty
public void setProperty(String key, Object value) throws jakarta.xml.bind.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 interfacejakarta.xml.bind.Marshaller
- Throws:
jakarta.xml.bind.PropertyException
- See Also:
MarshallerProperties
-
setSchema
public void setSchema(Schema schema)
- Specified by:
setSchema
in interfacejakarta.xml.bind.Marshaller
-
getJaxbContext
public JAXBContext getJaxbContext()
-
getXMLMarshaller
public XMLMarshaller getXMLMarshaller()
-
getConstraintViolations
public Set<ConstraintViolationWrapper<Object>> getConstraintViolations()
Returns constraint violations stored in the underlyingJAXBBeanValidator
instance.- Returns:
- set of constraint violations from last unmarshal
-
-