org.dom4j.io
public class STAXEventWriter extends Object
createXXX
methods are provided to directly create STAX events
from DOM4J nodes.
Constructor Summary | |
---|---|
STAXEventWriter() | |
STAXEventWriter(File file)
Constructs a STAXEventWriter that writes events to the
provided file.
| |
STAXEventWriter(Writer writer)
Constructs a STAXEventWriter that writes events to the
provided character stream.
| |
STAXEventWriter(OutputStream stream)
Constructs a STAXEventWriter that writes events to the
provided stream.
| |
STAXEventWriter(XMLEventConsumer consumer)
Constructs a STAXEventWriter that writes events to the
provided event stream.
|
Method Summary | |
---|---|
Attribute | createAttribute(Attribute attr)
Constructs a STAX javax.xml.stream.events.Attributeevent from a
DOM4J Attribute.
|
Characters | createCharacters(Text text)
Constructs a STAX Charactersevent from a DOM4J Text.
|
Characters | createCharacters(CDATA cdata)
Constructs a STAX Charactersevent from a DOM4J CDATA.
|
Comment | createComment(Comment comment)
Constructs a STAX javax.xml.stream.events.Commentevent from a
DOM4J Comment.
|
DTD | createDTD(DocumentType docType)
Constructs a STAX DTDevent from a DOM4J DocumentType.
|
EndDocument | createEndDocument(Document doc)
Constructs a STAX EndDocumentevent from a DOM4J Document.
|
EndElement | createEndElement(Element elem)
Constructs a STAX EndElementevent from a DOM4J Element.
|
Namespace | createNamespace(Namespace ns)
Constructs a STAX javax.xml.stream.events.Namespaceevent from a
DOM4J Namespace.
|
ProcessingInstruction | createProcessingInstruction(ProcessingInstruction pi)
Constructs a STAX javax.xml.stream.events.ProcessingInstruction
event from a DOM4J ProcessingInstruction.
|
QName | createQName(QName qname)
Constructs a STAX QNamefrom a DOM4J QName.
|
StartDocument | createStartDocument(Document doc)
Constructs a STAX StartDocumentevent from a DOM4J Document.
|
StartElement | createStartElement(Element elem)
Constructs a STAX StartElementevent from a DOM4J Element.
|
XMLEventConsumer | getConsumer()
Returns a reference to the underlying event consumer to which events are
written.
|
XMLEventFactory | getEventFactory()
Returns a reference to the event factory used to construct STAX events.
|
void | setConsumer(XMLEventConsumer consumer)
Sets the underlying event consumer to which events are written.
|
void | setEventFactory(XMLEventFactory eventFactory)
Sets the event factory used to construct STAX events.
|
void | writeAttribute(Attribute attr)
Writes a DOM4J Attributeto the stream.
|
void | writeCDATA(CDATA cdata)
Writes a DOM4J CDATAto the event stream.
|
void | writeChildNodes(Branch branch)
Writes each child node within the provided Branchinstance. |
void | writeComment(Comment comment)
Writes a DOM4J Commentto the stream.
|
void | writeDocument(Document doc)
Writes a DOM4J Documentnode, and all its contents, to the
stream.
|
void | writeDocumentType(DocumentType docType)
Writes a DOM4J DocumentTypeto the stream.
|
void | writeElement(Element elem)
Writes a DOM4J Elementnode and its children to the stream.
|
void | writeEntity(Entity entity)
Writes a DOM4J Entityto the stream.
|
void | writeNamespace(Namespace ns)
Writes a DOM4J Namespaceto the stream.
|
void | writeNode(Node n)
Writes a DOM4J Nodeto the stream. |
void | writeProcessingInstruction(ProcessingInstruction pi)
Writes a DOM4J ProcessingInstructionto the stream.
|
void | writeText(Text text)
Writes a DOM4J Textto the stream.
|
STAXEventWriter
that writes events to the
provided file.
Parameters: file The file to which events will be written.
Throws: XMLStreamException If an error occurs creating an event writer from the file. IOException If an error occurs openin the file for writing.
STAXEventWriter
that writes events to the
provided character stream.
Parameters: writer The character stream to which events will be written.
Throws: XMLStreamException If an error occurs constructing an event writer from the character stream.
STAXEventWriter
that writes events to the
provided stream.
Parameters: stream The output stream to which events will be written.
Throws: XMLStreamException If an error occurs constructing an event writer from the stream.
STAXEventWriter
that writes events to the
provided event stream.
Parameters: consumer The event stream to which events will be written.
Parameters: attr The Attributefrom which to construct the event.
Returns: The newly constructed javax.xml.stream.events.Attribute event.
Parameters: text The Textfrom which to construct the event.
Returns: The constructed Charactersevent.
Parameters: cdata The CDATAfrom which to construct the event.
Returns: The newly constructed Charactersevent.
Parameters: comment The Commentfrom which to construct the event.
Returns: The constructed javax.xml.stream.events.Commentevent.
Parameters: docType The DocumentTypefrom which to construct the event.
Returns: The constructed DTDevent.
Throws: RuntimeException DOCUMENT ME!
Parameters: doc The Documentfrom which to construct the event.
Returns: The constructed EndDocumentevent.
Parameters: elem The Elementfrom which to construct the event.
Returns: The newly constructed EndElementevent.
Parameters: ns The Namespacefrom which to construct the event.
Returns: The constructed javax.xml.stream.events.Namespaceevent.
Parameters: pi The ProcessingInstructionfrom which to construct the event.
Returns: The constructed javax.xml.stream.events.ProcessingInstruction event.
Parameters: qname The QNamefrom which to construct the STAX QName.
Returns: The constructed QName.
Parameters: doc The Documentfrom which to construct the event.
Returns: The constructed StartDocumentevent.
Parameters: elem The Elementfrom which to construct the event.
Returns: The newly constructed StartElementevent.
Returns: The underlying event consumer to which events are written.
Returns: The event factory used to construct STAX events.
Parameters: consumer The event consumer to which events should be written.
Parameters: eventFactory The new event factory.
Parameters: attr The Attributeto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: cdata The CDATAto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: branch The node whose children will be written to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: comment The Commentto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: doc The Documentto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: docType The DocumentTypeto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: elem The Elementnode to write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: entity The Entityto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: ns The Namespaceto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: n The DOM4J Nodeto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: pi The ProcessingInstructionto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.
Parameters: text The Textto write to the stream.
Throws: XMLStreamException If an error occurs writing to the stream.