Modifier and Type	Class and Description
private class	STAXEventWriter.AttributeIterator Internal `Iterator`implementation used to pass DOM4J `Attribute`s to the stream.
private class	STAXEventWriter.NamespaceIterator Internal `Iterator`implementation used to pass DOM4J `Namespace`s to the stream.

Modifier and Type	Field and Description
private XMLEventConsumer	consumer The event stream to which events are written.
private XMLEventFactory	factory The event factory used to construct events.
private XMLOutputFactory	outputFactory

Access	Constructor and Description
public	STAXEventWriter()
public	STAXEventWriter(File The file to which events will be written. file) Constructs a `STAXEventWriter` that writes events to the provided file.
public	STAXEventWriter(Writer The character stream to which events will be written. writer) Constructs a `STAXEventWriter` that writes events to the provided character stream.
public	STAXEventWriter(OutputStream The output stream to which events will be written. stream) Constructs a `STAXEventWriter` that writes events to the provided stream.
public	STAXEventWriter(XMLEventConsumer The event stream to which events will be written. consumer) Constructs a `STAXEventWriter` that writes events to the provided event stream.

Method Summary

Modifier and Type	Method and Description
public Attribute	Returns: The newly constructed `javax.xml.stream.events.Attribute` event. createAttribute(Attribute The `Attribute`from which to construct the event. attr) Constructs a STAX `javax.xml.stream.events.Attribute`event from a DOM4J `Attribute`.
public Characters	Returns: The constructed `Characters`event. createCharacters(Text The `Text`from which to construct the event. text) Constructs a STAX `Characters`event from a DOM4J `Text`.
public Characters	Returns: The newly constructed `Characters`event. createCharacters(CDATA The `CDATA`from which to construct the event. cdata) Constructs a STAX `Characters`event from a DOM4J `CDATA`.
public Comment	Returns: The constructed `javax.xml.stream.events.Comment`event. createComment(Comment The `Comment`from which to construct the event. comment) Constructs a STAX `javax.xml.stream.events.Comment`event from a DOM4J `Comment`.
public DTD	Returns: The constructed `DTD`event. createDTD(DocumentType The `DocumentType`from which to construct the event. docType) Constructs a STAX `DTD`event from a DOM4J `DocumentType`.
public EndDocument	Returns: The constructed `EndDocument`event. createEndDocument(Document The `Document`from which to construct the event. doc) Constructs a STAX `EndDocument`event from a DOM4J `Document`.
public EndElement	Returns: The newly constructed `EndElement`event. createEndElement(Element The `Element`from which to construct the event. elem) Constructs a STAX `EndElement`event from a DOM4J `Element`.
private EntityReference	Returns: The constructed `EntityReference`event. createEntityReference(Entity The `Entity`from which to construct the event. entity) Constructs a STAX `EntityReference`event from a DOM4J `Entity`.
public Namespace	Returns: The constructed `javax.xml.stream.events.Namespace`event. createNamespace(Namespace The `Namespace`from which to construct the event. ns) Constructs a STAX `javax.xml.stream.events.Namespace`event from a DOM4J `Namespace`.
public ProcessingInstruction	Returns: The constructed `javax.xml.stream.events.ProcessingInstruction` event. createProcessingInstruction(ProcessingInstruction The `ProcessingInstruction`from which to construct the event. pi) Constructs a STAX `javax.xml.stream.events.ProcessingInstruction` event from a DOM4J `ProcessingInstruction`.
public QName	Returns: The constructed `QName`. createQName(QName The `org.dom4j.QName`from which to construct the STAX `QName`. qname) Constructs a STAX `QName`from a DOM4J `org.dom4j.QName`.
public StartDocument	Returns: The constructed `StartDocument`event. createStartDocument(Document The `Document`from which to construct the event. doc) Constructs a STAX `StartDocument`event from a DOM4J `Document`.
public StartElement	Returns: The newly constructed `StartElement`event. createStartElement(Element The `Element`from which to construct the event. elem) Constructs a STAX `StartElement`event from a DOM4J `Element`.
public XMLEventConsumer	Returns: The underlying event consumer to which events are written. getConsumer() Returns a reference to the underlying event consumer to which events are written.
public XMLEventFactory	Returns: The event factory used to construct STAX events. getEventFactory() Returns a reference to the event factory used to construct STAX events.
public void	setConsumer(XMLEventConsumer The event consumer to which events should be written. consumer) Sets the underlying event consumer to which events are written.
public void	setEventFactory(XMLEventFactory The new event factory. eventFactory) Sets the event factory used to construct STAX events.
public void	writeAttribute(Attribute The `Attribute`to write to the stream. attr) Writes a DOM4J `Attribute`to the stream.
public void	writeCDATA(CDATA The `CDATA`to write to the stream. cdata) Writes a DOM4J `CDATA`to the event stream.
public void	writeChildNodes(Branch The node whose children will be written to the stream. branch) Writes each child node within the provided `Branch`instance.
public void	writeComment(Comment The `Comment`to write to the stream. comment) Writes a DOM4J `Comment`to the stream.
public void	writeDocument(Document The `Document`to write to the stream. doc) Writes a DOM4J `Document`node, and all its contents, to the stream.
public void	writeDocumentType(DocumentType The `DocumentType`to write to the stream. docType) Writes a DOM4J `DocumentType`to the stream.
public void	writeElement(Element The `Element`node to write to the stream. elem) Writes a DOM4J `Element`node and its children to the stream.
public void	writeEntity(Entity The `Entity`to write to the stream. entity) Writes a DOM4J `Entity`to the stream.
public void	writeNamespace(Namespace The `Namespace`to write to the stream. ns) Writes a DOM4J `Namespace`to the stream.
public void	writeNode(Node The DOM4J `Node`to write to the stream. n) Writes a DOM4J `Node`to the stream.
public void	writeProcessingInstruction(ProcessingInstruction The `ProcessingInstruction`to write to the stream. pi) Writes a DOM4J `ProcessingInstruction`to the stream.
public void	writeText(Text The `Text`to write to the stream. text) Writes a DOM4J `Text`to the stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

