This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.stream.util
class StreamReaderDelegate

java.lang.Object extended by javax.xml.stream.util.StreamReaderDelegate
All Implemented Interfaces:
XMLStreamReader

public class StreamReaderDelegate
extends Object
implements XMLStreamReader

This is the base class for deriving an XMLStreamReader filter This class is designed to sit between an XMLStreamReader and an application's XMLStreamReader. By default each method does nothing but call the corresponding method on the parent interface.


Constructor Summary

          Construct an empty filter with no parent.

          Construct an filter with the specified parent.
 
Method Summary
 void

          
 int

          
 String

          
 QName
getAttributeName(int index)

          
 String

          
 String
getAttributePrefix(int index)

          
 String
getAttributeType(int index)

          
 String
getAttributeValue(int index)

          
 String
getAttributeValue(String namespaceUri, String localName)

          
 String

          
 String

          
 String

          
 int

          
 String

          
 Location

          
 QName

          
 NamespaceContext

          
 int

          
 String
getNamespacePrefix(int index)

          
 String

          
 String
getNamespaceURI(int index)

          
 String

          
 XMLStreamReader

          Get the parent of this instance.
 String

          
 String

          
 String

          
 Object

          
 String

          
 char[]

          
 int
getTextCharacters(int sourceStart, char[] target, int targetStart, int length)

          
 int

          
 int

          
 String

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 boolean

          
 int

          
 int

          
 void
require(int type, String namespaceURI, String localName)

          
 void

          Set the parent of this instance.
 boolean

          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StreamReaderDelegate

public StreamReaderDelegate()
Construct an empty filter with no parent.


StreamReaderDelegate

public StreamReaderDelegate(XMLStreamReader reader)
Construct an filter with the specified parent.

Parameters:
reader - the parent
Method Detail

close

public void close()
           throws XMLStreamException
Throws:
XMLStreamException

getAttributeCount

public int getAttributeCount()

getAttributeLocalName

public String getAttributeLocalName(int index)
Parameters:
index

getAttributeName

public QName getAttributeName(int index)
Parameters:
index

getAttributeNamespace

public String getAttributeNamespace(int index)
Parameters:
index

getAttributePrefix

public String getAttributePrefix(int index)
Parameters:
index

getAttributeType

public String getAttributeType(int index)
Parameters:
index

getAttributeValue

public String getAttributeValue(int index)
Parameters:
index

getAttributeValue

public String getAttributeValue(String namespaceUri,
                                String localName)
Parameters:
namespaceUri
localName

getCharacterEncodingScheme

public String getCharacterEncodingScheme()

getElementText

public String getElementText()
                      throws XMLStreamException
Throws:
XMLStreamException

getEncoding

public String getEncoding()

getEventType

public int getEventType()

getLocalName

public String getLocalName()

getLocation

public Location getLocation()

getName

public QName getName()

getNamespaceContext

public NamespaceContext getNamespaceContext()

getNamespaceCount

public int getNamespaceCount()

getNamespacePrefix

public String getNamespacePrefix(int index)
Parameters:
index

getNamespaceURI

public String getNamespaceURI()

getNamespaceURI

public String getNamespaceURI(int index)
Parameters:
index

getNamespaceURI

public String getNamespaceURI(String prefix)
Parameters:
prefix

getParent

public XMLStreamReader getParent()
Get the parent of this instance.

Returns:
the parent or null if none is set

getPIData

public String getPIData()

getPITarget

public String getPITarget()

getPrefix

public String getPrefix()

getProperty

public Object getProperty(String name)
Parameters:
name

getText

public String getText()

getTextCharacters

public char[] getTextCharacters()

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
                      throws XMLStreamException
Parameters:
sourceStart
target
targetStart
length
Throws:
XMLStreamException

getTextLength

public int getTextLength()

getTextStart

public int getTextStart()

getVersion

public String getVersion()

hasName

public boolean hasName()

hasNext

public boolean hasNext()
                throws XMLStreamException
Throws:
XMLStreamException

hasText

public boolean hasText()

isAttributeSpecified

public boolean isAttributeSpecified(int index)
Parameters:
index

isCharacters

public boolean isCharacters()

isEndElement

public boolean isEndElement()

isStandalone

public boolean isStandalone()

isStartElement

public boolean isStartElement()

isWhiteSpace

public boolean isWhiteSpace()

next

public int next()
         throws XMLStreamException
Throws:
XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException
Throws:
XMLStreamException

require

public void require(int type,
                    String namespaceURI,
                    String localName)
             throws XMLStreamException
Parameters:
type
namespaceURI
localName
Throws:
XMLStreamException

setParent

public void setParent(XMLStreamReader reader)
Set the parent of this instance.

Parameters:
reader - the new parent

standaloneSet

public boolean standaloneSet()


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.