XMLReader (StAXWax 1.1.2 API)

All Known Implementing Classes:

DefaultXMLStreamReader
```
public interface XMLReader
```
This interface provides convenience methods for XML reading.

Version:

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

Author:

Lars Helge Overland

Method Summary

All Methods Instance Methods Abstract 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.
`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>`	`readAttributes()` Reads attributes at the current start element and returns a mapping of attribute name sand values.
`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.

- Method Detail
  - getElementName
```
String getElementName()
```
    Reads the name of the current XML element.
    
    Returns:
    
    The name of the current XML element.
  - getElementValue
```
String getElementValue()
```
    Reads the value of the current XML element.
    
    Returns:
    
    The name of the current XML element.
  - moveToStartElement
```
void moveToStartElement(String name)
```
    Moves the cursor to the first XML start element with the given name in the document.
    
    Parameters:
    
    name - The name of the XML element to move to.
  - moveToStartElement
```
boolean moveToStartElement(String startElementName,
                           String endElementName)
```
    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.
    
    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
```
boolean isStartElement(String name)
```
    Checks whether the current XML element is a start element with the given name.
    
    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
```
boolean isEndElement(String name)
```
    Checks whether the current XML element is an end element with the given name.
    
    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
```
boolean next()
```
    Moves the cursor to the next XML element in the document. Returns true until the cursor points at the XML document end.
    
    Returns:
    
    False if the cursor points at the XML document end, true otherwise.
  - next
```
boolean next(String endElementName)
```
    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.
    
    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
```
String getAttributeValue(String attributeName)
```
    Reads the value of the XML attribute with the given name.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The value of the XML attribute with the given name.
  - getAttributeCount
```
int getAttributeCount()
```
    Returns the count of attributes on this start element. Attributes are zero-based.
    
    Returns:
    
    the count of attributes.
  - readElements
```
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. This method is only suitable for single-level nested elements.
    
    Parameters:
    
    elementName - the name of the XML element.
    
    Returns:
    
    A map with property-value pairs for the given XML element.
  - readAttributes
```
Map<String,String> readAttributes()
```
    Reads attributes at the current start element and returns a mapping of attribute name sand values. Requires current node to be a start element.
    
    Returns:
    
    a map of attribute names and values.
  - getXmlStreamReader
```
XMLStreamReader getXmlStreamReader()
```
    Provides the underlying XMLStreamReader.
    
    Returns:
    
    the underlying XMLStreamReader.
  - closeReader
```
void closeReader()
```
    Closes the underlying reader.

Interface XMLReader

Method Summary

Method Detail

getElementName

getElementValue

moveToStartElement

moveToStartElement

isStartElement

isEndElement

next

next

getAttributeValue

getAttributeCount

readElements

readAttributes

getXmlStreamReader

closeReader