consumer	back to summary
private XMLEventConsumer consumer The event stream to which events are written.

factory	back to summary
private XMLEventFactory factory The event factory used to construct events.

outputFactory	back to summary
private XMLOutputFactory outputFactory

Constructor Detail

STAXEventWriter	back to summary
public STAXEventWriter()

STAXEventWriter back to summary

STAXEventWriter	back to summary
public STAXEventWriter(File file) throws XMLStreamException, IOException Constructs a `STAXEventWriter` that writes events to the provided file. Parameters file:File The file to which events will be written. Exceptions XMLStreamException: If an error occurs creating an event writer from the file. IOException: If an error occurs openin the file for writing.

public STAXEventWriter(File file) throws XMLStreamException, IOException

Constructs a STAXEventWriter that writes events to the provided file.

Parameters

file:File: The file to which events will be written.

Exceptions

XMLStreamException:: If an error occurs creating an event writer from the file.
IOException:: If an error occurs openin the file for writing.

STAXEventWriter back to summary

STAXEventWriter	back to summary
public STAXEventWriter(Writer writer) throws XMLStreamException Constructs a `STAXEventWriter` that writes events to the provided character stream. Parameters writer:Writer The character stream to which events will be written. Exceptions XMLStreamException: If an error occurs constructing an event writer from the character stream.

public STAXEventWriter(Writer writer) throws XMLStreamException

Constructs a STAXEventWriter that writes events to the provided character stream.

Parameters

writer:Writer: The character stream to which events will be written.

Exceptions

XMLStreamException:: If an error occurs constructing an event writer from the character stream.

STAXEventWriter back to summary

STAXEventWriter	back to summary
public STAXEventWriter(OutputStream stream) throws XMLStreamException Constructs a `STAXEventWriter` that writes events to the provided stream. Parameters stream:OutputStream The output stream to which events will be written. Exceptions XMLStreamException: If an error occurs constructing an event writer from the stream.

public STAXEventWriter(OutputStream stream) throws XMLStreamException

Constructs a STAXEventWriter that writes events to the provided stream.

Parameters

stream:OutputStream: The output stream to which events will be written.

Exceptions

