javax.xml.stream

Interface XMLStreamReader

All Superinterfaces:
XMLStreamConstants
Known Implementing Classes:
StreamReaderDelegate

public interface XMLStreamReader
extends XMLStreamConstants

Interface implemented by an XML parser.

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Method Summary

void
close()
Frees any resources used by this parser.
int
getAttributeCount()
Returns the number of attributes on this element.
String
getAttributeLocalName(int index)
Returns the local-name of the attribute at the given index.
QName
getAttributeName(int index)
Returns the QName of the attribute at the given index.
String
getAttributeNamespace(int index)
Returns the namespace URI of the attribute at the given index.
String
getAttributePrefix(int index)
Returns the namespace prefix of the attribute at the given index.
String
getAttributeType(int index)
Returns the type of the attribute at the specified index.
String
getAttributeValue(int index)
Returns the normalized value of the attribute at the given index.
String
getAttributeValue(String namespaceURI, String localName)
Returns the normalized attribute value for the given attribute.
String
getCharacterEncodingScheme()
Returns the encoding declared in the XML declaration.
String
getElementText()
Returns the text content of a text-only element.
String
getEncoding()
Returns the input encoding.
int
getEventType()
Returns the type of the current event.
String
getLocalName()
Returns the local-name of the current element.
Location
getLocation()
Returns the current location of the parser cursor in the underlying input source.
QName
getName()
Returns the QName of the current element.
NamespaceContext
getNamespaceContext()
Returns the namespace context for the current position.
int
getNamespaceCount()
Returns the number of namespaces declared on this event.
String
getNamespacePrefix(int index)
Returns the prefix of the namespace at the given index, or null if this is the default namespace declaration.
String
getNamespaceURI()
Returns the namespace URI of the current element.
String
getNamespaceURI(int index)
Returns the URI of the namespace at the given index.
String
getNamespaceURI(String prefix)
Returns the namespace URI for the given prefix.
String
getPIData()
Returns the data of the current processing instruction event.
String
getPITarget()
Returns the target of the current processing instruction event.
String
getPrefix()
Returns the namespace prefix of the current element.
Object
getProperty(String name)
Returns the implementation-specific feature or property of the given name.
String
getText()
Returns the string value of the current event.
char[]
getTextCharacters()
Returns the string value of the current event as a character array.
int
getTextCharacters(int sourceStart, char[] target, int targetStart, int length)
Copies the string value of the current event into the specified character array.
int
getTextLength()
Returns the length of the characters in the text character array.
int
getTextStart()
Returns the offset of the first character in the text character array.
String
getVersion()
Returns the XML version declared in the XML declaration.
boolean
hasName()
Indicates whether the current event has a name.
boolean
hasNext()
Indicates whether there are any remaining events to be read.
boolean
hasText()
Indicates whether the current event has text.
boolean
isAttributeSpecified(int index)
Indicates whether the attribute at the given index was specified in the underlying XML source or created by default.
boolean
isCharacters()
Indicates whether the current event is character data.
boolean
isEndElement()
Indicates whether the current event is END_ELEMENT.
boolean
isStandalone()
Returns the standalone flag declared in the XML declaration.
boolean
isStartElement()
Indicates whether the current event is START_ELEMENT.
boolean
isWhiteSpace()
Indicates whether the current event is ignorable whitespace.
int
next()
Returns the next parsing event.
int
nextTag()
Skips any ignorable whitespace, comments, and processing instructions until a START_ELEMENT or END_ELEMENT event is encountered.
void
require(int type, String namespaceURI, String localName)
Tests whether the current event is of the given type and namespace.
boolean
standaloneSet()
Indicates whether the standalone flag was set in the document.

Method Details

close

public void close()
            throws XMLStreamException
Frees any resources used by this parser. This method will not close the underlying input source.

getAttributeCount

public int getAttributeCount()
Returns the number of attributes on this element. This method can only be invoked on a START_ELEMENT event.

getAttributeLocalName

public String getAttributeLocalName(int index)
Returns the local-name of the attribute at the given index.

getAttributeName

public QName getAttributeName(int index)
Returns the QName of the attribute at the given index.

getAttributeNamespace

public String getAttributeNamespace(int index)
Returns the namespace URI of the attribute at the given index.

