DOMStreamReader (Apache ServiceMix :: Components :: Shared Libraries :: SOAP Stack v2 2013.01.0.redhat-610394 API)

java.lang.Object
- org.apache.servicemix.soap.util.stax.DOMStreamReader

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader
```
public class DOMStreamReader
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader
```
Abstract logic for creating XMLStreamReader from DOM documents. Its works using adapters for Element, Node and Attribute ( @see ElementAdapter }

Author:

Tomasz Sztelak

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DOMStreamReader.DOMNamespaceContext

static class DOMStreamReader.ElementFrame

Nested Classes
Modifier and Type	Class and Description
`class`	`DOMStreamReader.DOMNamespaceContext`
`static class`	`DOMStreamReader.ElementFrame`

Field Summary

Fields
Modifier and Type Field and Description

java.util.Map properties
- 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

Fields
Modifier and Type	Field and Description
`java.util.Map`	`properties`

Constructor Summary

Constructors
Constructor and Description

DOMStreamReader(org.w3c.dom.Element element)

Constructors
Constructor and Description
`DOMStreamReader(org.w3c.dom.Element element)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected void`	`endElement()`
`int`	`getAttributeCount()`
`java.lang.String`	`getAttributeLocalName(int i)`
`javax.xml.namespace.QName`	`getAttributeName(int i)`
`java.lang.String`	`getAttributeNamespace(int i)`
`java.lang.String`	`getAttributePrefix(int i)`
`java.lang.String`	`getAttributeType(int i)`
`java.lang.String`	`getAttributeValue(int i)`
`java.lang.String`	`getAttributeValue(java.lang.String ns, java.lang.String local)`
`java.lang.String`	`getCharacterEncodingScheme()`
`protected int`	`getChildCount()`
`protected DOMStreamReader.ElementFrame`	`getChildFrame(int currentChild)`
`protected org.w3c.dom.Element`	`getCurrentElement()`
`protected DOMStreamReader.ElementFrame`	`getCurrentFrame()`
`org.w3c.dom.Document`	`getDocument()` Get the document associated with this stream.
`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 i)`
`java.lang.String`	`getNamespaceURI()`
`java.lang.String`	`getNamespaceURI(int i)`
`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 key)`
`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 i)`
`boolean`	`isCharacters()`
`boolean`	`isEndElement()`
`boolean`	`isStandalone()`
`boolean`	`isStartElement()`
`boolean`	`isWhiteSpace()`
`protected int`	`moveToChild(int currentChild)`
`protected void`	`newFrame(DOMStreamReader.ElementFrame frame)` Find name spaces declaration in attributes and move them to separate collection.
`int`	`next()`
`int`	`nextTag()`
`void`	`require(int arg0, java.lang.String arg1, java.lang.String arg2)`
`org.w3c.dom.Element`	`skipElement()`
`protected void`	`skipFrame()`
`boolean`	`standaloneSet()`
`static java.lang.String`	`toStaxType(short jdom)`

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

- Field Detail
  - properties
```
public java.util.Map properties
```
- Constructor Detail
  - DOMStreamReader
```
public DOMStreamReader(org.w3c.dom.Element element)
```
    Parameters:
    element -
- Method Detail
  - getCurrentFrame
```
protected DOMStreamReader.ElementFrame getCurrentFrame()
```
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
                             throws java.lang.IllegalArgumentException
```
    Specified by:
    
    getProperty in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    java.lang.IllegalArgumentException
  - next
```
public int next()
         throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    next in interface javax.xml.stream.XMLStreamReader
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - skipFrame
```
protected void skipFrame()
```
  - require
```
public void require(int arg0,
           java.lang.String arg1,
           java.lang.String arg2)
             throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    require 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
  - hasNext
```
public boolean hasNext()
                throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    hasNext 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
  - 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
  - isCharacters
```
public boolean isCharacters()
```
    Specified by:
    
    isCharacters in interface javax.xml.stream.XMLStreamReader
  - isWhiteSpace
```
public boolean isWhiteSpace()
```
    Specified by:
    
    isWhiteSpace in interface javax.xml.stream.XMLStreamReader
  - getEventType
```
public int getEventType()
```
    Specified by:
    
    getEventType 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
  - hasText
```
public boolean hasText()
```
    Specified by:
    
    hasText in interface javax.xml.stream.XMLStreamReader
  - getLocation
```
public javax.xml.stream.Location getLocation()
```
    Specified by:
    
    getLocation in interface javax.xml.stream.XMLStreamReader
  - hasName
```
public boolean hasName()
```
    Specified by:
    
    hasName 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
  - getCharacterEncodingScheme