XMLStreamException:: If an error occurs constructing an event writer from the stream.

STAXEventWriter back to summary

STAXEventWriter	back to summary
public STAXEventWriter(XMLEventConsumer consumer) Constructs a `STAXEventWriter` that writes events to the provided event stream. Parameters consumer:XMLEventConsumer The event stream to which events will be written.

public STAXEventWriter(XMLEventConsumer consumer)

Constructs a STAXEventWriter that writes events to the provided event stream.

Parameters

consumer:XMLEventConsumer: The event stream to which events will be written.

Method Detail

createAttribute back to summary

createAttribute	back to summary
public Attribute createAttribute(Attribute attr) Constructs a STAX `javax.xml.stream.events.Attribute`event from a DOM4J `Attribute`. Parameters attr:Attribute The `Attribute`from which to construct the event. Returns:Attribute The newly constructed `javax.xml.stream.events.Attribute` event.

public Attribute createAttribute(Attribute attr)

Constructs a STAX javax.xml.stream.events.Attributeevent from a DOM4J Attribute.

Parameters

attr:Attribute: The Attributefrom which to construct the event.

Returns:Attribute

The newly constructed javax.xml.stream.events.Attribute event.

createCharacters back to summary

createCharacters	back to summary
public Characters createCharacters(Text text) Constructs a STAX `Characters`event from a DOM4J `Text`. Parameters text:Text The `Text`from which to construct the event. Returns:Characters The constructed `Characters`event.

public Characters createCharacters(Text text)

Constructs a STAX Charactersevent from a DOM4J Text.

Parameters

text:Text: The Textfrom which to construct the event.

Returns:Characters

The constructed Charactersevent.

createCharacters back to summary

createCharacters	back to summary
public Characters createCharacters(CDATA cdata) Constructs a STAX `Characters`event from a DOM4J `CDATA`. Parameters cdata:CDATA The `CDATA`from which to construct the event. Returns:Characters The newly constructed `Characters`event.

public Characters createCharacters(CDATA cdata)

Constructs a STAX Charactersevent from a DOM4J CDATA.

Parameters

cdata:CDATA: The CDATAfrom which to construct the event.

Returns:Characters

The newly constructed Charactersevent.

createComment back to summary

createComment	back to summary
public Comment createComment(Comment comment) Constructs a STAX `javax.xml.stream.events.Comment`event from a DOM4J `Comment`. Parameters comment:Comment The `Comment`from which to construct the event. Returns:Comment The constructed `javax.xml.stream.events.Comment`event.

public Comment createComment(Comment comment)

Constructs a STAX javax.xml.stream.events.Commentevent from a DOM4J Comment.

Parameters

comment:Comment: The Commentfrom which to construct the event.

Returns:Comment

The constructed javax.xml.stream.events.Commentevent.

createDTD back to summary

createDTD	back to summary
public DTD createDTD(DocumentType docType) Constructs a STAX `DTD`event from a DOM4J `DocumentType`. Parameters docType:DocumentType The `DocumentType`from which to construct the event. Returns:DTD The constructed `DTD`event. Exceptions RuntimeException: DOCUMENT ME!

public DTD createDTD(DocumentType docType)

Constructs a STAX DTDevent from a DOM4J DocumentType.

Parameters

docType:DocumentType: The DocumentTypefrom which to construct the event.

Returns:DTD

The constructed DTDevent.

Exceptions

RuntimeException:: DOCUMENT ME!

createEndDocument back to summary

createEndDocument	back to summary
public EndDocument createEndDocument(Document doc) Constructs a STAX `EndDocument`event from a DOM4J `Document`. Parameters doc:Document The `Document`from which to construct the event. Returns:EndDocument The constructed `EndDocument`event.

public EndDocument createEndDocument(Document doc)

Constructs a STAX EndDocumentevent from a DOM4J Document.

Parameters

doc:Document: The Documentfrom which to construct the event.

Returns:EndDocument

The constructed EndDocumentevent.

createEndElement back to summary

createEndElement	back to summary
public EndElement createEndElement(Element elem) Constructs a STAX `EndElement`event from a DOM4J `Element`. Parameters elem:Element The `Element`from which to construct the event. Returns:EndElement The newly constructed `EndElement`event.

public EndElement createEndElement(Element elem)

Constructs a STAX EndElementevent from a DOM4J Element.

Parameters

elem:Element: The Elementfrom which to construct the event.

Returns:EndElement

The newly constructed EndElementevent.

createEntityReference back to summary

createEntityReference	back to summary
private EntityReference createEntityReference(Entity entity) Constructs a STAX `EntityReference`event from a DOM4J `Entity`. Parameters entity:Entity The `Entity`from which to construct the event. Returns:EntityReference The constructed `EntityReference`event.

private EntityReference createEntityReference(Entity entity)

Constructs a STAX EntityReferenceevent from a DOM4J Entity.

Parameters

entity:Entity: The Entityfrom which to construct the event.

Returns:EntityReference

The constructed EntityReferenceevent.

createNamespace back to summary

createNamespace	back to summary
public Namespace createNamespace(Namespace ns) Constructs a STAX `javax.xml.stream.events.Namespace`event from a DOM4J `Namespace`. Parameters ns:Namespace The `Namespace`from which to construct the event. Returns:Namespace The constructed `javax.xml.stream.events.Namespace`event.

public Namespace createNamespace(Namespace ns)

Constructs a STAX javax.xml.stream.events.Namespaceevent from a DOM4J Namespace.

Parameters

ns:Namespace: The Namespacefrom which to construct the event.

Returns:Namespace

The constructed javax.xml.stream.events.Namespaceevent.

createProcessingInstruction back to summary

createProcessingInstruction	back to summary
public ProcessingInstruction createProcessingInstruction(ProcessingInstruction pi) Constructs a STAX `javax.xml.stream.events.ProcessingInstruction` event from a DOM4J `ProcessingInstruction`. Parameters pi:ProcessingInstruction The `ProcessingInstruction`from which to construct the event. Returns:ProcessingInstruction The constructed `javax.xml.stream.events.ProcessingInstruction` event.

public ProcessingInstruction createProcessingInstruction(ProcessingInstruction pi)

Constructs a STAX javax.xml.stream.events.ProcessingInstruction event from a DOM4J ProcessingInstruction.

Parameters

pi:ProcessingInstruction: The ProcessingInstructionfrom which to construct the event.

Returns:ProcessingInstruction

The constructed javax.xml.stream.events.ProcessingInstruction event.

createQName back to summary

createQName	back to summary
public QName createQName(QName qname) Constructs a STAX `QName`from a DOM4J `org.dom4j.QName`. Parameters qname:QName The `org.dom4j.QName`from which to construct the STAX `QName`. Returns:QName The constructed `QName`.

public QName createQName(QName qname)

Constructs a STAX QNamefrom a DOM4J org.dom4j.QName.

Parameters

qname:QName: The org.dom4j.QNamefrom which to construct the STAX QName.

Returns:QName

The constructed QName.

createStartDocument back to summary

createStartDocument	back to summary
public StartDocument createStartDocument(Document doc) Constructs a STAX `StartDocument`event from a DOM4J `Document`. Parameters doc:Document The `Document`from which to construct the event. Returns:StartDocument The constructed `StartDocument`event.

public StartDocument createStartDocument(Document doc)

Constructs a STAX StartDocumentevent from a DOM4J Document.

Parameters

doc:Document: The Documentfrom which to construct the event.

Returns:StartDocument

The constructed StartDocumentevent.

createStartElement back to summary

createStartElement	back to summary
public StartElement createStartElement(Element elem) Constructs a STAX `StartElement`event from a DOM4J `Element`. Parameters elem:Element The `Element`from which to construct the event. Returns:StartElement The newly constructed `StartElement`event.

public StartElement createStartElement(Element elem)

Constructs a STAX StartElementevent from a DOM4J Element.

Parameters

elem:Element: The Elementfrom which to construct the event.

Returns:StartElement

The newly constructed StartElementevent.

getConsumer	back to summary
public XMLEventConsumer getConsumer() Returns a reference to the underlying event consumer to which events are written. Returns:XMLEventConsumer The underlying event consumer to which events are written.

getConsumer

back to summary