getAttributePrefix

public String getAttributePrefix(int index)
Returns the namespace prefix of the attribute at the given index.

getAttributeType

public String getAttributeType(int index)
Returns the type of the attribute at the specified index.

getAttributeValue

public String getAttributeValue(int index)
Returns the normalized value of the attribute at the given index.

getAttributeValue

public String getAttributeValue(String namespaceURI,
                                String localName)
Returns the normalized attribute value for the given attribute.

getCharacterEncodingScheme

public String getCharacterEncodingScheme()
Returns the encoding declared in the XML declaration.

getElementText

public String getElementText()
            throws XMLStreamException
Returns the text content of a text-only element. When invoked, the current event must be START_ELEMENT. On completion, the current event will be END_ELEMENT.

getEncoding

public String getEncoding()
Returns the input encoding.

getEventType

public int getEventType()
Returns the type of the current event.

getLocalName

public String getLocalName()
Returns the local-name of the current element.

getLocation

public Location getLocation()
Returns the current location of the parser cursor in the underlying input source.

getName

public QName getName()
Returns the QName of the current element. This method is only valid on a START_ELEMENT or END_ELEMENT event.

getNamespaceContext

public NamespaceContext getNamespaceContext()
Returns the namespace context for the current position.

getNamespaceCount

public int getNamespaceCount()
Returns the number of namespaces declared on this event. This method is only valid on a START_ELEMENT, END_ELEMENT, or NAMESPACE event.

getNamespacePrefix

public String getNamespacePrefix(int index)
Returns the prefix of the namespace at the given index, or null if this is the default namespace declaration.

getNamespaceURI

public String getNamespaceURI()
Returns the namespace URI of the current element.

getNamespaceURI

public String getNamespaceURI(int index)
Returns the URI of the namespace at the given index.

getNamespaceURI

public String getNamespaceURI(String prefix)
Returns the namespace URI for the given prefix.

getPIData

public String getPIData()
Returns the data of the current processing instruction event.

getPITarget

public String getPITarget()
Returns the target of the current processing instruction event.

getPrefix

public String getPrefix()
Returns the namespace prefix of the current element.

getProperty

public Object getProperty(String name)
            throws IllegalArgumentException
Returns the implementation-specific feature or property of the given name.

getText

public String getText()
Returns the string value of the current event.

getTextCharacters

public char[] getTextCharacters()
Returns the string value of the current event as a character array.

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
            throws XMLStreamException
Copies the string value of the current event into the specified character array.

getTextLength

public int getTextLength()
Returns the length of the characters in the text character array.

getTextStart

public int getTextStart()
Returns the offset of the first character in the text character array.

getVersion

public String getVersion()
Returns the XML version declared in the XML declaration.

hasName

public boolean hasName()
Indicates whether the current event has a name.

hasNext

public boolean hasNext()
            throws XMLStreamException
Indicates whether there are any remaining events to be read.

hasText

public boolean hasText()
Indicates whether the current event has text.

isAttributeSpecified

public boolean isAttributeSpecified(int index)
Indicates whether the attribute at the given index was specified in the underlying XML source or created by default.

isCharacters

public boolean isCharacters()
Indicates whether the current event is character data.

isEndElement

public boolean isEndElement()
Indicates whether the current event is END_ELEMENT.

isStandalone

public boolean isStandalone()
Returns the standalone flag declared in the XML declaration.

isStartElement

public boolean isStartElement()
Indicates whether the current event is START_ELEMENT.

isWhiteSpace

public boolean isWhiteSpace()
Indicates whether the current event is ignorable whitespace.

next

public int next()
            throws XMLStreamException
Returns the next parsing event.

nextTag

public int nextTag()
            throws XMLStreamException
Skips any ignorable whitespace, comments, and processing instructions until a START_ELEMENT or END_ELEMENT event is encountered.
Throws:
XMLStreamException - if an event of any other type is encountered

require

public void require(int type,
                    String namespaceURI,
                    String localName)
            throws XMLStreamException
Tests whether the current event is of the given type and namespace.
Throws:
XMLStreamException - if the test fails

standaloneSet

public boolean standaloneSet()
Indicates whether the standalone flag was set in the document.

XMLStreamReader.java -- Copyright (C) 2005,2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.