public abstract class Decoder extends Object implements FastInfosetParser
This class extends org.sax.xml.DefaultHandler so that concrete SAX implementations can be used with javax.xml.parsers.SAXParser and the parse methods that take org.sax.xml.DefaultHandler as a parameter.
Buffering of octets that are read from an InputStream
is
supported in a similar manner to a BufferedInputStream
.
Combining buffering with decoding enables better performance.
More than one fast infoset document may be decoded from the
InputStream
.
Modifier and Type | Class and Description |
---|---|
protected class |
Decoder.EncodingAlgorithmInputStream |
Modifier and Type | Field and Description |
---|---|
protected boolean |
_addToTable
True if an entry is required to be added to a table
|
protected QualifiedNameArray |
_attributeNameTable
The attribute name table of the vocabulary.
|
protected StringArray |
_attributeValueTable
The attribute value table of the vocabulary.
|
protected int |
_b
The current octet that is being read
|
protected int |
_bufferSize
The size of the internal buffer.
|
protected ContiguousCharArrayArray |
_characterContentChunkTable
The character content chunk table of the vocabulary.
|
protected char[] |
_charBuffer
The internal buffer of characters.
|
protected int |
_charBufferLength
The length of characters in the buffer of characters.
|
protected boolean |
_doubleTerminate
True if two information item are terminated in direct sequence.
|
protected DuplicateAttributeVerifier |
_duplicateAttributeVerifier
Helper class that checks for duplicate attribute information items.
|
protected QualifiedNameArray |
_elementNameTable
The element name table of the vocabulary.
|
protected int |
_identifier
The vocabulary table index of identifying string or the identifier of
an encoding algorithm or restricted alphabet.
|
protected int |
_integer
The vocabulary table index to an indexed non identifying string.
|
protected int |
_namespaceNameIndex |
protected boolean |
_needForceStreamClose
True if needs to close underlying input stream.
|
protected List |
_notations
The list of Notation Information Items that are part of the
Document Information Item.
|
protected byte[] |
_octetBuffer
The internal buffer used for decoding.
|
protected int |
_octetBufferEnd
The end of the buffer.
|
protected int |
_octetBufferLength
The length of some octets in the buffer that are to be read.
|
protected int |
_octetBufferOffset
The offset into the buffer to read the next byte.
|
protected int |
_octetBufferStart
A mark into the internal buffer used for decoding encoded algorithm
or restricted alphabet data.
|
protected boolean |
_parseFragments
True if can parse fragments.
|
protected int |
_prefixIndex |
protected PrefixArray |
_prefixTable
The prefix table of the vocabulary.
|
protected Map |
_registeredEncodingAlgorithms
The map of URIs to registered encoding algorithms.
|
protected boolean |
_terminate
True if an information item is terminated.
|
protected List |
_unparsedEntities
The list of Unparsed Entity Information Items that are part of the
Document Information Item.
|
protected ParserVocabulary |
_v
The vocabulary used for decoding.
|
static String |
BUFFER_SIZE_SYSTEM_PROPERTY
Internal buffer size interning system property.
|
protected static int |
NISTRING_EMPTY_STRING |
protected static int |
NISTRING_ENCODING_ALGORITHM |
protected static int |
NISTRING_INDEX |
protected static int |
NISTRING_STRING |
static String |
STRING_INTERNING_SYSTEM_PROPERTY
String interning system property.
|
BUFFER_SIZE_PROPERTY, EXTERNAL_VOCABULARIES_PROPERTY, FORCE_STREAM_CLOSE_PROPERTY, REGISTERED_ENCODING_ALGORITHMS_PROPERTY, STRING_INTERNING_PROPERTY
Modifier | Constructor and Description |
---|---|
protected |
Decoder()
Default constructor for the Decoder.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
_isFastInfosetDocument() |
protected void |
closeIfRequired() |
protected String |
createQualifiedNameString(char[] first,
String second) |
protected String |
createQualifiedNameString(String second) |
protected void |
decodeAdditionalData() |
protected void |
decodeAlphabetOctetsAsCharBuffer(char[] restrictedAlphabet) |
protected String |
decodeCharacterEncodingScheme() |
protected void |
decodeDII() |
protected QualifiedName |
decodeEIIIndexLarge() |
protected QualifiedName |
decodeEIIIndexMedium() |
protected void |
decodeFourBitAlphabetOctetsAsCharBuffer(char[] restrictedAlphabet) |
protected void |
decodeHeader() |
protected String |
decodeIdentifyingNonEmptyStringIndexOnFirstBitAsNamespaceName(boolean prefixPresent) |
protected String |
decodeIdentifyingNonEmptyStringIndexOnFirstBitAsPrefix(boolean namespaceNamePresent) |
protected String |
decodeIdentifyingNonEmptyStringOnFirstBit(StringArray table) |
protected String |
decodeIdentifyingNonEmptyStringOnFirstBitAsNamespaceName(boolean prefixPresent) |
protected String |
decodeIdentifyingNonEmptyStringOnFirstBitAsPrefix(boolean namespaceNamePresent) |
protected void |
decodeInitialVocabulary() |
protected int |
decodeIntegerIndexOnSecondBit() |
protected QualifiedName |
decodeLiteralQualifiedName(int state,
QualifiedName q) |
protected void |
decodeNonEmptyOctetStringLengthOnSecondBit() |
protected void |
decodeNonEmptyOctetStringOnSecondBitAsUtf8CharArray() |
protected String |
decodeNonEmptyOctetStringOnSecondBitAsUtf8String() |
protected int |
decodeNonIdentifyingStringOnFirstBit() |
protected void |
decodeNotations() |
protected void |
decodeOctetsOnFifthBitOfNonIdentifyingStringOnFirstBit(int b) |
protected void |
decodeOctetsOnSeventhBitOfNonIdentifyingStringOnThirdBit(int b) |
protected String |
decodeRAOctetsAsString(char[] restrictedAlphabet) |
protected void |
decodeRestrictedAlphabetAsCharBuffer() |
protected String |
decodeRestrictedAlphabetAsString() |
protected void |
decodeUnparsedEntities() |
protected void |
decodeUtf16StringAsCharBuffer() |
protected String |
decodeUtf16StringAsString() |
protected void |
decodeUtf8NCNameIntoCharBuffer() |
protected void |
decodeUtf8StringAsCharBuffer() |
protected void |
decodeUtf8StringAsCharBuffer(char[] ch,
int offset) |
protected String |
decodeUtf8StringAsString() |
protected void |
decodeUtf8StringIntoCharBuffer() |
protected void |
decodeUtf8StringIntoCharBuffer(char[] ch,
int offset) |
protected String |
decodeVersion() |
int |
getBufferSize()
Get the buffer size.
|
Map |
getExternalVocabularies()
Get the map of referenced external vocabularies.
|
boolean |
getForceStreamClose()
Return the force stream close property.
|
boolean |
getParseFragments()
Return the parse fragments property.
|
Map |
getRegisteredEncodingAlgorithms()
Gets the set of registered encoding algorithms.
|
boolean |
getStringInterning()
Return the string interning property.
|
static boolean |
isFastInfosetDocument(InputStream s) |
protected int |
peek() |
protected int |
peek(OctetBufferListener octetBufferListener) |
protected int |
peek2(OctetBufferListener octetBufferListener) |
protected int |
read() |
void |
reset()
Reset the decoder for reuse decoding another XML infoset.
|
void |
setBufferSize(int bufferSize)
Set the buffer size.
|
void |
setExternalVocabularies(Map referencedVocabualries)
Set the map of referenced external vocabularies.
|
void |
setForceStreamClose(boolean needForceStreamClose)
Set the force stream close property.
|
void |
setInputStream(InputStream s)
Set the InputStream to decode the fast infoset document.
|
void |
setParseFragments(boolean parseFragments)
Set the parse fragments property.
|
void |
setRegisteredEncodingAlgorithms(Map algorithms)
Sets the set of registered encoding algorithms.
|
void |
setStringInterning(boolean stringInterning)
Set the string interning property.
|
void |
setVocabulary(ParserVocabulary v)
Set the ParserVocabulary to be used for decoding.
|
public static final String STRING_INTERNING_SYSTEM_PROPERTY
public static final String BUFFER_SIZE_SYSTEM_PROPERTY
protected boolean _parseFragments
protected boolean _needForceStreamClose
protected List _notations
protected List _unparsedEntities
protected Map _registeredEncodingAlgorithms
protected ParserVocabulary _v
protected PrefixArray _prefixTable
protected QualifiedNameArray _elementNameTable
protected QualifiedNameArray _attributeNameTable
protected ContiguousCharArrayArray _characterContentChunkTable
protected StringArray _attributeValueTable
protected int _b
protected boolean _terminate
protected boolean _doubleTerminate
protected boolean _addToTable
protected int _integer
protected int _identifier
protected int _bufferSize
protected byte[] _octetBuffer
protected int _octetBufferStart
protected int _octetBufferOffset
protected int _octetBufferEnd
protected int _octetBufferLength
protected char[] _charBuffer
protected int _charBufferLength
protected DuplicateAttributeVerifier _duplicateAttributeVerifier
protected static final int NISTRING_STRING
protected static final int NISTRING_INDEX
protected static final int NISTRING_ENCODING_ALGORITHM
protected static final int NISTRING_EMPTY_STRING
protected int _prefixIndex
protected int _namespaceNameIndex
public void setStringInterning(boolean stringInterning)
If the string interning property is set to true then
String
objects instantiated for [namespace name], [prefix]
and [local name] infoset properties will be interned using the method
String.intern()
.
setStringInterning
in interface FastInfosetParser
stringInterning
- The string interning property.public boolean getStringInterning()
getStringInterning
in interface FastInfosetParser
public void setBufferSize(int bufferSize)
The size of the buffer for parsing is set using this method. Requests for sizes smaller then the current size will be ignored. Otherwise the buffer will be resized when the next parse is performed.
setBufferSize
in interface FastInfosetParser
bufferSize
- The requested buffer size.public int getBufferSize()
getBufferSize
in interface FastInfosetParser
public void setRegisteredEncodingAlgorithms(Map algorithms)
setRegisteredEncodingAlgorithms
in interface FastInfosetParser
algorithms
- The set of registered algorithms.public Map getRegisteredEncodingAlgorithms()
getRegisteredEncodingAlgorithms
in interface FastInfosetParser
public void setExternalVocabularies(Map referencedVocabualries)
The map (but not the keys and values) be cloned.
setExternalVocabularies
in interface FastInfosetParser
referencedVocabualries
- the map of URI to vocabulary.public Map getExternalVocabularies()
getExternalVocabularies
in interface FastInfosetParser
public void setParseFragments(boolean parseFragments)
If the parse fragments property is set to true then fragments of an XML infoset may be parsed.
setParseFragments
in interface FastInfosetParser
parseFragments
- The parse fragments property.public boolean getParseFragments()
getParseFragments
in interface FastInfosetParser
public void setForceStreamClose(boolean needForceStreamClose)
If the force stream property is set to true then Parser's underlying InputStream will be closed.
setForceStreamClose
in interface FastInfosetParser
needForceStreamClose
- The force stream close property.public boolean getForceStreamClose()
getForceStreamClose
in interface FastInfosetParser
public void reset()
public void setVocabulary(ParserVocabulary v)
v
- the vocabulary to be used for decoding.public void setInputStream(InputStream s)
s
- the InputStream where the fast infoset document is decoded from.protected final void decodeDII() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeAdditionalData() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeInitialVocabulary() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeNotations() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeUnparsedEntities() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeCharacterEncodingScheme() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeVersion() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final QualifiedName decodeEIIIndexMedium() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final QualifiedName decodeEIIIndexLarge() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final QualifiedName decodeLiteralQualifiedName(int state, QualifiedName q) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final int decodeNonIdentifyingStringOnFirstBit() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeOctetsOnFifthBitOfNonIdentifyingStringOnFirstBit(int b) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeOctetsOnSeventhBitOfNonIdentifyingStringOnThirdBit(int b) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeIdentifyingNonEmptyStringOnFirstBit(StringArray table) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeIdentifyingNonEmptyStringOnFirstBitAsPrefix(boolean namespaceNamePresent) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeIdentifyingNonEmptyStringIndexOnFirstBitAsPrefix(boolean namespaceNamePresent) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeIdentifyingNonEmptyStringOnFirstBitAsNamespaceName(boolean prefixPresent) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeIdentifyingNonEmptyStringIndexOnFirstBitAsNamespaceName(boolean prefixPresent) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeNonEmptyOctetStringOnSecondBitAsUtf8String() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeNonEmptyOctetStringOnSecondBitAsUtf8CharArray() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeNonEmptyOctetStringLengthOnSecondBit() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final int decodeIntegerIndexOnSecondBit() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeHeader() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeRestrictedAlphabetAsCharBuffer() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeRestrictedAlphabetAsString() throws FastInfosetException, IOException
FastInfosetException
IOException
protected final String decodeRAOctetsAsString(char[] restrictedAlphabet) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeFourBitAlphabetOctetsAsCharBuffer(char[] restrictedAlphabet) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeAlphabetOctetsAsCharBuffer(char[] restrictedAlphabet) throws FastInfosetException, IOException
FastInfosetException
IOException
protected final void decodeUtf8StringAsCharBuffer() throws IOException
IOException
protected final void decodeUtf8StringAsCharBuffer(char[] ch, int offset) throws IOException
IOException
protected final String decodeUtf8StringAsString() throws IOException
IOException
protected final void decodeUtf16StringAsCharBuffer() throws IOException
IOException
protected final String decodeUtf16StringAsString() throws IOException
IOException
protected final void decodeUtf8StringIntoCharBuffer() throws IOException
IOException
protected final void decodeUtf8StringIntoCharBuffer(char[] ch, int offset) throws IOException
IOException
protected final void decodeUtf8NCNameIntoCharBuffer() throws IOException
IOException
protected final int read() throws IOException
IOException
protected final void closeIfRequired() throws IOException
IOException
protected final int peek() throws IOException
IOException
protected final int peek(OctetBufferListener octetBufferListener) throws IOException
IOException
protected final int peek2(OctetBufferListener octetBufferListener) throws IOException
IOException
protected final boolean _isFastInfosetDocument() throws IOException
IOException
public static boolean isFastInfosetDocument(InputStream s) throws IOException
IOException
Copyright © 2017 Oracle Corpration. All Rights Reserved.