public XMLEventConsumer getConsumer()

Returns a reference to the underlying event consumer to which events are written.

Returns:XMLEventConsumer: The underlying event consumer to which events are written.

getEventFactory	back to summary
public XMLEventFactory getEventFactory() Returns a reference to the event factory used to construct STAX events. Returns:XMLEventFactory The event factory used to construct STAX events.

getEventFactory

back to summary

public XMLEventFactory getEventFactory()

Returns a reference to the event factory used to construct STAX events.

Returns:XMLEventFactory: The event factory used to construct STAX events.

setConsumer	back to summary
public void setConsumer(XMLEventConsumer consumer) Sets the underlying event consumer to which events are written. Parameters consumer:XMLEventConsumer The event consumer to which events should be written.

setConsumer

back to summary

public void setConsumer(XMLEventConsumer consumer)

Sets the underlying event consumer to which events are written.

Parameters

consumer:XMLEventConsumer: The event consumer to which events should be written.

setEventFactory	back to summary
public void setEventFactory(XMLEventFactory eventFactory) Sets the event factory used to construct STAX events. Parameters eventFactory:XMLEventFactory The new event factory.

setEventFactory

back to summary

public void setEventFactory(XMLEventFactory eventFactory)

Sets the event factory used to construct STAX events.

Parameters

eventFactory:XMLEventFactory: The new event factory.

writeAttribute back to summary

writeAttribute	back to summary
public void writeAttribute(Attribute attr) throws XMLStreamException Writes a DOM4J `Attribute`to the stream. Parameters attr:Attribute The `Attribute`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeAttribute(Attribute attr) throws XMLStreamException

Writes a DOM4J Attributeto the stream.

Parameters

attr:Attribute: The Attributeto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeCDATA back to summary

writeCDATA	back to summary
public void writeCDATA(CDATA cdata) throws XMLStreamException Writes a DOM4J `CDATA`to the event stream. Parameters cdata:CDATA The `CDATA`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeCDATA(CDATA cdata) throws XMLStreamException

Writes a DOM4J CDATAto the event stream.

Parameters

cdata:CDATA: The CDATAto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeChildNodes back to summary

writeChildNodes	back to summary
public void writeChildNodes(Branch branch) throws XMLStreamException Writes each child node within the provided `Branch`instance. This method simply iterates through the `Branch`'s nodes and calls `writeNode(Node)`. Parameters branch:Branch The node whose children will be written to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeChildNodes(Branch branch) throws XMLStreamException

Writes each child node within the provided Branchinstance. This method simply iterates through the Branch's nodes and calls writeNode(Node).

Parameters

branch:Branch: The node whose children will be written to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeComment back to summary

writeComment	back to summary
public void writeComment(Comment comment) throws XMLStreamException Writes a DOM4J `Comment`to the stream. Parameters comment:Comment The `Comment`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeComment(Comment comment) throws XMLStreamException

Writes a DOM4J Commentto the stream.

Parameters

comment:Comment: The Commentto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeDocument back to summary

writeDocument	back to summary
public void writeDocument(Document doc) throws XMLStreamException Writes a DOM4J `Document`node, and all its contents, to the stream. Parameters doc:Document The `Document`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeDocument(Document doc) throws XMLStreamException

Writes a DOM4J Documentnode, and all its contents, to the stream.

Parameters

doc:Document: The Documentto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeDocumentType back to summary

writeDocumentType	back to summary
public void writeDocumentType(DocumentType docType) throws XMLStreamException Writes a DOM4J `DocumentType`to the stream. Parameters docType:DocumentType The `DocumentType`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeDocumentType(DocumentType docType) throws XMLStreamException

Writes a DOM4J DocumentTypeto the stream.

Parameters

docType:DocumentType: The DocumentTypeto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeElement back to summary

writeElement	back to summary
public void writeElement(Element elem) throws XMLStreamException Writes a DOM4J `Element`node and its children to the stream. Parameters elem:Element The `Element`node to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeElement(Element elem) throws XMLStreamException

Writes a DOM4J Elementnode and its children to the stream.

Parameters

elem:Element: The Elementnode to write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeEntity back to summary

