|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface XMLHelper
A helper to convert XML documents into DataObects and DataObjects into XML documnets.
| Field Summary | |
|---|---|
static XMLHelper |
INSTANCE
The default XMLHelper. |
| Method Summary | |
|---|---|
XMLDocument |
createDocument(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
Creates an XMLDocument with the specified XML rootElement for the DataObject. |
XMLDocument |
load(java.io.InputStream inputStream)
Creates and returns an XMLDocument from the inputStream. |
XMLDocument |
load(java.io.InputStream inputStream,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputStream. |
XMLDocument |
load(java.io.Reader inputReader,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputReader. |
XMLDocument |
load(javax.xml.transform.Source inputSource,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputSource. |
XMLDocument |
load(java.lang.String inputString)
Creates and returns an XMLDocument from the input String. |
java.lang.String |
save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
Returns the DataObject saved as an XML document with the specified root element. |
void |
save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName,
java.io.OutputStream outputStream)
Saves the DataObject as an XML document with the specified root element. |
void |
save(XMLDocument xmlDocument,
java.io.OutputStream outputStream,
java.lang.Object options)
Serializes an XMLDocument as an XML document into the outputStream. |
void |
save(XMLDocument xmlDocument,
javax.xml.transform.Result outputResult,
java.lang.Object options)
Serializes an XMLDocument as an XML document into the outputResult in a serialization technology independent format (as specified in javax.xml.transform). |
void |
save(XMLDocument xmlDocument,
java.io.Writer outputWriter,
java.lang.Object options)
Serializes an XMLDocument as an XML document into the outputWriter. |
| Field Detail |
|---|
static final XMLHelper INSTANCE
| Method Detail |
|---|
XMLDocument load(java.lang.String inputString)
inputString - specifies the String to read from
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
XMLDocument load(java.io.InputStream inputStream)
throws java.io.IOException
inputStream - specifies the InputStream to read from
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
XMLDocument load(java.io.InputStream inputStream,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
inputStream - specifies the InputStream to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
XMLDocument load(java.io.Reader inputReader,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
inputReader - specifies the Reader to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
XMLDocument load(javax.xml.transform.Source inputSource,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
inputSource - specifies the Source to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
java.lang.String save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
dataObject - specifies DataObject to be savedrootElementURI - the Target Namespace URI of the root XML elementrootElementName - the Name of the root XML element
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
void save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName,
java.io.OutputStream outputStream)
throws java.io.IOException
dataObject - specifies DataObject to be savedrootElementURI - the Target Namespace URI of the root XML elementrootElementName - the Name of the root XML elementoutputStream - specifies the OutputStream to write to.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
void save(XMLDocument xmlDocument,
java.io.OutputStream outputStream,
java.lang.Object options)
throws java.io.IOException
xmlDocument - specifies XMLDocument to be savedoutputStream - specifies the OutputStream to write to.options - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
void save(XMLDocument xmlDocument,
java.io.Writer outputWriter,
java.lang.Object options)
throws java.io.IOException
xmlDocument - specifies XMLDocument to be savedoutputWriter - specifies the Writer to write to.options - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
void save(XMLDocument xmlDocument,
javax.xml.transform.Result outputResult,
java.lang.Object options)
throws java.io.IOException
xmlDocument - specifies XMLDocument to be savedoutputResult - specifies Result to be savedoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
XMLDocument createDocument(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
dataObject - specifies DataObject to be savedrootElementURI - the Target Namespace URI of the root XML elementrootElementName - the Name of the root XML element
|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||