org.amplecode.staxwax.reader

Class DefaultXMLStreamReader

java.lang.Object

org.amplecode.staxwax.reader.DefaultXMLStreamReader

All Implemented Interfaces:

XMLReader

public class DefaultXMLStreamReader
extends Object
implements XMLReader

Version:

$Id: DefaultXMLStreamReader.java 152 2009-10-30 23:01:04Z larshelg $

Author:

Lars Helge Overland

Constructor Summary

Constructors

Constructor and Description
DefaultXMLStreamReader(XMLStreamReader reader)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeReader() Closes the underlying reader.
int	getAttributeCount() Returns the count of attributes on this start element.
String	getAttributeValue(String attributeName) Reads the value of the XML attribute with the given name.
String	getElementName() Reads the name of the current XML element.
String	getElementValue() Reads the value of the current XML element.
protected String	getText()
XMLStreamReader	getXmlStreamReader() Provides the underlying XMLStreamReader.
boolean	isEndElement(String name) Checks whether the current XML element is an end element with the given name.
boolean	isStartElement(String name) Checks whether the current XML element is a start element with the given name.
void	moveToStartElement(String name) Moves the cursor to the first XML start element with the given name in the document.
boolean	moveToStartElement(String startElementName, String endElementName) Moves the cursor to the first XML start element with the given name in the document.
boolean	next() Moves the cursor to the next XML element in the document.
boolean	next(String endElementName) Moves the cursor to the next XML element in the document.
Map<String,String>	readElements(String elementName) Reads values for all properties for an element into a Map, where the key is the property and the value is the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXMLStreamReader

public DefaultXMLStreamReader(XMLStreamReader reader)

Method Detail

getElementName

public String getElementName()

Description copied from interface: XMLReader

Reads the name of the current XML element.

Specified by:

getElementName in interface XMLReader

Returns:

The name of the current XML element.

getElementValue

public String getElementValue()

Description copied from interface: XMLReader

Reads the value of the current XML element.

Specified by:

getElementValue in interface XMLReader

Returns:

The name of the current XML element.

moveToStartElement

public void moveToStartElement(String name)

Description copied from interface: XMLReader

Moves the cursor to the first XML start element with the given name in the document.

Specified by:

moveToStartElement in interface XMLReader

Parameters:

name - The name of the XML element to move to.

moveToStartElement

public boolean moveToStartElement(String startElementName,
                         String endElementName)

Description copied from interface: XMLReader

Moves the cursor to the first XML start element with the given name in the document. Returns true until the cursor points at an XML end element with the given name.

Specified by:

moveToStartElement in interface XMLReader

Parameters:

startElementName - The name of the XML start element to move to.

endElementName - The name of the XML end element to stop moving forward at.

isStartElement

public boolean isStartElement(String name)

Description copied from interface: XMLReader

Checks whether the current XML element is a start element with the given name.

Specified by:

isStartElement in interface XMLReader

Parameters:

name - The name of the XML element.

Returns:

True if the current XML element is a start element with the given name, otherwise false.

isEndElement

public boolean isEndElement(String name)

Description copied from interface: XMLReader

Checks whether the current XML element is an end element with the given name.

Specified by:

isEndElement in interface XMLReader

Parameters:

name - The name of the XML element.

Returns:

True if the current XML element is an end element with the given name, otherwise false.

next

public boolean next()

Description copied from interface: XMLReader

Moves the cursor to the next XML element in the document. Returns true until the cursor points at the XML document end.

Specified by:

next in interface XMLReader

Returns:

False if the cursor points at the XML document end, true otherwise.

next

public boolean next(String endElementName)

Description copied from interface: XMLReader

Moves the cursor to the next XML element in the document. Returns true until the cursor points at an XML end element with the given name.

Specified by:

next in interface XMLReader

Parameters:

endElementName - The name of the end element.

Returns:

False if the cursor points at an XML end element with the given name, true otherwise.

getAttributeValue

public String getAttributeValue(String attributeName)

Description copied from interface: XMLReader

Reads the value of the XML attribute with the given name.

Specified by:

getAttributeValue in interface XMLReader

Parameters:

attributeName - The name of the attribute.

Returns:

The value of the XML attribute with the given name.

getAttributeCount

public int getAttributeCount()

Description copied from interface: XMLReader

Returns the count of attributes on this start element. Attributes are zero-based.

Specified by:

getAttributeCount in interface XMLReader

Returns:

the count of attributes.

readElements

public Map<String,String> readElements(String elementName)

Description copied from interface: XMLReader

Reads values for all properties for an element into a Map, where the key is the property and the value is the value. This method is only suitable for single-level nested elements.

Specified by:

readElements in interface XMLReader

Parameters:

elementName - the name of the XML element.

Returns:

A map with property-value pairs for the given XML element.

getXmlStreamReader

public XMLStreamReader getXmlStreamReader()

Description copied from interface: XMLReader

Provides the underlying XMLStreamReader.

Specified by:

getXmlStreamReader in interface XMLReader

Returns:

the underlying XMLStreamReader.

closeReader

public void closeReader()

Description copied from interface: XMLReader

Closes the underlying reader.

Specified by:

closeReader in interface XMLReader

getText

protected String getText()
                  throws XMLStreamException

Throws:

XMLStreamException