writeEntity	back to summary
public void writeEntity(Entity entity) throws XMLStreamException Writes a DOM4J `Entity`to the stream. Parameters entity:Entity The `Entity`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeEntity(Entity entity) throws XMLStreamException

Writes a DOM4J Entityto the stream.

Parameters

entity:Entity: The Entityto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeNamespace back to summary

writeNamespace	back to summary
public void writeNamespace(Namespace ns) throws XMLStreamException Writes a DOM4J `Namespace`to the stream. Parameters ns:Namespace The `Namespace`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeNamespace(Namespace ns) throws XMLStreamException

Writes a DOM4J Namespaceto the stream.

Parameters

ns:Namespace: The Namespaceto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeNode back to summary

writeNode	back to summary
public void writeNode(Node n) throws XMLStreamException Writes a DOM4J `Node`to the stream. This method is simply a gateway to the overloaded methods such as `writeElement(Element)`. Parameters n:Node The DOM4J `Node`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeNode(Node n) throws XMLStreamException

Writes a DOM4J Nodeto the stream. This method is simply a gateway to the overloaded methods such as writeElement(Element).

Parameters

n:Node: The DOM4J Nodeto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeProcessingInstruction back to summary

writeProcessingInstruction	back to summary
public void writeProcessingInstruction(ProcessingInstruction pi) throws XMLStreamException Writes a DOM4J `ProcessingInstruction`to the stream. Parameters pi:ProcessingInstruction The `ProcessingInstruction`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeProcessingInstruction(ProcessingInstruction pi) throws XMLStreamException

Writes a DOM4J ProcessingInstructionto the stream.

Parameters

pi:ProcessingInstruction: The ProcessingInstructionto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

writeText back to summary

writeText	back to summary
public void writeText(Text text) throws XMLStreamException Writes a DOM4J `Text`to the stream. Parameters text:Text The `Text`to write to the stream. Exceptions XMLStreamException: If an error occurs writing to the stream.

public void writeText(Text text) throws XMLStreamException

Writes a DOM4J Textto the stream.

Parameters

text:Text: The Textto write to the stream.

Exceptions

XMLStreamException:: If an error occurs writing to the stream.

org.dom4j.io back to summary

private Class STAXEventWriter.AttributeIterator

Class Inheritance

extends Object
implements Iterator<Attribute>

java.lang.Object
org.dom4j.io.STAXEventWriter.AttributeIterator

All Implemented Interfaces

java.util.Iterator

Internal Iteratorimplementation used to pass DOM4J Attributes to the stream.

Field Summary

Modifier and Type	Field and Description
private Iterator<Attribute>	iter The underlying DOm4J attribute iterator.

Constructor Summary

Access	Constructor and Description
public	AttributeIterator(Iterator<Attribute> iter)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Attribute	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

iter	back to summary
private Iterator<Attribute> iter The underlying DOm4J attribute iterator.

Constructor Detail

AttributeIterator	back to summary
public AttributeIterator(Iterator<Attribute> iter)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean: true if the iteration has more elements

next	back to summary
public Attribute next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:Attribute the next element in the iteration

back to summary

public Attribute next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Attribute: the next element in the iteration

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method.

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

org.dom4j.io back to summary

private Class STAXEventWriter.NamespaceIterator

Class Inheritance

extends Object
implements Iterator<Namespace>

java.lang.Object
org.dom4j.io.STAXEventWriter.NamespaceIterator

All Implemented Interfaces

java.util.Iterator

Internal Iteratorimplementation used to pass DOM4J Namespaces to the stream.

Field Summary

Modifier and Type	Field and Description
private Iterator<Namespace>	iter

Constructor Summary

Access	Constructor and Description
public	NamespaceIterator(Iterator<Namespace> iter)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Namespace	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

iter	back to summary
private Iterator<Namespace> iter

Constructor Detail

NamespaceIterator	back to summary
public NamespaceIterator(Iterator<Namespace> iter)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean: true if the iteration has more elements

back to summary

public Namespace next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Namespace: the next element in the iteration

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

public Class STAXEventWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class STAXEventWriter.AttributeIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class STAXEventWriter.NamespaceIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail