Package com.fasterxml.aalto.stax
Class StreamReaderImpl
- java.lang.Object
-
- com.fasterxml.aalto.stax.StreamReaderImpl
-
- All Implemented Interfaces:
javax.xml.stream.XMLStreamConstants,javax.xml.stream.XMLStreamReader,org.codehaus.stax2.AttributeInfo,org.codehaus.stax2.DTDInfo,org.codehaus.stax2.LocationInfo,org.codehaus.stax2.typed.TypedXMLStreamReader,org.codehaus.stax2.validation.Validatable,org.codehaus.stax2.XMLStreamReader2
- Direct Known Subclasses:
AsyncStreamReaderImpl
public class StreamReaderImpl extends java.lang.Object implements org.codehaus.stax2.XMLStreamReader2, org.codehaus.stax2.AttributeInfo, org.codehaus.stax2.DTDInfo, org.codehaus.stax2.LocationInfoBasic backend-independentXMLStreamReaderimplementation. While the read implements Stax API, most of real work is delegated to input (and thereby, encoding) specific backend implementations.
-
-
Field Summary
Fields Modifier and Type Field Description protected int_attrCountIf the current event isSTART_ELEMENT, number of attributes the start element has.protected org.codehaus.stax2.ri.typed.CharArrayBase64Decoder_base64DecoderLazily-constructed decoder object for decoding base64 encoded element binary content.protected boolean_cfgCoalesceTextprotected boolean_cfgReportTextAsCharsprotected PName_currNamePrefixed name associated with the current event, if any.protected int_currTokenprotected org.codehaus.stax2.ri.typed.ValueDecoderFactory_decoderFactoryFactory used for constructing decoders we need for typed accessprotected PName_dtdRootNamePrefixed root-name DOCTYPE declaration gave us, if any (note: also serves as a marker to know if we have seen DOCTYPE yet)protected int_parseStateMain parsing/tokenization state (STATE_xxx)protected XmlScanner_scannerUnderlying XML scannerprivate static intMASK_GET_ELEMENT_TEXTprivate static intMASK_GET_TEXTBitmask for determining if it's ok to call 'getText'private static intMASK_GET_TEXT_WITH_WRITERThis mask is used with Stax2 getText() method (one that takes Writer as an argument): accepts even wider range of event types.private static intMASK_GET_TEXT_XXXBitmask for determining if it's ok to call 'getTextXXX' methods (not including 'getText' itself)private static intMASK_TYPED_ACCESS_ARRAYprivate static intMASK_TYPED_ACCESS_BINARY(package private) static intSTATE_CLOSED(package private) static intSTATE_EPILOG(package private) static intSTATE_PROLOG(package private) static intSTATE_TREE
-
Constructor Summary
Constructors Constructor Description StreamReaderImpl(XmlScanner scanner)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected org.codehaus.stax2.ri.typed.CharArrayBase64Decoder_base64Decoder()protected void_closeScanner(boolean forceStreamClose)Method called to close scanner, by asking it to release resource it has, and potentially also close the underlying stream.private org.codehaus.stax2.typed.TypedXMLStreamException_constructTypeException(java.lang.IllegalArgumentException iae, java.lang.String lexicalValue)Method called to wrap or convert given conversion-fail exception into a fullTypedXMLStreamException.private org.codehaus.stax2.typed.TypedXMLStreamException_constructTypeException(java.lang.String msg, java.lang.String lexicalValue)protected javax.xml.stream.XMLStreamException_constructUnexpectedInTyped(int nextToken)protected org.codehaus.stax2.ri.typed.ValueDecoderFactory_decoderFactory()private void_handleEmptyValue(org.codehaus.stax2.typed.TypedValueDecoder dec)Method called to handle value that has empty String as representation.protected void_reportNonTextEvent(int type)Helper method called whengetElementText()(et al) method encounters a token type it should not, during text coalescingvoidclose()Note: as per StAX 1.0 specs, this method does NOT close the underlying input reader.voidcloseCompletely()static StreamReaderImplconstruct(InputBootstrapper bs)intfindAttributeIndex(java.lang.String nsURI, java.lang.String localName)voidgetAttributeAs(int index, org.codehaus.stax2.typed.TypedValueDecoder tvd)intgetAttributeAsArray(int index, org.codehaus.stax2.typed.TypedArrayDecoder tad)Method that allows reading contents of an attribute as an array of whitespace-separate tokens, decoded using specified decoder.byte[]getAttributeAsBinary(int index)byte[]getAttributeAsBinary(int index, org.codehaus.stax2.typed.Base64Variant v)booleangetAttributeAsBoolean(int index)java.math.BigDecimalgetAttributeAsDecimal(int index)doublegetAttributeAsDouble(int index)double[]getAttributeAsDoubleArray(int index)floatgetAttributeAsFloat(int index)float[]getAttributeAsFloatArray(int index)intgetAttributeAsInt(int index)int[]getAttributeAsIntArray(int index)java.math.BigIntegergetAttributeAsInteger(int index)longgetAttributeAsLong(int index)long[]getAttributeAsLongArray(int index)javax.xml.namespace.QNamegetAttributeAsQName(int index)intgetAttributeCount()intgetAttributeIndex(java.lang.String namespaceURI, java.lang.String localName)org.codehaus.stax2.AttributeInfogetAttributeInfo()java.lang.StringgetAttributeLocalName(int index)javax.xml.namespace.QNamegetAttributeName(int index)java.lang.StringgetAttributeNamespace(int index)java.lang.StringgetAttributePrefix(int index)java.lang.StringgetAttributeType(int index)java.lang.StringgetAttributeValue(int index)java.lang.StringgetAttributeValue(java.lang.String nsURI, java.lang.String localName)java.lang.StringgetCharacterEncodingScheme()As per Stax (1.0) specs, needs to return whatever xml declaration claimed encoding is, if any; or null if no xml declaration found.ReaderConfiggetConfig()org.codehaus.stax2.XMLStreamLocation2getCurrentLocation()intgetDepth()org.codehaus.stax2.DTDInfogetDTDInfo()Since this class implementsDTDInfo, method can just returnthis.java.lang.StringgetDTDInternalSubset()java.lang.StringgetDTDPublicId()java.lang.StringgetDTDRootName()java.lang.StringgetDTDSystemId()voidgetElementAs(org.codehaus.stax2.typed.TypedValueDecoder tvd)byte[]getElementAsBinary()byte[]getElementAsBinary(org.codehaus.stax2.typed.Base64Variant v)booleangetElementAsBoolean()java.math.BigDecimalgetElementAsDecimal()doublegetElementAsDouble()floatgetElementAsFloat()intgetElementAsInt()java.math.BigIntegergetElementAsInteger()longgetElementAsLong()javax.xml.namespace.QNamegetElementAsQName()java.lang.StringgetElementText()From StAX specs: Reads the content of a text-only element, an exception is thrown if this is not a text-only element.java.lang.StringgetEncoding()As per Stax (1.0) specs, needs to return whatever parser determined the encoding was, if it was able to figure it out.longgetEndingByteOffset()longgetEndingCharOffset()org.codehaus.stax2.XMLStreamLocation2getEndLocation()intgetEventType()Returns type of the last event returned; or START_DOCUMENT before any events has been explicitly returned.java.lang.ObjectgetFeature(java.lang.String name)Deprecated.intgetIdAttributeIndex()protected javax.xml.stream.LocationgetLastCharLocation()java.lang.StringgetLocalName()javax.xml.stream.LocationgetLocation()org.codehaus.stax2.LocationInfogetLocationInfo()Location information is always accessible, for this reader.javax.xml.namespace.QNamegetName()javax.xml.namespace.NamespaceContextgetNamespaceContext()intgetNamespaceCount()java.lang.StringgetNamespacePrefix(int index)java.lang.StringgetNamespaceURI()java.lang.StringgetNamespaceURI(int index)java.lang.StringgetNamespaceURI(java.lang.String prefix)javax.xml.namespace.NamespaceContextgetNonTransientNamespaceContext()intgetNotationAttributeIndex()java.lang.StringgetPIData()java.lang.StringgetPITarget()java.lang.StringgetPrefix()java.lang.StringgetPrefixedName()java.lang.ObjectgetProcessedDTD()Note: DTD-handling sub-classes need to override this method.org.codehaus.stax2.validation.DTDValidationSchemagetProcessedDTDSchema()Sub-class will override this methodjava.lang.ObjectgetProperty(java.lang.String name)XmlScannergetScanner()Should not really be public, but needed by SAX codelonggetStartingByteOffset()longgetStartingCharOffset()org.codehaus.stax2.XMLStreamLocation2getStartLocation()java.lang.StringgetText()intgetText(java.io.Writer w, boolean preserveContents)Method similar togetText(), except that it just uses provided Writer to write all textual content.char[]getTextCharacters()intgetTextCharacters(int srcStart, char[] target, int targetStart, int len)intgetTextLength()intgetTextStart()java.lang.StringgetVersion()protected inthandlePrologEoi(boolean isProlog)protected voidhandleTreeEoi()Method called when hitting an end-of-input within tree, after a valid tokenbooleanhasName()booleanhasNext()booleanhasText()booleanisAttributeSpecified(int index)booleanisCharacters()booleanisEmptyElement()booleanisEndElement()booleanisPropertySupported(java.lang.String name)booleanisStandalone()booleanisStartElement()booleanisWhiteSpace()intnext()intnextTag()intreadElementAsArray(org.codehaus.stax2.typed.TypedArrayDecoder dec)intreadElementAsBinary(byte[] resultBuffer, int offset, int maxLength)intreadElementAsBinary(byte[] resultBuffer, int offset, int maxLength, org.codehaus.stax2.typed.Base64Variant v)intreadElementAsDoubleArray(double[] value, int from, int length)intreadElementAsFloatArray(float[] value, int from, int length)intreadElementAsIntArray(int[] value, int from, int length)intreadElementAsLongArray(long[] value, int from, int length)protected voidreportInvalidAttrIndex(int index)voidrequire(int type, java.lang.String nsUri, java.lang.String localName)voidsetFeature(java.lang.String name, java.lang.Object value)Deprecated.booleansetProperty(java.lang.String name, java.lang.Object value)org.codehaus.stax2.validation.ValidationProblemHandlersetValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)voidskipElement()booleanstandaloneSet()org.codehaus.stax2.validation.XMLValidatorstopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)org.codehaus.stax2.validation.XMLValidatorstopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator)protected voidthrowFromIOE(java.io.IOException ioe)private voidthrowNotTextual(int type)private voidthrowNotTextXxx(int type)protected voidthrowUnexpectedEOI(java.lang.String msg)protected voidthrowWfe(java.lang.String msg)Throws generic parse error with specified message and current parsing location.java.lang.StringtoString()org.codehaus.stax2.validation.XMLValidatorvalidateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)protected javax.xml.namespace.QNameverifyQName(javax.xml.namespace.QName n)
-
-
-
Field Detail
-
STATE_PROLOG
static final int STATE_PROLOG
- See Also:
- Constant Field Values
-
STATE_TREE
static final int STATE_TREE
- See Also:
- Constant Field Values
-
STATE_EPILOG
static final int STATE_EPILOG
- See Also:
- Constant Field Values
-
STATE_CLOSED
static final int STATE_CLOSED
- See Also:
- Constant Field Values
-
_scanner
protected final XmlScanner _scanner
Underlying XML scanner
-
_cfgCoalesceText
protected final boolean _cfgCoalesceText
-
_cfgReportTextAsChars
protected final boolean _cfgReportTextAsChars
-
_currToken
protected int _currToken
-
_parseState
protected int _parseState
Main parsing/tokenization state (STATE_xxx)
-
_currName
protected PName _currName
Prefixed name associated with the current event, if any.
-
_attrCount
protected int _attrCount
If the current event isSTART_ELEMENT, number of attributes the start element has. Otherwise undefined. Updated by reader, to make index checks for other attribute access methods simpler.
-
_decoderFactory
protected org.codehaus.stax2.ri.typed.ValueDecoderFactory _decoderFactory
Factory used for constructing decoders we need for typed access
-
_base64Decoder
protected org.codehaus.stax2.ri.typed.CharArrayBase64Decoder _base64Decoder
Lazily-constructed decoder object for decoding base64 encoded element binary content.
-
_dtdRootName
protected PName _dtdRootName
Prefixed root-name DOCTYPE declaration gave us, if any (note: also serves as a marker to know if we have seen DOCTYPE yet)
-
MASK_GET_TEXT
private static final int MASK_GET_TEXT
Bitmask for determining if it's ok to call 'getText'- See Also:
- Constant Field Values
-
MASK_GET_TEXT_XXX
private static final int MASK_GET_TEXT_XXX
Bitmask for determining if it's ok to call 'getTextXXX' methods (not including 'getText' itself)- See Also:
- Constant Field Values
-
MASK_GET_TEXT_WITH_WRITER
private static final int MASK_GET_TEXT_WITH_WRITER
This mask is used with Stax2 getText() method (one that takes Writer as an argument): accepts even wider range of event types.- See Also:
- Constant Field Values
-
MASK_GET_ELEMENT_TEXT
private static final int MASK_GET_ELEMENT_TEXT
- See Also:
- Constant Field Values
-
MASK_TYPED_ACCESS_ARRAY
private static final int MASK_TYPED_ACCESS_ARRAY
- See Also:
- Constant Field Values
-
MASK_TYPED_ACCESS_BINARY
private static final int MASK_TYPED_ACCESS_BINARY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StreamReaderImpl
public StreamReaderImpl(XmlScanner scanner)
-
-
Method Detail
-
construct
public static StreamReaderImpl construct(InputBootstrapper bs) throws javax.xml.stream.XMLStreamException
- Throws:
javax.xml.stream.XMLStreamException
-
getScanner
public XmlScanner getScanner()
Should not really be public, but needed by SAX code
-
getCharacterEncodingScheme
public final java.lang.String getCharacterEncodingScheme()
As per Stax (1.0) specs, needs to return whatever xml declaration claimed encoding is, if any; or null if no xml declaration found.Note: method name is rather confusing (compare to
getEncoding()).- Specified by:
getCharacterEncodingSchemein interfacejavax.xml.stream.XMLStreamReader
-
getEncoding
public final java.lang.String getEncoding()
As per Stax (1.0) specs, needs to return whatever parser determined the encoding was, if it was able to figure it out. If not (there are cases where this can not be found; specifically when being passed aReader), it should return null.- Specified by:
getEncodingin interfacejavax.xml.stream.XMLStreamReader
-
getVersion
public java.lang.String getVersion()
- Specified by:
getVersionin interfacejavax.xml.stream.XMLStreamReader
-
isStandalone
public final boolean isStandalone()
- Specified by:
isStandalonein interfacejavax.xml.stream.XMLStreamReader
-
standaloneSet
public final boolean standaloneSet()
- Specified by:
standaloneSetin interfacejavax.xml.stream.XMLStreamReader
-
getProperty
public java.lang.Object getProperty(java.lang.String name)
- Specified by:
getPropertyin interfacejavax.xml.stream.XMLStreamReader
-
getConfig
public ReaderConfig getConfig()
-
getAttributeCount
public final int getAttributeCount()
- Specified by:
getAttributeCountin interfaceorg.codehaus.stax2.AttributeInfo- Specified by:
getAttributeCountin interfacejavax.xml.stream.XMLStreamReader
-
getAttributeLocalName
public final java.lang.String getAttributeLocalName(int index)
- Specified by:
getAttributeLocalNamein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeName
public final javax.xml.namespace.QName getAttributeName(int index)
- Specified by:
getAttributeNamein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeNamespace
public final java.lang.String getAttributeNamespace(int index)
- Specified by:
getAttributeNamespacein interfacejavax.xml.stream.XMLStreamReader
-
getAttributePrefix
public final java.lang.String getAttributePrefix(int index)
- Specified by:
getAttributePrefixin interfacejavax.xml.stream.XMLStreamReader
-
getAttributeType
public final java.lang.String getAttributeType(int index)
- Specified by:
getAttributeTypein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeValue
public final java.lang.String getAttributeValue(int index)
- Specified by:
getAttributeValuein interfacejavax.xml.stream.XMLStreamReader
-
getAttributeValue
public final java.lang.String getAttributeValue(java.lang.String nsURI, java.lang.String localName)- Specified by:
getAttributeValuein interfacejavax.xml.stream.XMLStreamReader
-
getElementText
public final java.lang.String getElementText() throws javax.xml.stream.XMLStreamExceptionFrom StAX specs:Reads the content of a text-only element, an exception is thrown if this is not a text-only element. Regardless of value of javax.xml.stream.isCoalescing this method always returns coalesced content.
Precondition: the current event is START_ELEMENT.
Postcondition: the current event is the corresponding END_ELEMENT.- Specified by:
getElementTextin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getEventType
public final int getEventType()
Returns type of the last event returned; or START_DOCUMENT before any events has been explicitly returned.- Specified by:
getEventTypein interfacejavax.xml.stream.XMLStreamReader
-
getLocalName
public final java.lang.String getLocalName()
- Specified by:
getLocalNamein interfacejavax.xml.stream.XMLStreamReader
-
getName
public final javax.xml.namespace.QName getName()
- Specified by:
getNamein interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceContext
public final javax.xml.namespace.NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContextin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceCount
public final int getNamespaceCount()
- Specified by:
getNamespaceCountin interfacejavax.xml.stream.XMLStreamReader
-
getNamespacePrefix
public final java.lang.String getNamespacePrefix(int index)
- Specified by:
getNamespacePrefixin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceURI
public final java.lang.String getNamespaceURI()
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceURI
public final java.lang.String getNamespaceURI(int index)
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
getNamespaceURI
public final java.lang.String getNamespaceURI(java.lang.String prefix)
- Specified by:
getNamespaceURIin interfacejavax.xml.stream.XMLStreamReader
-
getPIData
public final java.lang.String getPIData()
- Specified by:
getPIDatain interfacejavax.xml.stream.XMLStreamReader
-
getPITarget
public final java.lang.String getPITarget()
- Specified by:
getPITargetin interfacejavax.xml.stream.XMLStreamReader
-
getPrefix
public final java.lang.String getPrefix()
- Specified by:
getPrefixin interfacejavax.xml.stream.XMLStreamReader
-
getText
public final java.lang.String getText()
- Specified by:
getTextin interfacejavax.xml.stream.XMLStreamReader
-
getTextCharacters
public final char[] getTextCharacters()
- Specified by:
getTextCharactersin interfacejavax.xml.stream.XMLStreamReader
-
getTextCharacters
public final int getTextCharacters(int srcStart, char[] target, int targetStart, int len)- Specified by:
getTextCharactersin interfacejavax.xml.stream.XMLStreamReader
-
getTextLength
public final int getTextLength()
- Specified by:
getTextLengthin interfacejavax.xml.stream.XMLStreamReader
-
getTextStart
public final int getTextStart()
- Specified by:
getTextStartin interfacejavax.xml.stream.XMLStreamReader
-
hasName
public final boolean hasName()
- Specified by:
hasNamein interfacejavax.xml.stream.XMLStreamReader
-
hasNext
public final boolean hasNext()
- Specified by:
hasNextin interfacejavax.xml.stream.XMLStreamReader
-
hasText
public final boolean hasText()
- Specified by:
hasTextin interfacejavax.xml.stream.XMLStreamReader
-
isAttributeSpecified
public final boolean isAttributeSpecified(int index)
- Specified by:
isAttributeSpecifiedin interfacejavax.xml.stream.XMLStreamReader
-
isCharacters
public final boolean isCharacters()
- Specified by:
isCharactersin interfacejavax.xml.stream.XMLStreamReader
-
isEndElement
public final boolean isEndElement()
- Specified by:
isEndElementin interfacejavax.xml.stream.XMLStreamReader
-
isStartElement
public final boolean isStartElement()
- Specified by:
isStartElementin interfacejavax.xml.stream.XMLStreamReader
-
isWhiteSpace
public final boolean isWhiteSpace()
- Specified by:
isWhiteSpacein interfacejavax.xml.stream.XMLStreamReader
-
require
public final void require(int type, java.lang.String nsUri, java.lang.String localName) throws javax.xml.stream.XMLStreamException- Specified by:
requirein interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
next
public final int next() throws javax.xml.stream.XMLStreamException- Specified by:
nextin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
nextTag
public final int nextTag() throws javax.xml.stream.XMLStreamException- Specified by:
nextTagin interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
close
public final void close() throws javax.xml.stream.XMLStreamExceptionNote: as per StAX 1.0 specs, this method does NOT close the underlying input reader. (that is, unless the new StAX2 property
org.codehaus.stax2.XMLInputFactory2#P_AUTO_CLOSE_INPUTis set to true).- Specified by:
closein interfacejavax.xml.stream.XMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getLocation
public final javax.xml.stream.Location getLocation()
- Specified by:
getLocationin interfaceorg.codehaus.stax2.LocationInfo- Specified by:
getLocationin interfacejavax.xml.stream.XMLStreamReader
-
getElementAsBoolean
public final boolean getElementAsBoolean() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsBooleanin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsInt
public final int getElementAsInt() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsIntin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsLong
public final long getElementAsLong() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsLongin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsFloat
public final float getElementAsFloat() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsFloatin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsDouble
public final double getElementAsDouble() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsDoublein interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsInteger
public final java.math.BigInteger getElementAsInteger() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsIntegerin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsDecimal
public final java.math.BigDecimal getElementAsDecimal() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsDecimalin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsQName
public final javax.xml.namespace.QName getElementAsQName() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsQNamein interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsBinary
public final byte[] getElementAsBinary() throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAs
public final void getElementAs(org.codehaus.stax2.typed.TypedValueDecoder tvd) throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getElementAsBinary
public final byte[] getElementAsBinary(org.codehaus.stax2.typed.Base64Variant v) throws javax.xml.stream.XMLStreamException- Specified by:
getElementAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsIntArray
public final int readElementAsIntArray(int[] value, int from, int length) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsIntArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsLongArray
public final int readElementAsLongArray(long[] value, int from, int length) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsLongArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsFloatArray
public final int readElementAsFloatArray(float[] value, int from, int length) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsFloatArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsDoubleArray
public final int readElementAsDoubleArray(double[] value, int from, int length) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsDoubleArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsArray
public final int readElementAsArray(org.codehaus.stax2.typed.TypedArrayDecoder dec) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsBinary
public final int readElementAsBinary(byte[] resultBuffer, int offset, int maxLength) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
readElementAsBinary
public final int readElementAsBinary(byte[] resultBuffer, int offset, int maxLength, org.codehaus.stax2.typed.Base64Variant v) throws javax.xml.stream.XMLStreamException- Specified by:
readElementAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeIndex
public final int getAttributeIndex(java.lang.String namespaceURI, java.lang.String localName)- Specified by:
getAttributeIndexin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader
-
getAttributeAsBoolean
public final boolean getAttributeAsBoolean(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsBooleanin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsInt
public final int getAttributeAsInt(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsIntin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsLong
public final long getAttributeAsLong(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsLongin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsFloat
public final float getAttributeAsFloat(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsFloatin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsDouble
public final double getAttributeAsDouble(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsDoublein interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsInteger
public final java.math.BigInteger getAttributeAsInteger(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsIntegerin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsDecimal
public final java.math.BigDecimal getAttributeAsDecimal(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsDecimalin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsQName
public final javax.xml.namespace.QName getAttributeAsQName(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsQNamein interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAs
public final void getAttributeAs(int index, org.codehaus.stax2.typed.TypedValueDecoder tvd) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsIntArray
public final int[] getAttributeAsIntArray(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsIntArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsLongArray
public final long[] getAttributeAsLongArray(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsLongArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsFloatArray
public final float[] getAttributeAsFloatArray(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsFloatArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsDoubleArray
public final double[] getAttributeAsDoubleArray(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsDoubleArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsArray
public final int getAttributeAsArray(int index, org.codehaus.stax2.typed.TypedArrayDecoder tad) throws javax.xml.stream.XMLStreamExceptionMethod that allows reading contents of an attribute as an array of whitespace-separate tokens, decoded using specified decoder.- Specified by:
getAttributeAsArrayin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Returns:
- Number of tokens decoded, 0 if none found
- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsBinary
public final byte[] getAttributeAsBinary(int index) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeAsBinary
public final byte[] getAttributeAsBinary(int index, org.codehaus.stax2.typed.Base64Variant v) throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeAsBinaryin interfaceorg.codehaus.stax2.typed.TypedXMLStreamReader- Throws:
javax.xml.stream.XMLStreamException
-
verifyQName
protected javax.xml.namespace.QName verifyQName(javax.xml.namespace.QName n) throws org.codehaus.stax2.typed.TypedXMLStreamException- Throws:
org.codehaus.stax2.typed.TypedXMLStreamException
-
getFeature
@Deprecated public final java.lang.Object getFeature(java.lang.String name)
Deprecated.- Specified by:
getFeaturein interfaceorg.codehaus.stax2.XMLStreamReader2
-
setFeature
@Deprecated public final void setFeature(java.lang.String name, java.lang.Object value)Deprecated.- Specified by:
setFeaturein interfaceorg.codehaus.stax2.XMLStreamReader2
-
isPropertySupported
public final boolean isPropertySupported(java.lang.String name)
- Specified by:
isPropertySupportedin interfaceorg.codehaus.stax2.XMLStreamReader2
-
setProperty
public final boolean setProperty(java.lang.String name, java.lang.Object value)- Specified by:
setPropertyin interfaceorg.codehaus.stax2.XMLStreamReader2- Parameters:
name- Name of the property to setvalue- Value to set property to.- Returns:
- True, if the specified property was succesfully set to specified value; false if its value was not changed
-
skipElement
public final void skipElement() throws javax.xml.stream.XMLStreamException- Specified by:
skipElementin interfaceorg.codehaus.stax2.XMLStreamReader2- Throws:
javax.xml.stream.XMLStreamException
-
getAttributeInfo
public final org.codehaus.stax2.AttributeInfo getAttributeInfo() throws javax.xml.stream.XMLStreamException- Specified by:
getAttributeInfoin interfaceorg.codehaus.stax2.XMLStreamReader2- Throws:
javax.xml.stream.XMLStreamException
-
getDTDInfo
public final org.codehaus.stax2.DTDInfo getDTDInfo() throws javax.xml.stream.XMLStreamExceptionSince this class implementsDTDInfo, method can just returnthis.- Specified by:
getDTDInfoin interfaceorg.codehaus.stax2.XMLStreamReader2- Throws:
javax.xml.stream.XMLStreamException
-
getLocationInfo
public final org.codehaus.stax2.LocationInfo getLocationInfo()
Location information is always accessible, for this reader.- Specified by:
getLocationInfoin interfaceorg.codehaus.stax2.XMLStreamReader2
-
getText
public final int getText(java.io.Writer w, boolean preserveContents) throws javax.xml.stream.XMLStreamExceptionMethod similar togetText(), except that it just uses provided Writer to write all textual content. For further optimization, it may also be allowed to do true pass-through, thus possibly avoiding one temporary copy of the data.TODO: try to optimize to allow completely streaming pass-through: currently will still read all data in memory buffers before outputting
- Specified by:
getTextin interfaceorg.codehaus.stax2.XMLStreamReader2- Parameters:
w- Writer to use for writing textual contentspreserveContents- If true, reader has to preserve contents so that further calls togetTextwill return proper conntets. If false, reader is allowed to skip creation of such copies: this can improve performance, but it also means that further calls togetTextis not guaranteed to return meaningful data.- Returns:
- Number of characters written to the reader
- Throws:
javax.xml.stream.XMLStreamException
-
getDepth
public final int getDepth()
- Specified by:
getDepthin interfaceorg.codehaus.stax2.XMLStreamReader2- Returns:
- Number of open elements in the stack; 0 when parser is in prolog/epilog, 1 inside root element and so on.
-
isEmptyElement
public final boolean isEmptyElement() throws javax.xml.stream.XMLStreamException- Specified by:
isEmptyElementin interfaceorg.codehaus.stax2.XMLStreamReader2- Returns:
- True, if cursor points to a start or end element that is constructed from 'empty' element (ends with '/>'); false otherwise.
- Throws:
javax.xml.stream.XMLStreamException
-
getNonTransientNamespaceContext
public final javax.xml.namespace.NamespaceContext getNonTransientNamespaceContext()
- Specified by:
getNonTransientNamespaceContextin interfaceorg.codehaus.stax2.XMLStreamReader2
-
getPrefixedName
public final java.lang.String getPrefixedName()
- Specified by:
getPrefixedNamein interfaceorg.codehaus.stax2.XMLStreamReader2
-
closeCompletely
public final void closeCompletely() throws javax.xml.stream.XMLStreamException- Specified by:
closeCompletelyin interfaceorg.codehaus.stax2.XMLStreamReader2- Throws:
javax.xml.stream.XMLStreamException
-
getProcessedDTD
public final java.lang.Object getProcessedDTD()
Note: DTD-handling sub-classes need to override this method.
- Specified by:
getProcessedDTDin interfaceorg.codehaus.stax2.DTDInfo
-
getDTDRootName
public final java.lang.String getDTDRootName()
- Specified by:
getDTDRootNamein interfaceorg.codehaus.stax2.DTDInfo
-
getDTDPublicId
public final java.lang.String getDTDPublicId()
- Specified by:
getDTDPublicIdin interfaceorg.codehaus.stax2.DTDInfo
-
getDTDSystemId
public final java.lang.String getDTDSystemId()
- Specified by:
getDTDSystemIdin interfaceorg.codehaus.stax2.DTDInfo
-
getDTDInternalSubset
public final java.lang.String getDTDInternalSubset()
- Specified by:
getDTDInternalSubsetin interfaceorg.codehaus.stax2.DTDInfo- Returns:
- Internal subset portion of the DOCTYPE declaration, if any; empty String if none
-
getProcessedDTDSchema
public final org.codehaus.stax2.validation.DTDValidationSchema getProcessedDTDSchema()
Sub-class will override this method- Specified by:
getProcessedDTDSchemain interfaceorg.codehaus.stax2.DTDInfo
-
getStartingByteOffset
public final long getStartingByteOffset()
- Specified by:
getStartingByteOffsetin interfaceorg.codehaus.stax2.LocationInfo
-
getStartingCharOffset
public final long getStartingCharOffset()
- Specified by:
getStartingCharOffsetin interfaceorg.codehaus.stax2.LocationInfo
-
getEndingByteOffset
public final long getEndingByteOffset() throws javax.xml.stream.XMLStreamException- Specified by:
getEndingByteOffsetin interfaceorg.codehaus.stax2.LocationInfo- Throws:
javax.xml.stream.XMLStreamException
-
getEndingCharOffset
public final long getEndingCharOffset() throws javax.xml.stream.XMLStreamException- Specified by:
getEndingCharOffsetin interfaceorg.codehaus.stax2.LocationInfo- Throws:
javax.xml.stream.XMLStreamException
-
getStartLocation
public final org.codehaus.stax2.XMLStreamLocation2 getStartLocation()
- Specified by:
getStartLocationin interfaceorg.codehaus.stax2.LocationInfo
-
getEndLocation
public final org.codehaus.stax2.XMLStreamLocation2 getEndLocation() throws javax.xml.stream.XMLStreamException- Specified by:
getEndLocationin interfaceorg.codehaus.stax2.LocationInfo- Throws:
javax.xml.stream.XMLStreamException
-
getCurrentLocation
public final org.codehaus.stax2.XMLStreamLocation2 getCurrentLocation()
- Specified by:
getCurrentLocationin interfaceorg.codehaus.stax2.LocationInfo
-
findAttributeIndex
public final int findAttributeIndex(java.lang.String nsURI, java.lang.String localName)- Specified by:
findAttributeIndexin interfaceorg.codehaus.stax2.AttributeInfo
-
getIdAttributeIndex
public final int getIdAttributeIndex()
- Specified by:
getIdAttributeIndexin interfaceorg.codehaus.stax2.AttributeInfo
-
getNotationAttributeIndex
public final int getNotationAttributeIndex()
- Specified by:
getNotationAttributeIndexin interfaceorg.codehaus.stax2.AttributeInfo
-
validateAgainst
public final org.codehaus.stax2.validation.XMLValidator validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) throws javax.xml.stream.XMLStreamException- Specified by:
validateAgainstin interfaceorg.codehaus.stax2.validation.Validatable- Throws:
javax.xml.stream.XMLStreamException
-
stopValidatingAgainst
public final org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) throws javax.xml.stream.XMLStreamException- Specified by:
stopValidatingAgainstin interfaceorg.codehaus.stax2.validation.Validatable- Throws:
javax.xml.stream.XMLStreamException
-
stopValidatingAgainst
public final org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator) throws javax.xml.stream.XMLStreamException- Specified by:
stopValidatingAgainstin interfaceorg.codehaus.stax2.validation.Validatable- Throws:
javax.xml.stream.XMLStreamException
-
setValidationProblemHandler
public final org.codehaus.stax2.validation.ValidationProblemHandler setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)
- Specified by:
setValidationProblemHandlerin interfaceorg.codehaus.stax2.validation.Validatable
-
_reportNonTextEvent
protected void _reportNonTextEvent(int type) throws javax.xml.stream.XMLStreamExceptionHelper method called whengetElementText()(et al) method encounters a token type it should not, during text coalescing- Throws:
javax.xml.stream.XMLStreamException
-
getLastCharLocation
protected javax.xml.stream.Location getLastCharLocation()
-
handlePrologEoi
protected int handlePrologEoi(boolean isProlog) throws javax.xml.stream.XMLStreamException- Throws:
javax.xml.stream.XMLStreamException
-
handleTreeEoi
protected void handleTreeEoi() throws javax.xml.stream.XMLStreamExceptionMethod called when hitting an end-of-input within tree, after a valid token- Throws:
javax.xml.stream.XMLStreamException
-
throwWfe
protected void throwWfe(java.lang.String msg) throws javax.xml.stream.XMLStreamExceptionThrows generic parse error with specified message and current parsing location.- Throws:
javax.xml.stream.XMLStreamException
-
throwNotTextual
private void throwNotTextual(int type)
-
throwNotTextXxx
private void throwNotTextXxx(int type)
-
throwFromIOE
protected void throwFromIOE(java.io.IOException ioe) throws javax.xml.stream.XMLStreamException- Throws:
javax.xml.stream.XMLStreamException
-
throwUnexpectedEOI
protected void throwUnexpectedEOI(java.lang.String msg) throws javax.xml.stream.XMLStreamException- Throws:
javax.xml.stream.XMLStreamException
-
_constructUnexpectedInTyped
protected javax.xml.stream.XMLStreamException _constructUnexpectedInTyped(int nextToken)
-
_constructTypeException
private org.codehaus.stax2.typed.TypedXMLStreamException _constructTypeException(java.lang.IllegalArgumentException iae, java.lang.String lexicalValue)Method called to wrap or convert given conversion-fail exception into a fullTypedXMLStreamException.- Parameters:
iae- Problem as reported by converterlexicalValue- Lexical value (element content, attribute value) that could not be converted succesfully.
-
_constructTypeException
private org.codehaus.stax2.typed.TypedXMLStreamException _constructTypeException(java.lang.String msg, java.lang.String lexicalValue)
-
reportInvalidAttrIndex
protected void reportInvalidAttrIndex(int index)
-
_closeScanner
protected void _closeScanner(boolean forceStreamClose) throws javax.xml.stream.XMLStreamExceptionMethod called to close scanner, by asking it to release resource it has, and potentially also close the underlying stream.- Throws:
javax.xml.stream.XMLStreamException
-
_decoderFactory
protected final org.codehaus.stax2.ri.typed.ValueDecoderFactory _decoderFactory()
-
_base64Decoder
protected org.codehaus.stax2.ri.typed.CharArrayBase64Decoder _base64Decoder()
-
_handleEmptyValue
private void _handleEmptyValue(org.codehaus.stax2.typed.TypedValueDecoder dec) throws javax.xml.stream.XMLStreamExceptionMethod called to handle value that has empty String as representation. This will usually either lead to an exception, or parsing to the default value for the type in question (null for nullable types and so on).- Throws:
javax.xml.stream.XMLStreamException
-
toString
public final java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-