Package com.ctc.wstx.sr

Class TypedStreamReader

    • Field Detail

      • MASK_TYPED_ACCESS_ARRAY

        protected static final int MASK_TYPED_ACCESS_ARRAY
        Mask of event types that are legal (starting) states to call Typed Access API from.
        See Also:
        Constant Field Values

      • MASK_TYPED_ACCESS_BINARY

        protected static final int MASK_TYPED_ACCESS_BINARY
        See Also:
        Constant Field Values

      • _decoderFactory

        protected ValueDecoderFactory _decoderFactory
        Factory used for constructing decoders we need for typed access

      • _base64Decoder

        protected CharArrayBase64Decoder _base64Decoder
        Lazily-constructed decoder object for decoding base64 encoded element binary content.

    • Method Detail

      • getElementAsBoolean

        public boolean getElementAsBoolean()
                            throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an element content as a boolean. The lexical representation of a boolean is defined by the XML Schema boolean data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema boolean data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema boolean data type. (note: allowed lexical values are canonicals "true" and "false", as well as non-canonical "0" and "1")

        These are the pre- and post-conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.
        Throws:
        XMLStreamException - If unable to access content
        TypedXMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • getElementAsInt

        public int getElementAsInt()
                    throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an element content as a 32-bit integer. The lexical representation of a integer is defined by the XML Schema integer data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema integer data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema integer data type.

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.
        Throws:
        XMLStreamException - If unable to access content
        TypedXMLStreamException - If unable to convert the resulting character sequence into a Java (32-bit) integer.

      • getElementAsLong

        public long getElementAsLong()
                      throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an element content as a 64-bit integer. The lexical representation of a integer is defined by the XML Schema integer data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema integer data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema integer data type.

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.
        Throws:
        XMLStreamException - If unable to access content
        TypedXMLStreamException - If unable to convert the resulting character sequence into a Java (64-bit) integer.

      • getElementAsFloat

        public float getElementAsFloat()
                        throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an element content as a 32-bit floating point value. The lexical representation is defined by the XML Schema float data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema float data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema integer data type.
        Note that valid representations include basic Java textual representations, as well as 3 special tokens: "INF", "-INF" and "NaN"

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.
        Throws:
        XMLStreamException - If unable to access content
        TypedXMLStreamException - If unable to convert the resulting character sequence into a Java float

      • getElementAsDouble

        public double getElementAsDouble()
                          throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an element content as a 64-bit floating point value. The lexical representation is defined by the XML Schema double data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema double data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema integer data type.
        Note that valid representations include basic Java textual representations, as well as 3 special tokens: "INF", "-INF" and "NaN"

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.
        Throws:
        XMLStreamException - If unable to access content
        TypedXMLStreamException - If unable to convert the resulting character sequence into a Java double

      • getElementAs

        public void getElementAs​(TypedValueDecoder tvd)
                  throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader
        Generic decoding method that can be used for efficient decoding of additional types not support natively by the typed stream reader. When method is called, stream reader will collect all textual content of the current element (effectively doing something similar to a call to XMLStreamReader.getElementText(), and then call one of decode methods defined in TypedValueDecoder. The only difference is that passed value will be trimmed: that is, any leading or trailing white space will be removed prior to calling decode method. After the call, passed decoder object will have decoded and stored value (if succesful) or thrown an exception (if not).

        The main benefit of using this method (over just getting all content by calling XMLStreamReader.getElementText() is efficiency: the stream reader can efficiently gather all textual content necessary and pass it to the decoder, often avoiding construction of intemediate Strings.

        These are the pre- and post-conditions of calling this method:

        • Precondition: the current event is START_ELEMENT.
        • Postcondition: the current event is the corresponding END_ELEMENT.

        Note that caller has to know more specific type of decoder, since the base interface does not specify methods for accessing actual decoded value.

        Throws:
        XMLStreamException

      • readElementAsIntArray

        public int readElementAsIntArray​(int[] value,
                                 int from,
                                 int length)
                          throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader
        Read an element content as an int array. The lexical representation of a int array is defined by the following XML schema type: 
            <xs:simpleType name="intArray">
       <xs:list itemType="xs:int"/>
    </xs:simpleType>
        whose lexical space is a list of space-separated ints. Whitespace MUST be collapsed according to the whiteSpace facet for the intArray type shown above. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the intArray data type.

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is either START_ELEMENT, or a textual event (CHARACTERS, CDATA), or END_ELEMENT (END_ELEMENT is allowed for convenience; if so, no read operation is tried, and -1 is returned immediately
        • Postcondition: the current event is the corresponding END_ELEMENT or CHARACTERS if only a portion of the array has been copied thus far.
        This method can be called multiple times until the cursor is positioned at the corresponding END_ELEMENT event. Stated differently, after the method is called for the first time, the cursor will move and remain in the CHARACTERS position while there are more bytes available for reading.
        Parameters:
        value - The array in which to copy the ints.
        from - The index in the array from which copying starts.
        length - The maximun number of ints to copy. Minimum value is 1; others an IllegalArgumentException is thrown
        Returns:
        The number of ints actually copied which must be less or equal than length, but at least one if any ints found. If not, -1 is returned to signal end of ints to parse.
        Throws:
        XMLStreamException

      • readElementAsArray

        public final int readElementAsArray​(TypedArrayDecoder dec)
                             throws XMLStreamException
        Method called to parse array of primitives.

        !!! 05-Sep-2008, tatu: Current implementation is not optimal either performance-wise, or from getting accurate Location for decoding problems. But it works otherwise, and we need to get Woodstox 4.0 out by the end of the year... so it'll do, for now.

        Returns:
        Number of elements decoded (if any were decoded), or -1 to indicate that no more values can be decoded.
        Throws:
        XMLStreamException

      • readElementAsBinary

        public int readElementAsBinary​(byte[] resultBuffer,
                               int offset,
                               int maxLength,
                               Base64Variant v)
                        throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader
        Read element content as decoded byte sequence; possibly only reading a fragment of all element content. The lexical representation of a byte array is defined by the XML Schema base64Binary data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema base64Binary data type. An exception is thrown if content is not in the lexical space defined by the XML Schema base64Binary data type.

        Each call will read at least one decoded byte (and no more than the specified maximum length), if there is any content remaining. If none is available and END_ELEMENT is encountered, -1 is returned.

        These are the pre and post conditions of calling this method:

        • Precondition: the current event is either START_ELEMENT, or a textual event (CHARACTERS, CDATA), or END_ELEMENT (END_ELEMENT is allowed for convenience; if so, no read operation is tried, and -1 is returned immediately
        • Postcondition: the current event is the corresponding END_ELEMENT, if all remaining binary content was read, or CHARACTERS if only a portion of the array was read

        Additionally, caller MUST start decoding at START_ELEMENT; if the first decode calls is at CHARACTERS or CDATA event, results are not defined: result may be an exception, or invalid data being returned. Implementations are encouraged to throw an exception if possible, to make it easier to figure out the problem.

        This method can be called multiple times until the cursor is positioned at the corresponding END_ELEMENT event. Stated differently, after the method is called for the first time, the cursor will move and remain in the CHARACTERS position while there are potentially more bytes available for reading.

        Parameters:
        resultBuffer - Array in which to copy decoded bytes.
        offset - Starting offset of the first decoded byte within result buffer
        maxLength - Maximum number of bytes to decode with this call
        Returns:
        The number of bytes actually decoded and returned, if any were available; -1 if there is no more content. If any content was copied, value must be less or equal than maxLength Note that this value is not guaranteed to equal maxLength even if enough content was available; that is, implementations can return shorter sections if they choose to, down to and including returning zero (0) if it was not possible to decode a full base64 triplet (3 output bytes from 4 input characters).
        Throws:
        XMLStreamException

      • getAttributeIndex

        public int getAttributeIndex​(String namespaceURI,
                             String localName)
        Description copied from interface: TypedXMLStreamReader
        Returns the index of the attribute whose local name is localName and URI is namespaceURI or -1 if no such attribute exists.
        Parameters:
        namespaceURI - The attribute's namespace URI. Values of null and "" are considered the same, i.e. "no namespace" (or "empty" namespace)
        localName - The attribute's local name.
        Returns:
        The attribute's index or -1 if no such attribute exists.

      • getAttributeAsBoolean

        public boolean getAttributeAsBoolean​(int index)
                              throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an attribute value as a boolean. The lexical representation of a boolean is defined by the XML Schema boolean data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema boolean data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema boolean data type.

        Parameters:
        index - The attribute's index as returned by TypedXMLStreamReader.getAttributeIndex(String, String)
        Throws:
        XMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • getAttributeAsInt

        public int getAttributeAsInt​(int index)
                      throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an attribute value as a boolean. The lexical representation of a boolean is defined by the XML Schema integer data type. Whitespace MUST be collapsed according to the whiteSpace facet for the type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema integer data type.

        Parameters:
        index - The attribute's index as returned by TypedXMLStreamReader.getAttributeIndex(String, String)
        Throws:
        XMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • getAttributeAsLong

        public long getAttributeAsLong​(int index)
                        throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an attribute value as a boolean. The lexical representation of a boolean is defined by the XML Schema long data type. Whitespace MUST be collapsed according to the whiteSpace facet for the type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema long data type.

        Parameters:
        index - The attribute's index as returned by TypedXMLStreamReader.getAttributeIndex(String, String)
        Throws:
        XMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • getAttributeAsIntArray

        public int[] getAttributeAsIntArray​(int index)
                             throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader

        Read an attribute content as an int array. The lexical representation of a int array is defined by the following XML schema type: 

            <xs:simpleType name="intArray">
       <xs:list itemType="xs:int"/>
    </xs:simpleType>
        whose lexical space is a list of space-separated ints. Whitespace MUST be collapsed according to the whiteSpace facet for the intArray type shown above. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the intArray data type.
        Parameters:
        index - The attribute's index as returned by TypedXMLStreamReader.getAttributeIndex(String, String).
        Returns:
        An array of ints with the content.
        Throws:
        XMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • getAttributeAsArray

        public int getAttributeAsArray​(int index,
                               TypedArrayDecoder tad)
                        throws XMLStreamException
        Method that allows reading contents of an attribute as an array of whitespace-separate tokens, decoded using specified decoder.
        Returns:
        Number of tokens decoded, 0 if none found
        Throws:
        XMLStreamException

      • getAttributeAsBinary

        public byte[] getAttributeAsBinary​(int index)
                            throws XMLStreamException
        Description copied from interface: TypedXMLStreamReader
        Read an attribute value as a byte array. The lexical representation of a byte array is defined by the XML Schema base64Binary data type. Whitespace MUST be collapsed according to the whiteSpace facet for the XML Schema base64Binary data type. An exception is thrown if, after whitespace is collapsed, the resulting sequence of characters is not in the lexical space defined by the XML Schema base64Binary data type.
        Parameters:
        index - The attribute's index as returned by TypedXMLStreamReader.getAttributeIndex(String, String).
        Returns:
        An array of bytes with the content.
        Throws:
        XMLStreamException - If unable to convert the resulting character sequence into an XML Schema boolean value.

      • _verifyQName

        protected QName _verifyQName​(QName n)
                      throws TypedXMLStreamException
        Method called to verify validity of the parsed QName element or attribute value. At this point binding of a prefixed name (if qname has a prefix) has been verified, and thereby prefix also must be valid (since there must have been a preceding declaration). But local name might still not be a legal well-formed xml name, so let's verify that.
        Throws:
        TypedXMLStreamException

      • _constructTypeException

        protected TypedXMLStreamException _constructTypeException​(IllegalArgumentException iae,
                                                          String lexicalValue)
        Method called to wrap or convert given conversion-fail exception into a full TypedXMLStreamException,
        Parameters:
        iae - Problem as reported by converter
        lexicalValue - Lexical value (element content, attribute value) that could not be converted succesfully.