PullSerializer (OM Aspects API)

java.lang.Object
- org.apache.axiom.util.stax.AbstractXMLStreamReader
- - org.apache.axiom.om.impl.common.serializer.pull.PullSerializer

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader, org.apache.axiom.ext.stax.CharacterDataReader, org.apache.axiom.ext.stax.datahandler.DataHandlerReader, org.apache.axiom.ext.stax.DTDReader
```
public final class PullSerializer
extends org.apache.axiom.util.stax.AbstractXMLStreamReader
implements org.apache.axiom.ext.stax.datahandler.DataHandlerReader, org.apache.axiom.ext.stax.DTDReader, org.apache.axiom.ext.stax.CharacterDataReader
```
XMLStreamReader implementation that generates events from a given Axiom tree.

Field Summary
- Fields inherited from interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  PROPERTY
- Fields inherited from interface org.apache.axiom.ext.stax.DTDReader
  PROPERTY
- Fields inherited from interface org.apache.axiom.ext.stax.CharacterDataReader
  PROPERTY
- 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

Constructor Summary

Constructors
Constructor and Description

PullSerializer(org.apache.axiom.core.CoreParentNode startNode, boolean cache, boolean preserveNamespaceContext)

Constructors
Constructor and Description
`PullSerializer(org.apache.axiom.core.CoreParentNode startNode, boolean cache, boolean preserveNamespaceContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`int`	`getAttributeCount()`
`String`	`getAttributeLocalName(int index)`
`QName`	`getAttributeName(int index)`
`String`	`getAttributeNamespace(int index)`
`String`	`getAttributePrefix(int index)`
`String`	`getAttributeType(int index)`
`String`	`getAttributeValue(int index)`
`String`	`getAttributeValue(String namespaceURI, String localName)`
`String`	`getCharacterEncodingScheme()`
`String`	`getContentID()`
`javax.activation.DataHandler`	`getDataHandler()`
`org.apache.axiom.ext.stax.datahandler.DataHandlerProvider`	`getDataHandlerProvider()`
`String`	`getElementText()`
`String`	`getEncoding()`
`int`	`getEventType()`
`String`	`getLocalName()`
`QName`	`getName()`
`NamespaceContext`	`getNamespaceContext()`
`int`	`getNamespaceCount()`
`String`	`getNamespacePrefix(int index)`
`String`	`getNamespaceURI()`
`String`	`getNamespaceURI(int index)`
`String`	`getNamespaceURI(String prefix)`
`String`	`getPIData()`
`String`	`getPITarget()`
`String`	`getPrefix()`
`Object`	`getProperty(String name)`
`String`	`getPublicId()`
`String`	`getRootName()`
`String`	`getSystemId()`
`String`	`getText()`
`char[]`	`getTextCharacters()`
`int`	`getTextCharacters(int sourceStart, char[] target, int targetStart, int length)`
`int`	`getTextLength()`
`int`	`getTextStart()`
`String`	`getVersion()`
`boolean`	`hasNext()`
`boolean`	`isAttributeSpecified(int index)`
`boolean`	`isBinary()`
`boolean`	`isDeferred()`
`boolean`	`isOptimized()`
`boolean`	`isStandalone()`
`boolean`	`isWhiteSpace()`
`int`	`next()`
`int`	`nextTag()`
`boolean`	`standaloneSet()`
`void`	`writeTextTo(Writer writer)`

Methods inherited from class org.apache.axiom.util.stax.AbstractXMLStreamReader
getLocation, hasName, hasText, isCharacters, isEndElement, isStartElement, require

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

- Constructor Detail
  - PullSerializer
```
public PullSerializer(org.apache.axiom.core.CoreParentNode startNode,
              boolean cache,
              boolean preserveNamespaceContext)
```
- Method Detail
  - getEventType
```
public int getEventType()
```
    Specified by:
    
    getEventType in interface javax.xml.stream.XMLStreamReader
  - hasNext
```
public boolean hasNext()
                throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    hasNext in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - next
```
public int next()
         throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    next in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - nextTag
```
public int nextTag()
            throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    nextTag in interface javax.xml.stream.XMLStreamReader
    
    Overrides:
    
    nextTag in class org.apache.axiom.util.stax.AbstractXMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - close
