XMLFragmentStreamReader

java.lang.Object
- org.apache.axiom.util.stax.XMLFragmentStreamReader

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader
```
public class XMLFragmentStreamReader
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader
```
Wrapping XML stream reader that reads a single element from the underlying stream. It will generate START_DOCUMENT and END_DOCUMENT events as required to make the sequence of events appear as a complete document.
Assume for example that the parent reader is parsing the following document:
```
<a>text</a>
```
If the current event is  when the wrapper is created, it will produce the following sequence of events:
- A synthetic START_DOCUMENT event.
- START_ELEMENT, CHARACTERS and END_ELEMENT events for text. For these events, the wrapper directly delegates to the parent reader.
- A synthetic END_DOCUMENT event.
After all events have been consumed from the wrapper, the current event on the parent reader will be the event following the last END_ELEMENT of the fragment. In the example above this will be </a>.
The wrapper will release the reference to the parent reader when close() is called. For obvious reasons, the wrapper will never call XMLStreamReader.close() on the parent reader.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`depth`
`private javax.xml.stream.XMLStreamReader`	`parent`
`private int`	`state`
`private static int`	`STATE_END_DOCUMENT`
`private static int`	`STATE_FRAGMENT_END`
`private static int`	`STATE_IN_FRAGMENT`
`private static int`	`STATE_START_DOCUMENT`

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

XMLFragmentStreamReader(javax.xml.stream.XMLStreamReader parent)
Constructor.

Constructors
Constructor and Description
`XMLFragmentStreamReader(javax.xml.stream.XMLStreamReader parent)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`int`	`getAttributeCount()`
`java.lang.String`	`getAttributeLocalName(int index)`
`javax.xml.namespace.QName`	`getAttributeName(int index)`
`java.lang.String`	`getAttributeNamespace(int index)`
`java.lang.String`	`getAttributePrefix(int index)`
`java.lang.String`	`getAttributeType(int index)`
`java.lang.String`	`getAttributeValue(int index)`
`java.lang.String`	`getAttributeValue(java.lang.String namespaceURI, java.lang.String localName)`
`java.lang.String`	`getCharacterEncodingScheme()`
`java.lang.String`	`getElementText()`
`java.lang.String`	`getEncoding()`
`int`	`getEventType()`
`java.lang.String`	`getLocalName()`
`javax.xml.stream.Location`	`getLocation()`
`javax.xml.namespace.QName`	`getName()`
`javax.xml.namespace.NamespaceContext`	`getNamespaceContext()`
`int`	`getNamespaceCount()`
`java.lang.String`	`getNamespacePrefix(int index)`
`java.lang.String`	`getNamespaceURI()`
`java.lang.String`	`getNamespaceURI(int index)`
`java.lang.String`	`getNamespaceURI(java.lang.String prefix)`
`java.lang.String`	`getPIData()`
`java.lang.String`	`getPITarget()`
`java.lang.String`	`getPrefix()`
`java.lang.Object`	`getProperty(java.lang.String name)`
`java.lang.String`	`getText()`
`char[]`	`getTextCharacters()`
`int`	`getTextCharacters(int sourceStart, char[] target, int targetStart, int length)`
`int`	`getTextLength()`
`int`	`getTextStart()`
`java.lang.String`	`getVersion()`
`boolean`	`hasName()`
`boolean`	`hasNext()`
`boolean`	`hasText()`
`boolean`	`isAttributeSpecified(int index)`
`boolean`	`isCharacters()`
`boolean`	`isEndElement()`
`boolean`	`isStandalone()`
`boolean`	`isStartElement()`
`boolean`	`isWhiteSpace()`
`int`	`next()`
`int`	`nextTag()`
`void`	`require(int type, java.lang.String namespaceURI, java.lang.String localName)`
`boolean`	`standaloneSet()`

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

- Field Detail
  - STATE_START_DOCUMENT
```
private static final int STATE_START_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - STATE_IN_FRAGMENT
```
private static final int STATE_IN_FRAGMENT
```
    See Also:
    
    Constant Field Values
  - STATE_FRAGMENT_END
```
private static final int STATE_FRAGMENT_END
```
    See Also:
    
    Constant Field Values
  - STATE_END_DOCUMENT
```
private static final int STATE_END_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - parent
```
private javax.xml.stream.XMLStreamReader parent
```
  - state
```
private int state
```
  - depth
```
private int depth
```
- Constructor Detail
  - XMLFragmentStreamReader
```
public XMLFragmentStreamReader(javax.xml.stream.XMLStreamReader parent)
```
    Constructor.
    
    Parameters:
    
    parent - the parent reader to read the fragment from
    
    Throws:
    
    java.lang.IllegalStateException - if the current event on the parent is not a START_ELEMENT
- Method Detail
  - getEventType
```
public int getEventType()
```
    Specified by:
    
    getEventType in interface javax.xml.stream.XMLStreamReader
  - 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
    
    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 java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException
```
    Specified by:
    
    getProperty in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    java.lang.IllegalArgumentException
  - getCharacterEncodingScheme
```
public java.lang.String getCharacterEncodingScheme()
```
    Specified by:
    
    getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader
  - getEncoding
```
public java.lang.String getEncoding()
```
    Specified by:
    
    getEncoding in interface javax.xml.stream.XMLStreamReader
  - getVersion
```
public java.lang.String getVersion()
```
    Specified by:
    
    getVersion 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
  - getLocation
