|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.dom4j.jaxb.JAXBWriter
public class JAXBWriter
Writes Elementobjects to an XML stream. Element instances can be created using the ObjectFactory that
is generated by the JAXB compiler.
XMLWriter,
JAXBContext| Constructor Summary | |
|---|---|
JAXBWriter(java.lang.String contextPath)
Creates a new JAXBWriter for the given JAXB context path. |
|
JAXBWriter(java.lang.String contextPath,
java.lang.ClassLoader classloader)
Creates a new JAXBWriter for the given JAXB context path, using the specified java.lang.Classloader. |
|
JAXBWriter(java.lang.String contextPath,
java.lang.ClassLoader classloader,
OutputFormat outputFormat)
Creates a new JAXBWriter for the given JAXB context path, using the specified java.lang.Classloader. |
|
JAXBWriter(java.lang.String contextPath,
OutputFormat outputFormat)
Creates a new JAXBWriter for the given JAXB context path. |
|
| Method Summary | |
|---|---|
void |
endDocument()
Stop writing the document to the output. |
OutputFormat |
getOutputFormat()
Returns the OutputFormat that will be used when writing the XML stream. |
protected Element |
marshal(javax.xml.bind.Element element)
Marshals the given Elementin to its DOM4J
counterpart. |
void |
setOutput(java.io.File file)
Defines to write the resulting output to the specified File. |
void |
setOutput(java.io.OutputStream outputStream)
Defines to write the resulting output to the specified OutputStream |
void |
setOutput(java.io.Writer writer)
Defines to write the resulting output to the specified Writer. |
void |
startDocument()
Start a document by writing the initial XML declaration to the output. |
protected javax.xml.bind.Element |
unmarshal(Element element)
Unmarshalls the specified DOM4J Elementinto a Element |
void |
write(javax.xml.bind.Element jaxbObject)
Writes the specified Elementto the document. |
void |
writeClose(javax.xml.bind.Element jaxbObject)
Writes the closing tag of the specified Elementto
the document. |
void |
writeCloseElement(Element element)
Writes the closing tag of the specified Elementto the
document. |
void |
writeElement(Element element)
Writes the specified Elementto the document. |
void |
writeOpen(javax.xml.bind.Element jaxbObject)
Writes the opening tag of the specified Elementto
the document. |
void |
writeOpenElement(Element element)
Writes the opening tag of the specified Elementto the
document. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public JAXBWriter(java.lang.String contextPath)
contextPath - JAXB context path to be usedJAXBContext
public JAXBWriter(java.lang.String contextPath,
OutputFormat outputFormat)
OutputFormatwill be used for writing the XML
stream.
contextPath - JAXB context path to be usedoutputFormat - the DOM4J OutputFormatto be usedJAXBContext
public JAXBWriter(java.lang.String contextPath,
java.lang.ClassLoader classloader)
java.lang.Classloader. (This is the Java package where
JAXB can find the generated XML classes. This package MUST contain
jaxb.properties!)
contextPath - JAXB context path to be usedclassloader - the classloader to be used for loading JAXBJAXBContext
public JAXBWriter(java.lang.String contextPath,
java.lang.ClassLoader classloader,
OutputFormat outputFormat)
java.lang.Classloader. The specied OutputFormat will be used while writing the XML stream.
contextPath - JAXB context path to be usedclassloader - the class loader to be used to load JAXBoutputFormat - the DOM4J OutputFormatto be usedJAXBContext| Method Detail |
|---|
public OutputFormat getOutputFormat()
public void setOutput(java.io.File file)
throws java.io.IOException
File.
file - file to write to
java.io.IOException - when the file cannot be found
public void setOutput(java.io.OutputStream outputStream)
throws java.io.IOException
OutputStream
outputStream - outputStream to write to.
java.io.IOException - DOCUMENT ME!
public void setOutput(java.io.Writer writer)
throws java.io.IOException
Writer.
writer - writer to write to
java.io.IOException
public void startDocument()
throws java.io.IOException,
org.xml.sax.SAXException
java.io.IOException - if an error occured while writing the output
org.xml.sax.SAXException - thrown by the underlying SAX driver
public void endDocument()
throws java.io.IOException,
org.xml.sax.SAXException
java.io.IOException - if an error occured while writing the output
org.xml.sax.SAXException - thrown by the underlying SAX driver
public void write(javax.xml.bind.Element jaxbObject)
throws java.io.IOException,
javax.xml.bind.JAXBException
Elementto the document.
Elementinstances can be created using the
ObjectFactory that is generated by the JAXB compiler.
jaxbObject -
java.io.IOException - if an error occured while writing the output
javax.xml.bind.JAXBException - when an error occured while marshalling the jaxbObject
public void writeClose(javax.xml.bind.Element jaxbObject)
throws java.io.IOException,
javax.xml.bind.JAXBException
Elementto
the document. This method can be used for writing Element instances can be created using the ObjectFactory
that is generated by the JAXB compiler.
jaxbObject - the JAXB element to write
java.io.IOException - if an error occured while writing the output
javax.xml.bind.JAXBException - when an error occured while marshalling the jaxbObject
public void writeOpen(javax.xml.bind.Element jaxbObject)
throws java.io.IOException,
javax.xml.bind.JAXBException
Elementto
the document. Elementinstances can be created
using the ObjectFactory that is generated by the JAXB compiler.
jaxbObject - the JAXB element to write
java.io.IOException - if an error occured while writing the output
javax.xml.bind.JAXBException - when an error occured while marshalling the jaxbObject
public void writeElement(Element element)
throws java.io.IOException
Elementto the document.
element - the Elementto write
java.io.IOException - if an error occured while writing the output
public void writeCloseElement(Element element)
throws java.io.IOException
Elementto the
document.
element - the Elementto write
java.io.IOException - if an error occured while writing the output
public void writeOpenElement(Element element)
throws java.io.IOException
Elementto the
document.
element - the Elementto write
java.io.IOException - if an error occured while writing the output
protected Element marshal(javax.xml.bind.Element element)
throws javax.xml.bind.JAXBException
Elementin to its DOM4J
counterpart.
element - JAXB Element to be marshalled
Element
javax.xml.bind.JAXBException - when an error occurs
protected javax.xml.bind.Element unmarshal(Element element)
throws javax.xml.bind.JAXBException
Elementinto a Element
element - the DOM4J element to unmarshall
javax.xml.bind.JAXBException - when an error occurs
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||