```
public void close()
           throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    close in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - getProperty
```
public Object getProperty(String name)
```
    Specified by:
    
    getProperty in interface javax.xml.stream.XMLStreamReader
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface javax.xml.stream.XMLStreamReader
  - getCharacterEncodingScheme
```
public String getCharacterEncodingScheme()
```
    Specified by:
    
    getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader
  - getEncoding
```
public String getEncoding()
```
    Specified by:
    
    getEncoding in interface javax.xml.stream.XMLStreamReader
  - isStandalone
```
public boolean isStandalone()
```
    Specified by:
    
    isStandalone in interface javax.xml.stream.XMLStreamReader
  - standaloneSet
```
public boolean standaloneSet()
```
    Specified by:
    
    standaloneSet in interface javax.xml.stream.XMLStreamReader
  - getPrefix
```
public String getPrefix()
```
    Specified by:
    
    getPrefix in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.xml.stream.XMLStreamReader
  - getName
```
public QName getName()
```
    Specified by:
    
    getName in interface javax.xml.stream.XMLStreamReader
  - getNamespaceCount
```
public int getNamespaceCount()
```
    Specified by:
    
    getNamespaceCount in interface javax.xml.stream.XMLStreamReader
  - getNamespacePrefix
```
public String getNamespacePrefix(int index)
```
    Specified by:
    
    getNamespacePrefix in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public String getNamespaceURI(int index)
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getAttributeCount
```
public int getAttributeCount()
```
    Specified by:
    
    getAttributeCount in interface javax.xml.stream.XMLStreamReader
  - getAttributePrefix
```
public String getAttributePrefix(int index)
```
    Specified by:
    
    getAttributePrefix in interface javax.xml.stream.XMLStreamReader
  - getAttributeNamespace
```
public String getAttributeNamespace(int index)
```
    Specified by:
    
    getAttributeNamespace in interface javax.xml.stream.XMLStreamReader
  - getAttributeLocalName
```
public String getAttributeLocalName(int index)
```
    Specified by:
    
    getAttributeLocalName in interface javax.xml.stream.XMLStreamReader
  - getAttributeName
```
public QName getAttributeName(int index)
```
    Specified by:
    
    getAttributeName in interface javax.xml.stream.XMLStreamReader
  - isAttributeSpecified
```
public boolean isAttributeSpecified(int index)
```
    Specified by:
    
    isAttributeSpecified in interface javax.xml.stream.XMLStreamReader
  - getAttributeType
```
public String getAttributeType(int index)
```
    Specified by:
    
    getAttributeType in interface javax.xml.stream.XMLStreamReader
  - getAttributeValue
```
public String getAttributeValue(int index)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - getAttributeValue
```
public String getAttributeValue(String namespaceURI,
                       String localName)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - getNamespaceContext
```
public NamespaceContext getNamespaceContext()
```
    Specified by:
    
    getNamespaceContext in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public String getNamespaceURI(String prefix)
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getElementText
```
public String getElementText()
                      throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    getElementText in interface javax.xml.stream.XMLStreamReader
    
    Overrides:
    
    getElementText in class org.apache.axiom.util.stax.AbstractXMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - getText
```
public String getText()
```
    Specified by:
    
    getText in interface javax.xml.stream.XMLStreamReader
  - getTextCharacters
```
public char[] getTextCharacters()
```
    Specified by:
    
    getTextCharacters in interface javax.xml.stream.XMLStreamReader
  - getTextStart
```
public int getTextStart()
```
    Specified by:
    
    getTextStart in interface javax.xml.stream.XMLStreamReader
  - getTextLength
```
public int getTextLength()
```
    Specified by:
    
    getTextLength in interface javax.xml.stream.XMLStreamReader
  - getTextCharacters
```
public int getTextCharacters(int sourceStart,
                    char[] target,
                    int targetStart,
                    int length)
                      throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    getTextCharacters in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - isWhiteSpace
```
public boolean isWhiteSpace()
```
    Specified by:
    
    isWhiteSpace in interface javax.xml.stream.XMLStreamReader
    
    Overrides:
    
    isWhiteSpace in class org.apache.axiom.util.stax.AbstractXMLStreamReader
  - getPIData
```
public String getPIData()
```
    Specified by:
    
    getPIData in interface javax.xml.stream.XMLStreamReader
  - getPITarget
```
public String getPITarget()
```
    Specified by:
    
    getPITarget in interface javax.xml.stream.XMLStreamReader
  - isBinary
```
public boolean isBinary()
```
    Specified by:
    
    isBinary in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  - isOptimized
```
public boolean isOptimized()
```
    Specified by:
    
    isOptimized in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  - isDeferred
```
public boolean isDeferred()
```
    Specified by:
    
    isDeferred in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  - getContentID
```
public String getContentID()
```
    Specified by:
    
    getContentID in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  - getDataHandler
```
public javax.activation.DataHandler getDataHandler()
                                            throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    getDataHandler in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - getDataHandlerProvider
```
public org.apache.axiom.ext.stax.datahandler.DataHandlerProvider getDataHandlerProvider()
```
    Specified by:
    
    getDataHandlerProvider in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader
  - getRootName
```
public String getRootName()
```
    Specified by:
    
    getRootName in interface org.apache.axiom.ext.stax.DTDReader
  - getPublicId
```
public String getPublicId()
```
    Specified by:
    
    getPublicId in interface org.apache.axiom.ext.stax.DTDReader
  - getSystemId
```
public String getSystemId()
```
    Specified by:
    
    getSystemId in interface org.apache.axiom.ext.stax.DTDReader
  - writeTextTo
```
public void writeTextTo(Writer writer)
                 throws javax.xml.stream.XMLStreamException,
                        IOException
```
    Specified by:
    
    writeTextTo in interface org.apache.axiom.ext.stax.CharacterDataReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
    
    IOException

Class PullSerializer

Field Summary

Fields inherited from interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

Fields inherited from interface org.apache.axiom.ext.stax.DTDReader

Fields inherited from interface org.apache.axiom.ext.stax.CharacterDataReader

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

Methods inherited from class org.apache.axiom.util.stax.AbstractXMLStreamReader

Methods inherited from class java.lang.Object

Constructor Detail

PullSerializer

Method Detail

getEventType

hasNext

next

nextTag

close

getProperty

getVersion

getCharacterEncodingScheme

getEncoding

isStandalone

standaloneSet

getPrefix

getNamespaceURI

getLocalName

getName

getNamespaceCount

getNamespacePrefix

getNamespaceURI

getAttributeCount

getAttributePrefix

getAttributeNamespace

getAttributeLocalName

getAttributeName

isAttributeSpecified

getAttributeType

getAttributeValue

getAttributeValue

getNamespaceContext

getNamespaceURI

getElementText

getText

getTextCharacters

getTextStart

getTextLength

getTextCharacters

isWhiteSpace

getPIData

getPITarget

isBinary

isOptimized

isDeferred

getContentID

getDataHandler

getDataHandlerProvider

getRootName

getPublicId

getSystemId

writeTextTo