org.dom4j.io

Class STAXEventReader

public class STAXEventReader extends Object

Reads a DOM4J {@link Document}, as well as other {@link Node}s, from a StAX {@link XMLEventReader}.

Author: Christian Niles

Constructor Summary
STAXEventReader()
Constructs a default STAXEventReader instance with a default {@link DocumentFactory}.
STAXEventReader(DocumentFactory factory)
Constructs a STAXEventReader instance that uses the specified {@link DocumentFactory}to construct DOM4J {@link Node}s.
Method Summary
AttributecreateAttribute(Element elem, Attribute attr)
Constructs a new DOM4J Attribute from the provided StAX Attribute event.
CharacterDatacreateCharacterData(Characters characters)
Constructs a new DOM4J Text or CDATA object from the provided Characters event.
CommentcreateComment(Comment comment)
Constructs a new DOM4J Comment from the provided StAX Comment event.
ElementcreateElement(StartElement startEvent)
Constructs a new DOM4J Element from the provided StartElement event.
EntitycreateEntity(EntityReference entityRef)
Constructs a new DOM4J Entity from the provided StAX EntityReference event.
NamespacecreateNamespace(Namespace ns)
Constructs a new DOM4J Namespace from the provided StAX Namespace event.
ProcessingInstructioncreateProcessingInstruction(ProcessingInstruction pi)
Constructs a new DOM4J ProcessingInstruction from the provided StAX ProcessingInstruction event.
QNamecreateQName(QName qname)
Constructs a new DOM4J QName from the provided JAXP QName.
AttributereadAttribute(XMLEventReader reader)
Constructs a DOM4J Attribute from the provided event stream.
CharacterDatareadCharacters(XMLEventReader reader)
Constructs a DOM4J Text or CDATA section from the provided event stream.
CommentreadComment(XMLEventReader reader)
Constructs a DOM4J Comment from the provided event stream.
DocumentreadDocument(InputStream is)
Constructs a StAX event stream from the provided I/O stream and reads a DOM4J document from it.
DocumentreadDocument(Reader reader)
Constructs a StAX event stream from the provided I/O character stream and reads a DOM4J document from it.
DocumentreadDocument(InputStream is, String systemId)
Constructs a StAX event stream from the provided I/O stream and reads a DOM4J document from it.
DocumentreadDocument(Reader reader, String systemId)
Constructs a StAX event stream from the provided I/O character stream and reads a DOM4J document from it.
DocumentreadDocument(XMLEventReader reader)
Reads a DOM4J {@link Document}from the provided stream.
ElementreadElement(XMLEventReader eventReader)
Reads a DOM4J Element from the provided event stream.
EntityreadEntityReference(XMLEventReader reader)
Constructs a DOM4J Entity from the provided event stream.
NamespacereadNamespace(XMLEventReader reader)
Constructs a DOM4J Namespace from the provided event stream.
NodereadNode(XMLEventReader reader)
Reads a {@link Node}from the event stream.
ProcessingInstructionreadProcessingInstruction(XMLEventReader reader)
Constructs a DOM4J ProcessingInstruction from the provided event stream.
voidsetDocumentFactory(DocumentFactory documentFactory)
Sets the DocumentFactory to be used when constructing DOM4J nodes.

Constructor Detail

STAXEventReader

public STAXEventReader()
Constructs a default STAXEventReader instance with a default {@link DocumentFactory}.

STAXEventReader

public STAXEventReader(DocumentFactory factory)
Constructs a STAXEventReader instance that uses the specified {@link DocumentFactory}to construct DOM4J {@link Node}s.

Parameters: factory The DocumentFactory to use when constructing DOM4J nodes, or null if a default should be used.

Method Detail

createAttribute

public Attribute createAttribute(Element elem, Attribute attr)
Constructs a new DOM4J Attribute from the provided StAX Attribute event.

Parameters: elem DOCUMENT ME! attr The Attribute event from which to construct the new DOM4J Attribute.

Returns: The Attribute constructed from the provided Attribute event.

createCharacterData

public CharacterData createCharacterData(Characters characters)
Constructs a new DOM4J Text or CDATA object from the provided Characters event.

Parameters: characters The Characters event from which to construct the new DOM4J Text or CDATA object.

Returns: The Text or CDATA object constructed from the provided Characters event.

createComment

public Comment createComment(Comment comment)
Constructs a new DOM4J Comment from the provided StAX Comment event.

Parameters: comment The Comment event from which to construct the new DOM4J Comment.

Returns: The Comment constructed from the provided Comment event.

createElement

public Element createElement(StartElement startEvent)
Constructs a new DOM4J Element from the provided StartElement event. All attributes and namespaces will be added to the returned element.

Parameters: startEvent The StartElement event from which to construct the new DOM4J Element.

Returns: The Element constructed from the provided StartElement event.

createEntity

public Entity createEntity(EntityReference entityRef)
Constructs a new DOM4J Entity from the provided StAX EntityReference event.

Parameters: entityRef The EntityReference event from which to construct the new DOM4J Entity.

Returns: The Entity constructed from the provided EntityReference event.

createNamespace

public Namespace createNamespace(Namespace ns)
Constructs a new DOM4J Namespace from the provided StAX Namespace event.

Parameters: ns The Namespace event from which to construct the new DOM4J Namespace.

Returns: The Namespace constructed from the provided Namespace event.

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(ProcessingInstruction pi)
Constructs a new DOM4J ProcessingInstruction from the provided StAX ProcessingInstruction event.

Parameters: pi The ProcessingInstruction event from which to construct the new DOM4J ProcessingInstruction.

Returns: The ProcessingInstruction constructed from the provided ProcessingInstruction event.

createQName

public QName createQName(QName qname)
Constructs a new DOM4J QName from the provided JAXP QName.

Parameters: qname The JAXP QName from which to create a DOM4J QName.

Returns: The newly constructed DOM4J QName.

readAttribute

public Attribute readAttribute(XMLEventReader reader)
Constructs a DOM4J Attribute from the provided event stream. The stream must be positioned before an {@link Attribute}event.

Parameters: reader The event stream from which to read the Attribute.

Returns: The Attribute that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before an {@linkAttribute}event.

readCharacters

public CharacterData readCharacters(XMLEventReader reader)
Constructs a DOM4J Text or CDATA section from the provided event stream. The stream must be positioned before a {@link Characters}event.

Parameters: reader The event stream from which to read the Text or CDATA.

Returns: The Text or CDATA that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before a {@linkCharacters}event.

readComment

public Comment readComment(XMLEventReader reader)
Constructs a DOM4J Comment from the provided event stream. The stream must be positioned before a {@link Comment}event.

Parameters: reader The event stream from which to read the Comment.

Returns: The Comment that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before a {@linkComment}event.

readDocument

public Document readDocument(InputStream is)
Constructs a StAX event stream from the provided I/O stream and reads a DOM4J document from it.

Parameters: is The I/O stream from which the Document will be read.

Returns: The Document that was read from the stream.

Throws: XMLStreamException If an error occurs reading content from the stream.

readDocument

public Document readDocument(Reader reader)
Constructs a StAX event stream from the provided I/O character stream and reads a DOM4J document from it.

Parameters: reader The character stream from which the Document will be read.

Returns: The Document that was read from the stream.

Throws: XMLStreamException If an error occurs reading content from the stream.

readDocument

public Document readDocument(InputStream is, String systemId)
Constructs a StAX event stream from the provided I/O stream and reads a DOM4J document from it.

Parameters: is The I/O stream from which the Document will be read. systemId A system id used to resolve entities.

Returns: The Document that was read from the stream.

Throws: XMLStreamException If an error occurs reading content from the stream.

readDocument

public Document readDocument(Reader reader, String systemId)
Constructs a StAX event stream from the provided I/O character stream and reads a DOM4J document from it.

Parameters: reader The character stream from which the Document will be read. systemId A system id used to resolve entities.

Returns: The Document that was read from the stream.

Throws: XMLStreamException If an error occurs reading content from the stream.

readDocument

public Document readDocument(XMLEventReader reader)
Reads a DOM4J {@link Document}from the provided stream. The stream should be positioned at the start of a document, or before a {@link StartElement} event.

Parameters: reader The event stream from which to read the {@link Document}.

Returns: The {@link Document}that was read from the stream.

Throws: XMLStreamException If an error occurs reading events from the stream.

readElement

public Element readElement(XMLEventReader eventReader)
Reads a DOM4J Element from the provided event stream. The stream must be positioned before an {@link StartElement}event. In addition to the initial start event, all events up to and including the closing {@link EndElement} will be read, and included with the returned element.

Parameters: eventReader The event stream from which to read the Element.

Returns: The Element that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before a {@linkStartElement}event.

readEntityReference

public Entity readEntityReference(XMLEventReader reader)
Constructs a DOM4J Entity from the provided event stream. The stream must be positioned before an {@link EntityReference}event.

Parameters: reader The event stream from which to read the {@link EntityReference}.

Returns: The {@link org.dom4j.Entity}that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before an {@linkEntityReference} event.

readNamespace

public Namespace readNamespace(XMLEventReader reader)
Constructs a DOM4J Namespace from the provided event stream. The stream must be positioned before a {@link Namespace}event.

Parameters: reader The event stream from which to read the Namespace.

Returns: The Namespace that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before a {@linkNamespace}event.

readNode

public Node readNode(XMLEventReader reader)
Reads a {@link Node}from the event stream. If the next event is a {@link StartElement}, all events until the closing {@link EndElement} will be read, and the resulting nodes will be added to the returned {@link Element}.

Pre-Conditions : The stream must be positioned before an event other than an EndElement,EndDocument, or any DTD-related events, which are not currently supported.

Parameters: reader The reader from which events will be read.

Returns: A DOM4J {@link Node}constructed from the read events.

Throws: XMLStreamException If an error occurs reading from the stream, or the stream was positioned before an unsupported event.

readProcessingInstruction

public ProcessingInstruction readProcessingInstruction(XMLEventReader reader)
Constructs a DOM4J ProcessingInstruction from the provided event stream. The stream must be positioned before a {@link ProcessingInstruction} event.

Parameters: reader The event stream from which to read the ProcessingInstruction.

Returns: The ProcessingInstruction that was read from the stream.

Throws: XMLStreamException If an error occured reading events from the stream, or the stream was not positioned before a {@link ProcessingInstruction} event.

setDocumentFactory

public void setDocumentFactory(DocumentFactory documentFactory)
Sets the DocumentFactory to be used when constructing DOM4J nodes.

Parameters: documentFactory The DocumentFactory to use when constructing DOM4J nodes, or null if a default should be used.

Copyright B) 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge