|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.dom4j.io.STAXEventWriter
Writes DOM4J Node
s to a StAX event stream. In addition the
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(OutputStream stream)
Constructs a STAXEventWriter that writes events to the
provided stream. |
|
STAXEventWriter(Writer writer)
Constructs a STAXEventWriter that writes events to the
provided character stream. |
|
STAXEventWriter(javax.xml.stream.util.XMLEventConsumer consumer)
Constructs a STAXEventWriter that writes events to the
provided event stream. |
Method Summary | |
javax.xml.stream.events.Attribute |
createAttribute(Attribute attr)
Constructs a STAX Attribute event from a
DOM4J Attribute . |
javax.xml.stream.events.Characters |
createCharacters(CDATA cdata)
Constructs a STAX Characters event from a DOM4J CDATA . |
javax.xml.stream.events.Characters |
createCharacters(Text text)
Constructs a STAX Characters event from a DOM4J Text . |
javax.xml.stream.events.Comment |
createComment(Comment comment)
Constructs a STAX Comment event from a
DOM4J Comment . |
javax.xml.stream.events.DTD |
createDTD(DocumentType docType)
Constructs a STAX DTD event from a DOM4J DocumentType . |
javax.xml.stream.events.EndDocument |
createEndDocument(Document doc)
Constructs a STAX EndDocument event from a DOM4J Document . |
javax.xml.stream.events.EndElement |
createEndElement(Element elem)
Constructs a STAX EndElement event from a DOM4J Element . |
javax.xml.stream.events.Namespace |
createNamespace(Namespace ns)
Constructs a STAX Namespace event from a
DOM4J Namespace . |
javax.xml.stream.events.ProcessingInstruction |
createProcessingInstruction(ProcessingInstruction pi)
Constructs a STAX ProcessingInstruction
event from a DOM4J ProcessingInstruction . |
javax.xml.namespace.QName |
createQName(QName qname)
Constructs a STAX QName from a DOM4J QName . |
javax.xml.stream.events.StartDocument |
createStartDocument(Document doc)
Constructs a STAX StartDocument event from a DOM4J Document . |
javax.xml.stream.events.StartElement |
createStartElement(Element elem)
Constructs a STAX StartElement event from a DOM4J Element . |
javax.xml.stream.util.XMLEventConsumer |
getConsumer()
Returns a reference to the underlying event consumer to which events are written. |
javax.xml.stream.XMLEventFactory |
getEventFactory()
Returns a reference to the event factory used to construct STAX events. |
void |
setConsumer(javax.xml.stream.util.XMLEventConsumer consumer)
Sets the underlying event consumer to which events are written. |
void |
setEventFactory(javax.xml.stream.XMLEventFactory eventFactory)
Sets the event factory used to construct STAX events. |
void |
writeAttribute(Attribute attr)
Writes a DOM4J Attribute to the stream. |
void |
writeCDATA(CDATA cdata)
Writes a DOM4J CDATA to the event stream. |
void |
writeChildNodes(Branch branch)
Writes each child node within the provided Branch instance. |
void |
writeComment(Comment comment)
Writes a DOM4J Comment to the stream. |
void |
writeDocument(Document doc)
Writes a DOM4J Document node, and all its contents, to the
stream. |
void |
writeDocumentType(DocumentType docType)
Writes a DOM4J DocumentType to the stream. |
void |
writeElement(Element elem)
Writes a DOM4J Element node and its children to the stream. |
void |
writeEntity(Entity entity)
Writes a DOM4J Entity to the stream. |
void |
writeNamespace(Namespace ns)
Writes a DOM4J Namespace to the stream. |
void |
writeNode(Node n)
Writes a DOM4J Node to the stream. |
void |
writeProcessingInstruction(ProcessingInstruction pi)
Writes a DOM4J ProcessingInstruction to the stream. |
void |
writeText(Text text)
Writes a DOM4J Text to the stream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public STAXEventWriter()
public STAXEventWriter(File file) throws javax.xml.stream.XMLStreamException, IOException
STAXEventWriter
that writes events to the
provided file.
file
- The file to which events will be written.
javax.xml.stream.XMLStreamException
- If an error occurs creating an event writer from the file.
IOException
- If an error occurs openin the file for writing.public STAXEventWriter(Writer writer) throws javax.xml.stream.XMLStreamException
STAXEventWriter
that writes events to the
provided character stream.
writer
- The character stream to which events will be written.
javax.xml.stream.XMLStreamException
- If an error occurs constructing an event writer from the
character stream.public STAXEventWriter(OutputStream stream) throws javax.xml.stream.XMLStreamException
STAXEventWriter
that writes events to the
provided stream.
stream
- The output stream to which events will be written.
javax.xml.stream.XMLStreamException
- If an error occurs constructing an event writer from the
stream.public STAXEventWriter(javax.xml.stream.util.XMLEventConsumer consumer)
STAXEventWriter
that writes events to the
provided event stream.
consumer
- The event stream to which events will be written.Method Detail |
public javax.xml.stream.util.XMLEventConsumer getConsumer()
public void setConsumer(javax.xml.stream.util.XMLEventConsumer consumer)
consumer
- The event consumer to which events should be written.public javax.xml.stream.XMLEventFactory getEventFactory()
public void setEventFactory(javax.xml.stream.XMLEventFactory eventFactory)
eventFactory
- The new event factory.public void writeNode(Node n) throws javax.xml.stream.XMLStreamException
Node
to the stream. This method is simply a
gateway to the overloaded methods such as .
n
- The DOM4J Node
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public void writeChildNodes(Branch branch) throws javax.xml.stream.XMLStreamException
Branch
instance. This
method simply iterates through the Branch
's nodes and calls
writeNode(Node)
.
branch
- The node whose children will be written to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public void writeElement(Element elem) throws javax.xml.stream.XMLStreamException
Element
node and its children to the stream.
elem
- The Element
node to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.StartElement createStartElement(Element elem)
StartElement
event from a DOM4J Element
.
elem
- The Element
from which to construct the event.
StartElement
event.public javax.xml.stream.events.EndElement createEndElement(Element elem)
EndElement
event from a DOM4J Element
.
elem
- The Element
from which to construct the event.
EndElement
event.public void writeAttribute(Attribute attr) throws javax.xml.stream.XMLStreamException
Attribute
to the stream.
attr
- The Attribute
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.Attribute createAttribute(Attribute attr)
Attribute
event from a
DOM4J Attribute
.
attr
- The Attribute
from which to construct the event.
Attribute
event.public void writeNamespace(Namespace ns) throws javax.xml.stream.XMLStreamException
Namespace
to the stream.
ns
- The Namespace
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.Namespace createNamespace(Namespace ns)
Namespace
event from a
DOM4J Namespace
.
ns
- The Namespace
from which to construct the event.
Namespace
event.public void writeText(Text text) throws javax.xml.stream.XMLStreamException
Text
to the stream.
text
- The Text
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.Characters createCharacters(Text text)
Characters
event from a DOM4J Text
.
text
- The Text
from which to construct the event.
Characters
event.public void writeCDATA(CDATA cdata) throws javax.xml.stream.XMLStreamException
CDATA
to the event stream.
cdata
- The CDATA
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.Characters createCharacters(CDATA cdata)
Characters
event from a DOM4J CDATA
.
cdata
- The CDATA
from which to construct the event.
Characters
event.public void writeComment(Comment comment) throws javax.xml.stream.XMLStreamException
Comment
to the stream.
comment
- The Comment
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.Comment createComment(Comment comment)
Comment
event from a
DOM4J Comment
.
comment
- The Comment
from which to construct the event.
Comment
event.public void writeProcessingInstruction(ProcessingInstruction pi) throws javax.xml.stream.XMLStreamException
ProcessingInstruction
to the stream.
pi
- The ProcessingInstruction
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.ProcessingInstruction createProcessingInstruction(ProcessingInstruction pi)
ProcessingInstruction
event from a DOM4J ProcessingInstruction
.
pi
- The ProcessingInstruction
from which to construct the
event.
ProcessingInstruction
event.public void writeEntity(Entity entity) throws javax.xml.stream.XMLStreamException
Entity
to the stream.
entity
- The Entity
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public void writeDocumentType(DocumentType docType) throws javax.xml.stream.XMLStreamException
DocumentType
to the stream.
docType
- The DocumentType
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.DTD createDTD(DocumentType docType)
DTD
event from a DOM4J DocumentType
.
docType
- The DocumentType
from which to construct the event.
DTD
event.
RuntimeException
- DOCUMENT ME!public void writeDocument(Document doc) throws javax.xml.stream.XMLStreamException
Document
node, and all its contents, to the
stream.
doc
- The Document
to write to the stream.
javax.xml.stream.XMLStreamException
- If an error occurs writing to the stream.public javax.xml.stream.events.StartDocument createStartDocument(Document doc)
StartDocument
event from a DOM4J Document
.
doc
- The Document
from which to construct the event.
StartDocument
event.public javax.xml.stream.events.EndDocument createEndDocument(Document doc)
EndDocument
event from a DOM4J Document
.
doc
- The Document
from which to construct the event.
EndDocument
event.public javax.xml.namespace.QName createQName(QName qname)
QName
from a DOM4J QName
.
qname
- The QName
from which to construct the STAX
QName
.
QName
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |