Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.axis2.jaxws.message.util
Class Reader

java.lang.Object
  extended by org.apache.axis2.jaxws.message.util.Reader
All Implemented Interfaces:
XMLStreamConstants, XMLStreamReader
Direct Known Subclasses:
DOMReader, ResettableReader, SOAPElementReader
public abstract class Reader
extends Object
implements XMLStreamReader

Reader In many situations, you want the ability to reset an XMLStreamReader. (Or at least ask if the XMLStreamReader is resettable).

The Reader abstract class: - accepts an XMLStreamReader - provides reset() and isResettable() methods Adds support resettable support to XMLStreamReader

Derived classes must pass the initial reader to the constructor and indicate if it is resettable. Derived classes must also provide an implementation of the newReader() method if resettable.

Field Summary
protected  XMLStreamReader reader
           
 
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()
           
 int getAttributeCount()
           
 String getAttributeLocalName(int arg0)
           
 QName getAttributeName(int arg0)
           
 String getAttributeNamespace(int arg0)
           
 String getAttributePrefix(int arg0)
           
 String getAttributeType(int arg0)
           
 String getAttributeValue(int arg0)
           
 String getAttributeValue(String arg0, String arg1)
           
 String getCharacterEncodingScheme()
           
 String getElementText()
           
 String getEncoding()
           
 int getEventType()
           
 String getLocalName()
           
 Location getLocation()
           
 QName getName()
           
 NamespaceContext getNamespaceContext()
           
 int getNamespaceCount()
           
 String getNamespacePrefix(int arg0)
           
 String getNamespaceURI()
           
 String getNamespaceURI(int arg0)
           
 String getNamespaceURI(String arg0)
           
 String getPIData()
           
 String getPITarget()
           
 String getPrefix()
           
 Object getProperty(String arg0)
           
 String getText()
           
 char[] getTextCharacters()
           
 int getTextCharacters(int arg0, char[] arg1, int arg2, int arg3)
           
 int getTextLength()
           
 int getTextStart()
           
 String getVersion()
           
 boolean hasName()
           
 boolean hasNext()
           
 boolean hasText()
           
 boolean isAttributeSpecified(int arg0)
           
 boolean isCharacters()
           
 boolean isEndElement()
           
 boolean isResettable()
          isResettable
 boolean isStandalone()
           
 boolean isStartElement()
           
 boolean isWhiteSpace()
           
protected abstract  XMLStreamReader newReader()
          Get a newReader from the Object
 int next()
           
 int nextTag()
           
 void require(int arg0, String arg1, String arg2)
           
 void reset()
           
 boolean standaloneSet()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

reader

protected XMLStreamReader reader
Method Detail

newReader

protected abstract XMLStreamReader newReader()
Get a newReader from the Object

Returns:
XMLStreamReader

isResettable

public boolean isResettable()
isResettable

Returns:
true or false

reset

public void reset()
           throws WebServiceException
Throws:
WebServiceException

close

public void close()
           throws XMLStreamException
Specified by:
close in interface XMLStreamReader
Throws:
XMLStreamException

getAttributeCount

public int getAttributeCount()
Specified by:
getAttributeCount in interface XMLStreamReader

getAttributeLocalName

public String getAttributeLocalName(int arg0)
Specified by:
getAttributeLocalName in interface XMLStreamReader

getAttributeName

public QName getAttributeName(int arg0)
Specified by:
getAttributeName in interface XMLStreamReader

getAttributeNamespace

public String getAttributeNamespace(int arg0)
Specified by:
getAttributeNamespace in interface XMLStreamReader

getAttributePrefix

public String getAttributePrefix(int arg0)
Specified by:
getAttributePrefix in interface XMLStreamReader

getAttributeType

public String getAttributeType(int arg0)
Specified by:
getAttributeType in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(int arg0)
Specified by:
getAttributeValue in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(String arg0,
                                String arg1)
Specified by:
getAttributeValue in interface XMLStreamReader

