org.apache.axiom.util.stax.dialect

Class Woodstox4StreamReaderWrapper

java.lang.Object

org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

org.apache.axiom.util.stax.dialect.StAX2StreamReaderWrapper

org.apache.axiom.util.stax.dialect.Woodstox4StreamReaderWrapper

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader, CharacterDataReader, DelegatingXMLStreamReader, DTDReader

class Woodstox4StreamReaderWrapper
extends StAX2StreamReaderWrapper
implements DelegatingXMLStreamReader, CharacterDataReader

Field Summary

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 inherited from interface org.apache.axiom.ext.stax.CharacterDataReader

PROPERTY

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

PROPERTY

Constructor Summary

Constructors

Constructor and Description
Woodstox4StreamReaderWrapper(javax.xml.stream.XMLStreamReader reader)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeNamespace(int index)
java.lang.String	getCharacterEncodingScheme()
java.lang.String	getEncoding()
javax.xml.namespace.NamespaceContext	getNamespaceContext()
java.lang.String	getNamespacePrefix(int index)
java.lang.String	getNamespaceURI()
java.lang.String	getNamespaceURI(java.lang.String prefix)
javax.xml.stream.XMLStreamReader	getParent() Get the parent stream reader.
java.lang.String	getPrefix()
java.lang.Object	getProperty(java.lang.String name)
java.lang.String	getVersion()
boolean	isCharacters()
boolean	isStandalone()
boolean	standaloneSet()
void	writeTextTo(java.io.Writer writer) Output the character data for the current event to the given writer.

Methods inherited from class org.apache.axiom.util.stax.dialect.StAX2StreamReaderWrapper

getPublicId, getRootName, getSystemId

Methods inherited from class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getElementText, getEventType, getLocalName, getLocation, getName, getNamespaceCount, getNamespaceURI, getPIData, getPITarget, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, hasName, hasNext, hasText, isAttributeSpecified, isEndElement, isStartElement, isWhiteSpace, next, nextTag, require

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.stream.XMLStreamReader

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getElementText, getEventType, getLocalName, getLocation, getName, getNamespaceCount, getNamespaceURI, getPIData, getPITarget, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, hasName, hasNext, hasText, isAttributeSpecified, isEndElement, isStartElement, isWhiteSpace, next, nextTag, require

Constructor Detail

Woodstox4StreamReaderWrapper

public Woodstox4StreamReaderWrapper(javax.xml.stream.XMLStreamReader reader)

Method Detail

getCharacterEncodingScheme

public java.lang.String getCharacterEncodingScheme()

Specified by:

getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader

Overrides:

getCharacterEncodingScheme in class XMLStreamReaderWrapper

getEncoding

public java.lang.String getEncoding()

Specified by:

getEncoding in interface javax.xml.stream.XMLStreamReader

Overrides:

getEncoding in class XMLStreamReaderWrapper

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface javax.xml.stream.XMLStreamReader

Overrides:

getVersion in class XMLStreamReaderWrapper

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface javax.xml.stream.XMLStreamReader

Overrides:

isStandalone in class XMLStreamReaderWrapper

standaloneSet

public boolean standaloneSet()

Specified by:

standaloneSet in interface javax.xml.stream.XMLStreamReader

Overrides:

standaloneSet in class XMLStreamReaderWrapper

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface javax.xml.stream.XMLStreamReader

Overrides:

isCharacters in class XMLStreamReaderWrapper

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface javax.xml.stream.XMLStreamReader

Overrides:

getPrefix in class XMLStreamReaderWrapper

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

Overrides:

getNamespaceURI in class XMLStreamReaderWrapper

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

Overrides:

getNamespaceURI in class XMLStreamReaderWrapper

getNamespacePrefix

public java.lang.String getNamespacePrefix(int index)

Specified by:

getNamespacePrefix in interface javax.xml.stream.XMLStreamReader

Overrides:

getNamespacePrefix in class XMLStreamReaderWrapper

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)

Specified by:

getAttributeNamespace in interface javax.xml.stream.XMLStreamReader

Overrides:

getAttributeNamespace in class XMLStreamReaderWrapper

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamReader

Overrides:

getNamespaceContext in class XMLStreamReaderWrapper

getParent

public javax.xml.stream.XMLStreamReader getParent()

Description copied from class: XMLStreamReaderWrapper

Get the parent stream reader. This method is declared as protected because it should only be used by subclasses. However, stream reader wrappers that can safely be unwrapped may implement the DelegatingXMLStreamReader interface to make this a public method. Note that a corresponding setParent method is intentionally omitted because XMLStreamReaderWrapper is immutable.

Specified by:

getParent in interface DelegatingXMLStreamReader

Overrides:

getParent in class XMLStreamReaderWrapper

Returns:

the parent stream reader that is wrapped by this object

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Specified by:

getProperty in interface javax.xml.stream.XMLStreamReader

Overrides:

getProperty in class StAX2StreamReaderWrapper

Throws:

java.lang.IllegalArgumentException

writeTextTo

public void writeTextTo(java.io.Writer writer)
                 throws javax.xml.stream.XMLStreamException,
                        java.io.IOException

Description copied from interface: CharacterDataReader

Output the character data for the current event to the given writer. In general, the implementation behaves such that reader.writeTextTo(writer) has the same effect as writer.write(reader.getText()). However, the implementation MAY choose to split the character data differently. E.g. it MAY write the character data in multiple chunks or it MAY choose to process more character data in a single event than would be returned by XMLStreamReader.getText(). Therefore, using this method together with XMLStreamReader.getText(), XMLStreamReader.getTextCharacters(), XMLStreamReader.getTextStart(), XMLStreamReader.getTextLength() or XMLStreamReader.getTextCharacters(int, char[], int, int) is not supported and may lead to undefined results.

The implementation SHOULD avoid any unnecessary conversions between strings and character arrays.

Specified by:

writeTextTo in interface CharacterDataReader

Parameters:

writer - the writer to write the character data to

Throws:

javax.xml.stream.XMLStreamException - if the underlying XML source is not well-formed

java.io.IOException - if an I/O error occurs when writing the character data