```
public javax.xml.stream.Location getLocation()
```
    Specified by:
    
    getLocation in interface javax.xml.stream.XMLStreamReader
  - getAttributeCount
```
public int getAttributeCount()
```
    Specified by:
    
    getAttributeCount in interface javax.xml.stream.XMLStreamReader
  - getAttributeLocalName
```
public java.lang.String getAttributeLocalName(int index)
```
    Specified by:
    
    getAttributeLocalName in interface javax.xml.stream.XMLStreamReader
  - getAttributeName
```
public javax.xml.namespace.QName getAttributeName(int index)
```
    Specified by:
    
    getAttributeName in interface javax.xml.stream.XMLStreamReader
  - getAttributeNamespace
```
public java.lang.String getAttributeNamespace(int index)
```
    Specified by:
    
    getAttributeNamespace in interface javax.xml.stream.XMLStreamReader
  - getAttributePrefix
```
public java.lang.String getAttributePrefix(int index)
```
    Specified by:
    
    getAttributePrefix in interface javax.xml.stream.XMLStreamReader
  - getAttributeType
```
public java.lang.String getAttributeType(int index)
```
    Specified by:
    
    getAttributeType in interface javax.xml.stream.XMLStreamReader
  - getAttributeValue
```
public java.lang.String getAttributeValue(int index)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - isAttributeSpecified
```
public boolean isAttributeSpecified(int index)
```
    Specified by:
    
    isAttributeSpecified in interface javax.xml.stream.XMLStreamReader
  - getAttributeValue
```
public java.lang.String getAttributeValue(java.lang.String namespaceURI,
                                          java.lang.String localName)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - getElementText
```
public java.lang.String getElementText()
                                throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    getElementText in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.xml.stream.XMLStreamReader
  - getName
```
public javax.xml.namespace.QName getName()
```
    Specified by:
    
    getName in interface javax.xml.stream.XMLStreamReader
  - getPrefix
```
public java.lang.String getPrefix()
```
    Specified by:
    
    getPrefix in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public java.lang.String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getNamespaceCount
```
public int getNamespaceCount()
```
    Specified by:
    
    getNamespaceCount in interface javax.xml.stream.XMLStreamReader
  - getNamespacePrefix
```
public java.lang.String getNamespacePrefix(int index)
```
    Specified by:
    
    getNamespacePrefix in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public java.lang.String getNamespaceURI(int index)
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public java.lang.String getNamespaceURI(java.lang.String prefix)
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getNamespaceContext
```
public javax.xml.namespace.NamespaceContext getNamespaceContext()
```
    Specified by:
    
    getNamespaceContext in interface javax.xml.stream.XMLStreamReader
  - getPIData
```
public java.lang.String getPIData()
```
    Specified by:
    
    getPIData in interface javax.xml.stream.XMLStreamReader
  - getPITarget
```
public java.lang.String getPITarget()
```
    Specified by:
    
    getPITarget in interface javax.xml.stream.XMLStreamReader
  - getText
```
public java.lang.String getText()
```
    Specified by:
    
    getText in interface javax.xml.stream.XMLStreamReader
  - getTextCharacters
```
public char[] getTextCharacters()
```
    Specified by:
    
    getTextCharacters 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
  - getTextLength
```
public int getTextLength()
```
    Specified by:
    
    getTextLength in interface javax.xml.stream.XMLStreamReader
  - getTextStart
```
public int getTextStart()
```
    Specified by:
    
    getTextStart in interface javax.xml.stream.XMLStreamReader
  - hasName
```
public boolean hasName()
```
    Specified by:
    
    hasName 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
  - hasText
```
public boolean hasText()
```
    Specified by:
    
    hasText in interface javax.xml.stream.XMLStreamReader
  - isCharacters
```
public boolean isCharacters()
```
    Specified by:
    
    isCharacters in interface javax.xml.stream.XMLStreamReader
  - isStartElement
```
public boolean isStartElement()
```
    Specified by:
    
    isStartElement in interface javax.xml.stream.XMLStreamReader
  - isEndElement
```
public boolean isEndElement()
```
    Specified by:
    
    isEndElement in interface javax.xml.stream.XMLStreamReader
  - isWhiteSpace
```
public boolean isWhiteSpace()
```
    Specified by:
    
    isWhiteSpace in interface javax.xml.stream.XMLStreamReader
  - require
```
public void require(int type,
                    java.lang.String namespaceURI,
                    java.lang.String localName)
             throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    require in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException

Class XMLFragmentStreamReader

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_START_DOCUMENT

STATE_IN_FRAGMENT

STATE_FRAGMENT_END

STATE_END_DOCUMENT

parent

state

depth

Constructor Detail

XMLFragmentStreamReader

Method Detail

getEventType

next

nextTag

close

getProperty

getCharacterEncodingScheme

getEncoding

getVersion

isStandalone

standaloneSet

getLocation

getAttributeCount

getAttributeLocalName

getAttributeName

getAttributeNamespace

getAttributePrefix

getAttributeType

getAttributeValue

isAttributeSpecified

getAttributeValue

getElementText

getLocalName

getName

getPrefix

getNamespaceURI

getNamespaceCount

getNamespacePrefix

getNamespaceURI

getNamespaceURI

getNamespaceContext

getPIData

getPITarget

getText

getTextCharacters

getTextCharacters

getTextLength

getTextStart

hasName

hasNext

hasText

isCharacters

isStartElement

isEndElement

isWhiteSpace

require