```
public java.lang.String getCharacterEncodingScheme()
```
    Specified by:
    
    getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader
  - getDocument
```
public org.w3c.dom.Document getDocument()
```
    Get the document associated with this stream.
    
    Returns:
  - newFrame
```
protected void newFrame(DOMStreamReader.ElementFrame frame)
```
    Find name spaces declaration in attributes and move them to separate collection.
  - endElement
```
protected void endElement()
```
  - getCurrentElement
```
protected org.w3c.dom.Element getCurrentElement()
```
  - skipElement
```
public org.w3c.dom.Element skipElement()
```
  - getChildFrame
```
protected DOMStreamReader.ElementFrame getChildFrame(int currentChild)
```
  - getChildCount
```
protected int getChildCount()
```
  - moveToChild
```
protected int moveToChild(int currentChild)
```
  - 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
  - getNamespaceURI
```
public java.lang.String getNamespaceURI(java.lang.String prefix)
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getAttributeValue
```
public java.lang.String getAttributeValue(java.lang.String ns,
                                 java.lang.String local)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - getAttributeCount
```
public int getAttributeCount()
```
    Specified by:
    
    getAttributeCount in interface javax.xml.stream.XMLStreamReader
  - getAttributeName
```
public javax.xml.namespace.QName getAttributeName(int i)
```
    Specified by:
    
    getAttributeName in interface javax.xml.stream.XMLStreamReader
  - getAttributeNamespace
```
public java.lang.String getAttributeNamespace(int i)
```
    Specified by:
    
    getAttributeNamespace in interface javax.xml.stream.XMLStreamReader
  - getAttributeLocalName
```
public java.lang.String getAttributeLocalName(int i)
```
    Specified by:
    
    getAttributeLocalName in interface javax.xml.stream.XMLStreamReader
  - getAttributePrefix
```
public java.lang.String getAttributePrefix(int i)
```
    Specified by:
    
    getAttributePrefix in interface javax.xml.stream.XMLStreamReader
  - getAttributeType
```
public java.lang.String getAttributeType(int i)
```
    Specified by:
    
    getAttributeType in interface javax.xml.stream.XMLStreamReader
  - toStaxType
```
public static java.lang.String toStaxType(short jdom)
```
  - getAttributeValue
```
public java.lang.String getAttributeValue(int i)
```
    Specified by:
    
    getAttributeValue in interface javax.xml.stream.XMLStreamReader
  - isAttributeSpecified
```
public boolean isAttributeSpecified(int i)
```
    Specified by:
    
    isAttributeSpecified 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 i)
```
    Specified by:
    
    getNamespacePrefix in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public java.lang.String getNamespaceURI(int i)
```
    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
  - 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
  - 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
  - getEncoding
```
public java.lang.String getEncoding()
```
    Specified by:
    
    getEncoding in interface javax.xml.stream.XMLStreamReader
  - getName
```
public javax.xml.namespace.QName getName()
```
    Specified by:
    
    getName in interface javax.xml.stream.XMLStreamReader
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.xml.stream.XMLStreamReader
  - getNamespaceURI
```
public java.lang.String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface javax.xml.stream.XMLStreamReader
  - getPrefix
```
public java.lang.String getPrefix()
```
    Specified by:
    
    getPrefix in interface javax.xml.stream.XMLStreamReader
  - getPITarget
```
public java.lang.String getPITarget()
```
    Specified by:
    
    getPITarget in interface javax.xml.stream.XMLStreamReader
  - getPIData
```
public java.lang.String getPIData()
```
    Specified by:
    
    getPIData in interface javax.xml.stream.XMLStreamReader

Class DOMStreamReader

Nested Class Summary

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

properties

Constructor Detail

DOMStreamReader

Method Detail

getCurrentFrame

getProperty

next

skipFrame

require

nextTag

hasNext

close

isStartElement

isEndElement

isCharacters

isWhiteSpace

getEventType

getTextCharacters

hasText

getLocation

hasName

getVersion

isStandalone

standaloneSet

getCharacterEncodingScheme

getDocument

newFrame

endElement

getCurrentElement

skipElement

getChildFrame

getChildCount

moveToChild

getElementText

getNamespaceURI

getAttributeValue

getAttributeCount

getAttributeName

getAttributeNamespace

getAttributeLocalName

getAttributePrefix

getAttributeType

toStaxType

getAttributeValue

isAttributeSpecified

getNamespaceCount

getNamespacePrefix

getNamespaceURI

getNamespaceContext

getText

getTextCharacters

getTextStart

getTextLength

getEncoding

getName

getLocalName

getNamespaceURI

getPrefix

getPITarget

getPIData