java.lang.Object
- org.apache.axiom.om.ds.AbstractOMDataSource
- - org.apache.axiom.om.ds.AbstractPushOMDataSource
  - - org.apache.axiom.om.ds.jaxb.JAXBOMDataSource

All Implemented Interfaces:

OMDataSource, OMDataSourceExt, QNameAwareOMDataSource
```
public class JAXBOMDataSource
extends AbstractPushOMDataSource
implements QNameAwareOMDataSource
```
OMDataSource backed by a JAXB object. This class can be used both for plain JAXB objects and for JAXBElement instances. It implements QNameAwareOMDataSource so that it can be used with OMFactory.createOMElement(OMDataSource), i.e. it is not necessary to supply the QName during construction of the OMSourcedElement. It also has full support for XOP/MTOM. It is implemented as a push-style OMDataSource so that an OMSourcedElement backed by an instance of this class can be expanded in an efficient way (including the case where the JAXB object contains base64 binary data represented as DataHandler instances or byte arrays).
The JAXB object encapsulated by an instance of this class can be retrieved using OMDataSourceExt.getObject(). Note that modifying the JAXB object after passing it to the constructor may result in unexpected behavior and should be avoided.
Instances of this class are non destructive, in the sense defined by OMDataSourceExt.isDestructiveWrite().

Constructor Summary

Constructors
Constructor Description

JAXBOMDataSource(JAXBContext context, Object object)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OMDataSourceExt`	`copy()`	Create a copy of the data source.
`String`	`getLocalName()`	Get the local name of the element represented by this data source.
`String`	`getNamespaceURI()`	Get the namespace URI of the element represented by this data source.
`Object`	`getObject()`	Get the object that backs this data source.
`String`	`getPrefix()`	Get the namespace prefix of the element represented by this data source.
`boolean`	`isDestructiveWrite()`	Returns true if writing the backing object is destructive.
`void`	`serialize(XMLStreamWriter writer)`	Serializes element data directly to StAX writer.

Methods inherited from class org.apache.axiom.om.ds.AbstractPushOMDataSource
getReader, isDestructiveRead

Methods inherited from class org.apache.axiom.om.ds.AbstractOMDataSource
close, getProperty, getXMLBytes, getXMLInputStream, hasProperty, serialize, serialize, setProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.axiom.om.OMDataSource
getReader, serialize, serialize

- Constructor Detail
  - JAXBOMDataSource
```
public JAXBOMDataSource(JAXBContext context,
                        Object object)
```
    Constructor.
    
    Parameters:
    
    context - the JAXB context to which the object is known
    
    object - the JAXB object; this may be a plain Java bean or a JAXBElement
- Method Detail
  - isDestructiveWrite
```
public boolean isDestructiveWrite()
```
    Description copied from interface: OMDataSourceExt
    
    Returns true if writing the backing object is destructive. An example of an object with a destructive write is an InputStream. The owning OMSourcedElement uses this information to detemine if OM tree expansion is needed when writing the OMDataSourceExt.
    
    Specified by:
    
    isDestructiveWrite in interface OMDataSourceExt
    
    Returns:
    
    boolean
  - serialize
```
public void serialize(XMLStreamWriter writer)
               throws XMLStreamException
```
    Description copied from interface: OMDataSource
    Serializes element data directly to StAX writer.
    The implementation of this method must satisfy the following requirements:
    
    The implementation MUST NOT not write any start document or end document event, i.e. it MUST NOT use XMLStreamWriter.writeStartDocument(), XMLStreamWriter.writeStartDocument(String), XMLStreamWriter.writeStartDocument(String, String) or XMLStreamWriter.writeEndElement().
    The implementation MUST output a single element (hereafter called the root element). It MUST NOT output any other content before or after that element.
    The implementation MUST specify the namespace URI when writing an element, i.e. it MUST NOT use the namespace unaware methods XMLStreamWriter.writeStartElement(String) or XMLStreamWriter.writeEmptyElement(String). On the other hand, it MAY use the namespace unaware XMLStreamWriter.writeAttribute(String, String) method, provided that the specified name is an NCName.
    The implementation MUST ensure that the produced XML is well formed with respect to namespaces, i.e. it MUST generate the required namespace declarations using XMLStreamWriter.writeNamespace(String, String) and XMLStreamWriter.writeDefaultNamespace(String). It MUST NOT assume that the XMLStreamWriter performs any kind of namespace repairing (although that may be the case).
    In addition the implementation MAY use XMLStreamWriter.setPrefix(String, String) and XMLStreamWriter.setDefaultNamespace(String) to track the namespace declarations it generates, so that the namespace context maintained by the XMLStreamWriter accurately reflects the namespace context in the output document. However, it MUST NOT call these methods before the start of the root element or after the end of the root element.
    Since the element may be serialized as part of a larger document, the implementation MUST take into account the pre-existing namespace context (which can be queried using XMLStreamWriter.getPrefix(String) and XMLStreamWriter.getNamespaceContext()). This means that the implementation MUST NOT assume that the empty prefix is bound to the empty namespace URI. Therefore if the implementation outputs elements that have no namespace, it MUST generate namespace declarations of the form xmlns="" in the appropriate locations. In addition it MAY use the namespace context information to minimize the number of generated namespace declarations (by reusing already bound prefixes).
    To produce base64 binary data (that could be optimized using XOP/MTOM), the implementation MUST use one of the following approaches:
    
    Use the DataHandlerWriter extension (or alternatively the XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) utility methods) to write the data to the stream. This is the preferred approach, unless the content is produced by a third party library that is not aware of these APIs.
    Cast the XMLStreamWriter to an MTOMXMLStreamWriter, use MTOMXMLStreamWriter.prepareDataHandler(DataHandler) and generate the necessary xop:Include elements. In this case, the implementation MAY use MTOMXMLStreamWriter.isOptimized() to check if XOP/MTOM is enabled at all.
    
    The implementation MUST NOT call XMLStreamWriter.close().
    
    On the other hand, the caller of this method (typically an OMSourcedElement instance) must ensure that the following requirements are satisfied:
    
    The namespace context information provided by XMLStreamWriter.getPrefix(String) and XMLStreamWriter.getNamespaceContext() MUST accurately reflect the actual namespace context at the location in the output document where the root element is serialized. Note that this requirement may be relaxed if the caller implements some form of namespace repairing.
    
    It is assumed that this method consumes the content (i.e. destroys the backing object) unless the data source also implements OMDataSourceExt and OMDataSourceExt.isDestructiveWrite() returns false.
    Specified by:
    
    serialize in interface OMDataSource
    
    Parameters:
    
    writer - destination writer
    
    Throws:
    
    XMLStreamException - if an exception was thrown by writer; implementations should throw unchecked exceptions in all other cases
  - getLocalName
```
public String getLocalName()
```
    Description copied from interface: QNameAwareOMDataSource
    
    Get the local name of the element represented by this data source.
    
    Specified by:
    
    getLocalName in interface QNameAwareOMDataSource
    
    Returns:
    
    the local name of the element or null if the local name is not known
  - getNamespaceURI
```
public String getNamespaceURI()
```
    Description copied from interface: QNameAwareOMDataSource
    
    Get the namespace URI of the element represented by this data source.
    
    Specified by:
    
    getNamespaceURI in interface QNameAwareOMDataSource
    
    Returns:
    
    the namespace URI of the element, the empty string if the element has no namespace or null if the namespace URI is not known
  - getPrefix
```
public String getPrefix()
```
    Description copied from interface: QNameAwareOMDataSource
    
    Get the namespace prefix of the element represented by this data source.
    
    Specified by:
    
    getPrefix in interface QNameAwareOMDataSource
    
    Returns:
    
    the prefix of the element, the empty string if the element has no prefix or null if the prefix is not known; the implementation is expected to return an empty string if QNameAwareOMDataSource.getNamespaceURI() returns an empty string (because an element without namespace must not have a prefix)
  - getObject
```
public Object getObject()
```
    Description copied from interface: OMDataSourceExt
    
    Get the object that backs this data source. Application code should in general not call this method directly, but use OMSourcedElement.getObject(Class) instead.
    Data sources that support non destructive read/write should return the object from which the XML is produced. Data sources with destructive read/write should return a non null value only if the backing object has not been consumed yet (even partially).
    
    Specified by:
    
    getObject in interface OMDataSourceExt
    
    Overrides:
    
    getObject in class AbstractOMDataSource
    
    Returns:
    
    the backing object, or null if the data source has no backing object or if the backing object can't be accessed in a safe way
  - copy
```
public OMDataSourceExt copy()
```
    Description copied from interface: OMDataSourceExt
    
    Create a copy of the data source. This method is used by OMInformationItem.clone(OMCloneOptions) when the OMCloneOptions.isCopyOMDataSources() option is enabled. If the data source is immutable and stateless, then it may return a reference to itself instead of creating a new data source instance.
    
    Specified by:
    
    copy in interface OMDataSourceExt
    
    Overrides:
    
    copy in class AbstractOMDataSource
    
    Returns:
    
    the copy of the data source, or null if the data source can't be copied (e.g. because it is destructive)

Class JAXBOMDataSource

Constructor Summary

Method Summary

Methods inherited from class org.apache.axiom.om.ds.AbstractPushOMDataSource

Methods inherited from class org.apache.axiom.om.ds.AbstractOMDataSource

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.axiom.om.OMDataSource

Constructor Detail

JAXBOMDataSource

Method Detail

isDestructiveWrite

serialize

getLocalName

getNamespaceURI

getPrefix

getObject

copy