getCharacterEncodingScheme

public String getCharacterEncodingScheme()
Specified by:
getCharacterEncodingScheme in interface XMLStreamReader

getElementText

public String getElementText()
                      throws XMLStreamException
Specified by:
getElementText in interface XMLStreamReader
Throws:
XMLStreamException

getEncoding

public String getEncoding()
Specified by:
getEncoding in interface XMLStreamReader

getEventType

public int getEventType()
Specified by:
getEventType in interface XMLStreamReader

getLocalName

public String getLocalName()
Specified by:
getLocalName in interface XMLStreamReader

getLocation

public Location getLocation()
Specified by:
getLocation in interface XMLStreamReader

getName

public QName getName()
Specified by:
getName in interface XMLStreamReader

getNamespaceContext

public NamespaceContext getNamespaceContext()
Specified by:
getNamespaceContext in interface XMLStreamReader

getNamespaceCount

public int getNamespaceCount()
Specified by:
getNamespaceCount in interface XMLStreamReader

getNamespacePrefix

public String getNamespacePrefix(int arg0)
Specified by:
getNamespacePrefix in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI()
Specified by:
getNamespaceURI in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(int arg0)
Specified by:
getNamespaceURI in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(String arg0)
Specified by:
getNamespaceURI in interface XMLStreamReader

getPIData

public String getPIData()
Specified by:
getPIData in interface XMLStreamReader

getPITarget

public String getPITarget()
Specified by:
getPITarget in interface XMLStreamReader

getPrefix

public String getPrefix()
Specified by:
getPrefix in interface XMLStreamReader

getProperty

public Object getProperty(String arg0)
                   throws IllegalArgumentException
Specified by:
getProperty in interface XMLStreamReader
Throws:
IllegalArgumentException

getText

public String getText()
Specified by:
getText in interface XMLStreamReader

getTextCharacters

public char[] getTextCharacters()
Specified by:
getTextCharacters in interface XMLStreamReader

getTextCharacters

public int getTextCharacters(int arg0,
                             char[] arg1,
                             int arg2,
                             int arg3)
                      throws XMLStreamException
Specified by:
getTextCharacters in interface XMLStreamReader
Throws:
XMLStreamException

getTextLength

public int getTextLength()
Specified by:
getTextLength in interface XMLStreamReader

getTextStart

public int getTextStart()
Specified by:
getTextStart in interface XMLStreamReader

getVersion

public String getVersion()
Specified by:
getVersion in interface XMLStreamReader

hasName

public boolean hasName()
Specified by:
hasName in interface XMLStreamReader

hasNext

public boolean hasNext()
                throws XMLStreamException
Specified by:
hasNext in interface XMLStreamReader
Throws:
XMLStreamException

hasText

public boolean hasText()
Specified by:
hasText in interface XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int arg0)
Specified by:
isAttributeSpecified in interface XMLStreamReader

isCharacters

public boolean isCharacters()
Specified by:
isCharacters in interface XMLStreamReader

isEndElement

public boolean isEndElement()
Specified by:
isEndElement in interface XMLStreamReader

isStandalone

public boolean isStandalone()
Specified by:
isStandalone in interface XMLStreamReader

isStartElement

public boolean isStartElement()
Specified by:
isStartElement in interface XMLStreamReader

isWhiteSpace

public boolean isWhiteSpace()
Specified by:
isWhiteSpace in interface XMLStreamReader

next

public int next()
         throws XMLStreamException
Specified by:
next in interface XMLStreamReader
Throws:
XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException
Specified by:
nextTag in interface XMLStreamReader
Throws:
XMLStreamException

require

public void require(int arg0,
                    String arg1,
                    String arg2)
             throws XMLStreamException
Specified by:
require in interface XMLStreamReader
Throws:
XMLStreamException

standaloneSet

public boolean standaloneSet()
Specified by:
standaloneSet in interface XMLStreamReader
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.