org.simpleframework.xml.stream

Class NodeReader

java.lang.Object

org.simpleframework.xml.stream.NodeReader

public class NodeReader
extends java.lang.Object

The NodeReader object is used to read elements from the specified XML event reader. This reads input node objects that represent elements within the source XML document. This will allow details to be read using input node objects, as long as the end elements for those input nodes have not been ended.

For example, if an input node represented the root element of a document then that input node could read all elements within the document. However, if the input node represented a child element then it would only be able to read its children.

Constructor Summary

Constructors

Constructor and Description
NodeReader(EventReader reader) Constructor for the NodeReader object.

Method Summary

Modifier and Type	Method and Description
boolean	isEmpty(InputNode from) This is used to determine if this input node is empty.
boolean	isRoot(InputNode node) This method is used to determine if this node is the root node for the XML document.
InputNode	readElement(InputNode from) Returns the next input node from the XML document, if it is a child element of the specified input node.
InputNode	readElement(InputNode from, java.lang.String name) Returns the next input node from the XML document, if it is a child element of the specified input node.
InputNode	readRoot() Returns the root input node for the document.
java.lang.String	readValue(InputNode from) Read the contents of the characters between the specified XML element tags, if the read is currently at that element.
void	skipElement(InputNode from) This method is used to skip an element within the XML document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeReader

public NodeReader(EventReader reader)

Constructor for the NodeReader object. This is used to read XML events a input node objects from the event reader.

Parameters:

reader - this is the event reader for the XML document

Method Detail

isRoot

public boolean isRoot(InputNode node)

This method is used to determine if this node is the root node for the XML document. The root node is the first node in the document and has no sibling nodes. This is false if the node has a parent node or a sibling node.

Returns:

true if this is the root node within the document

readRoot

public InputNode readRoot()
                   throws java.lang.Exception

Returns the root input node for the document. This is returned only if no other elements have been read. Once the root element has been read from the event reader this will return null.

Returns:

this returns the root input node for the document

Throws:

java.lang.Exception

readElement

public InputNode readElement(InputNode from)
                      throws java.lang.Exception

Returns the next input node from the XML document, if it is a child element of the specified input node. This essentially determines whether the end tag has been read for the specified node, if so then null is returned. If however the specified node has not had its end tag read then this returns the next element, if that element is a child of the that node.

Parameters:

from - this is the input node to read with

Returns:

this returns the next input node from the document

Throws:

java.lang.Exception

readElement

public InputNode readElement(InputNode from,
                             java.lang.String name)
                      throws java.lang.Exception

Returns the next input node from the XML document, if it is a child element of the specified input node. This essentially the same as the readElement(InputNode) object except that this will not read the element if it does not have the name specified. This essentially acts as a peak function.

Parameters:

from - this is the input node to read with

name - this is the name expected from the next element

Returns:

this returns the next input node from the document

Throws:

java.lang.Exception

readValue

public java.lang.String readValue(InputNode from)
                           throws java.lang.Exception

Read the contents of the characters between the specified XML element tags, if the read is currently at that element. This allows characters associated with the element to be used. If the specified node is not the current node, null is returned.

Parameters:

from - this is the input node to read the value from

Returns:

this returns the characters from the specified node

Throws:

java.lang.Exception

isEmpty

public boolean isEmpty(InputNode from)
                throws java.lang.Exception

This is used to determine if this input node is empty. An empty node is one with no attributes or children. This can be used to determine if a given node represents an empty entity, with which no extra data can be extracted.

Parameters:

from - this is the input node to read the value from

Returns:

this returns true if the node is an empty element

Throws:

java.lang.Exception - thrown if there was a parse error

skipElement

public void skipElement(InputNode from)
                 throws java.lang.Exception

This method is used to skip an element within the XML document. This will simply read each element from the document until the specified element is at the top of the stack. When the specified element is at the top of the stack this returns.

Parameters:

from - this is the element to skip from the XML document

Throws:

java.lang.Exception