org.apache.tuscany.sdo.helper
Class XMLStreamHelperImpl

java.lang.Object
  extended by org.apache.tuscany.sdo.helper.XMLStreamHelperImpl
All Implemented Interfaces:
XMLStreamHelper

public class XMLStreamHelperImpl
extends Object
implements XMLStreamHelper


Field Summary
protected  HelperContext helperContext
           
 
Fields inherited from interface org.apache.tuscany.sdo.api.XMLStreamHelper
OPTION_DEFAULT_ROOT_TYPE
 
Constructor Summary
XMLStreamHelperImpl(HelperContext hc)
           
 
Method Summary
 javax.xml.stream.XMLStreamReader createXMLStreamReader(DataObject dataObject)
          Creates and returns a XMLStreamReader that can be used to read a DataObject as a XML event stream.
 javax.xml.stream.XMLStreamReader createXMLStreamReader(XMLDocument document)
          Creates and returns a XMLStreamReader that can be used to read an XMLDocument as a XML event stream.
 HelperContext getHelperContext()
           
 XMLDocument load(javax.xml.stream.XMLStreamReader reader)
          Creates and returns an XMLDocument from an XML input stream.
protected  XMLDocument loadDocument(javax.xml.stream.XMLStreamReader reader, Map options)
           
 DataObject loadObject(javax.xml.stream.XMLStreamReader reader)
          Create a DataObject from an element in a XML stream.
 DataObject loadObject(javax.xml.stream.XMLStreamReader reader, Map options)
          Create a DataObject from an element in a XML stream.
 void save(XMLDocument document, javax.xml.stream.XMLStreamWriter writer)
          Save a XMLDocument to an XML stream.
 void save(XMLDocument document, javax.xml.stream.XMLStreamWriter writer, Map options)
           
 void saveObject(DataObject sdo, javax.xml.stream.XMLStreamWriter writer)
          Save a DataObject to an XML stream.
 void saveObject(DataObject sdo, javax.xml.stream.XMLStreamWriter writer, Map options)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

helperContext

protected HelperContext helperContext
Constructor Detail

XMLStreamHelperImpl

public XMLStreamHelperImpl(HelperContext hc)
Method Detail

load

public XMLDocument load(javax.xml.stream.XMLStreamReader reader)
                 throws javax.xml.stream.XMLStreamException,
                        IllegalStateException
Description copied from interface: XMLStreamHelper
Creates and returns an XMLDocument from an XML input stream. The reader must be positioned on a START_DOCUMENT event.

Specified by:
load in interface XMLStreamHelper
Parameters:
reader - the stream to read
Returns:
an XMLDocument created from the stream
Throws:
javax.xml.stream.XMLStreamException - if there was a problem reading the stream
IllegalStateException - if the reader is not positioned on a START_DOCUMENT event

save

public void save(XMLDocument document,
                 javax.xml.stream.XMLStreamWriter writer)
          throws javax.xml.stream.XMLStreamException
Description copied from interface: XMLStreamHelper
Save a XMLDocument to an XML stream.

Specified by:
save in interface XMLStreamHelper
Parameters:
document - the document to be written
writer - the stream to write to
Throws:
javax.xml.stream.XMLStreamException - if there was a problem writing to the stream

save

public void save(XMLDocument document,
                 javax.xml.stream.XMLStreamWriter writer,
                 Map options)
          throws javax.xml.stream.XMLStreamException
Specified by:
save in interface XMLStreamHelper
Throws:
javax.xml.stream.XMLStreamException

createXMLStreamReader

public javax.xml.stream.XMLStreamReader createXMLStreamReader(XMLDocument document)
                                                       throws javax.xml.stream.XMLStreamException
Description copied from interface: XMLStreamHelper
Creates and returns a XMLStreamReader that can be used to read an XMLDocument as a XML event stream. The reader will be positioned on a START_DOCUMENT event.

Specified by:
createXMLStreamReader in interface XMLStreamHelper
Parameters:
document - the XMLDocument to be read
Returns:
an XMLStreamReader that can be used to read the document
Throws:
javax.xml.stream.XMLStreamException

loadObject

public final DataObject loadObject(javax.xml.stream.XMLStreamReader reader,
                                   Map options)
                            throws javax.xml.stream.XMLStreamException,
                                   IllegalStateException
Description copied from interface: XMLStreamHelper
Create a DataObject from an element in a XML stream. The reader must be positioned on a START_ELEMENT event.

Specified by:
loadObject in interface XMLStreamHelper
Parameters:
reader - the stream to read
options - OPTION_DEFAULT_ROOT_TYPE; can be null or empty
Returns:
a DataObject created from the element in the stream
Throws:
javax.xml.stream.XMLStreamException - if there was a problem reading the stream
IllegalStateException - if the reader is not positioned on a START_ELEMENT event

loadObject

public DataObject loadObject(javax.xml.stream.XMLStreamReader reader)
                      throws javax.xml.stream.XMLStreamException,
                             IllegalStateException
Description copied from interface: XMLStreamHelper
Create a DataObject from an element in a XML stream. The reader must be positioned on a START_ELEMENT event.

Specified by:
loadObject in interface XMLStreamHelper
Parameters:
reader - the stream to read
Returns:
a DataObject created from the element in the stream
Throws:
javax.xml.stream.XMLStreamException - if there was a problem reading the stream
IllegalStateException - if the reader is not positioned on a START_ELEMENT event

saveObject

public void saveObject(DataObject sdo,
                       javax.xml.stream.XMLStreamWriter writer)
                throws javax.xml.stream.XMLStreamException
Description copied from interface: XMLStreamHelper
Save a DataObject to an XML stream.

Specified by:
saveObject in interface XMLStreamHelper
Parameters:
sdo - the DataObject to be written
writer - the stream to write to
Throws:
javax.xml.stream.XMLStreamException - if there was a problem writing to the stream

saveObject

public void saveObject(DataObject sdo,
                       javax.xml.stream.XMLStreamWriter writer,
                       Map options)
                throws javax.xml.stream.XMLStreamException
Specified by:
saveObject in interface XMLStreamHelper
Throws:
javax.xml.stream.XMLStreamException

createXMLStreamReader

public javax.xml.stream.XMLStreamReader createXMLStreamReader(DataObject dataObject)
Description copied from interface: XMLStreamHelper
Creates and returns a XMLStreamReader that can be used to read a DataObject as a XML event stream. The reader will be positioned on a START_ELEMENT event.

Specified by:
createXMLStreamReader in interface XMLStreamHelper
Parameters:
dataObject - the DataObject to be read
Returns:
an XMLStreamReader that can be used to read the DataObject

loadDocument

protected XMLDocument loadDocument(javax.xml.stream.XMLStreamReader reader,
                                   Map options)
                            throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

getHelperContext

public HelperContext getHelperContext()
Specified by:
getHelperContext in interface XMLStreamHelper


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.