- All Implemented Interfaces:
FastInfosetSerializer
,ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
- Direct Known Subclasses:
DOMDocumentSerializer
,SAXDocumentSerializer
,StAXDocumentSerializer
Concrete implementations extending Encoder will utilize methods on Encoder to encode XML infoset according to the Fast Infoset standard. It is the responsibility of the concrete implementation to ensure that methods are invoked in the correct order to produce a valid fast infoset document.
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 written to an OutputStream
is
supported in a similar manner to a BufferedOutputStream
.
Combining buffering with encoding enables better performance.
More than one fast infoset document may be encoded to the
OutputStream
.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
The current octet that is to be written.private int
protected static final String
Default character encoding scheme system property for the encoding of content and attribute values.protected char[]
The internal buffer of characters used for the UTF-8 or UTF-16 encoding of characters.private byte[]
private int
private final Encoder.EncodingBufferOutputStream
private boolean
True if strings for text content and attribute values will be UTF-8 encoded otherwise they will be UTF-16 encoded.private boolean
True if comments shall be ignored.private boolean
True if DTD and internal subset shall be ignored.private boolean
True if procesing instructions shall be ignored.private boolean
True if white space characters for text content shall be ignored.protected int
The current mark in the internal buffer.private int
Encoding constant generated from the string encoding.private int
Encoding constant generated from the string encoding.protected byte[]
The internal buffer of bytes.protected int
The current position in the internal buffer.private Map
<String, EncodingAlgorithm> The map of URIs to algorithms.protected OutputStream
TheOutputStream
that the encoded XML infoset (the fast infoset document) is written to.protected boolean
True if terminatation of an information item is requiredprivate boolean
True, if the local name string is used as the key to find the associated set of qualified names.protected SerializerVocabulary
The vocabulary that is used by the encoderprotected VocabularyApplicationData
The vocabulary application data that is used by the encoderprivate boolean
True if the vocubulary is internal to the encoderprotected int
The limit on the size of indexed Map for attribute values Limit is measured in characters numberstatic final String
Character encoding scheme system property for the encoding of content and attribute values.protected int
The limit on the size of indexed Map for character content chunks Limit is measured in characters numberprivate static int[]
protected int
The maximum size of [normalized value] of Attribute Information Items that will be indexed.protected int
The maximum size of character content chunks of Character Information Items or Comment Information Items that will be indexed.protected int
The minimum size of [normalized value] of Attribute Information Items that will be indexed.protected int
The minimum size of character content chunks of Character Information Items or Comment Information Items that will be indexed.private static int[]
Fields inherited from interface org.jvnet.fastinfoset.FastInfosetSerializer
ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINT, BUFFER_SIZE_PROPERTY, CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINT, EXTERNAL_VOCABULARIES_PROPERTY, IGNORE_COMMENTS_FEATURE, IGNORE_DTD_FEATURE, IGNORE_PROCESSING_INSTRUCTIONS_FEATURE, IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE, MAX_ATTRIBUTE_VALUE_SIZE, MAX_CHARACTER_CONTENT_CHUNK_SIZE, MIN_ATTRIBUTE_VALUE_SIZE, MIN_CHARACTER_CONTENT_CHUNK_SIZE, REGISTERED_ENCODING_ALGORITHMS_PROPERTY, UTF_16BE, UTF_8
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
_flush()
boolean
canAddAttributeToTable
(int length) Checks whether attribute table has enough memory to store attribute value with the given lengthboolean
canAddCharacterContentToTable
(int length, CharArrayIntMap map) Checks whether character content table has enough memory to store character content chunk with the given lengthprotected final void
encodeAIIBuiltInAlgorithmData
(int id, Object data, int offset, int length) Encode the [normalized value] of an Attribute Information Item using using a built in encoding algorithm.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeAIIObjectAlgorithmData
(int id, Object data, EncodingAlgorithm ea) Encode the [normalized value] of an Attribute Information Item using using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeAIIOctetAlgorithmData
(int id, byte[] d, int offset, int length) Encode the [normalized value] of an Attribute Information Item using using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeAlphabetCharacters
(String alphabet, char[] ch, int offset, int length, boolean addToTable) Encode a chunk of Character Information Items using a restricted alphabet table.protected final void
encodeAttributeQualifiedNameOnSecondBit
(String namespaceURI, String prefix, String localName) Encode a qualified name of an Attribute Informaiton Item on the third bit of an octet.Implementation of clause C.17 of ITU-T Rec.private void
encodeCharacterAsUtf8FourByte
(int c, char[] ch, int chpos, int chend, int bpos) protected final void
encodeCharacters
(char[] ch, int offset, int length) Encode a chunk of Character Information Items.protected final void
encodeCharactersNoClone
(char[] ch, int offset, int length) Encode a chunk of Character Information Items.protected final void
encodeCIIBuiltInAlgorithmData
(int id, Object data, int offset, int length) Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeCIIBuiltInAlgorithmDataAsCDATA
(char[] ch, int offset, int length) Encode a chunk of Character Information Items using using the CDATA built in encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeCIIObjectAlgorithmData
(int id, Object data, EncodingAlgorithm ea) Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeCIIOctetAlgorithmData
(int id, byte[] d, int offset, int length) Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.protected final void
encodeComment
(char[] ch, int offset, int length) Encode a Comment Information Item.protected final void
encodeCommentNoClone
(char[] ch, int offset, int length) Encode a Comment Information Item.If the array of characters that is a comment is to be indexed (as determined byisCharacterContentChunkLengthMatchesLimit(int)
) then the array is not cloned when adding the array to the vocabulary.protected final void
encodeDateTimeFourBitCharacters
(char[] ch, int offset, int length, boolean addToTable) Encode a chunk of Character Information Items using a date-time alphabet that results in the encoding of a character in 4 bits (or two characters per octet).protected final void
encodeDateTimeNonIdentifyingStringOnFirstBit
(String s, boolean addToTable, boolean mustBeAddedToTable) protected final void
Encode the termination of the Document Information Item.protected final void
encodeDocumentTypeDeclaration
(String systemId, String publicId) Encode a Document Type Declaration.protected final void
encodeElementQualifiedNameOnThirdBit
(String namespaceURI, String prefix, String localName) Encode a qualified name of an Element Information Item on the third bit of an octet.Implementation of clause C.18 of ITU-T Rec.protected final void
Encode the termination of an Element Information Item.protected final void
encodeFourBitCharacters
(int id, int[] table, char[] ch, int offset, int length, boolean addToTable) Encode a chunk of Character Information Items using a restricted alphabet that results in the encoding of a character in 4 bits (or two characters per octet).protected final void
encodeHeader
(boolean encodeXmlDecl) Encode the header of a fast infoset document.protected final void
Encode a non empty identifying string on the first bit of an octet.Implementation of clause C.13 of ITU-T Rec.protected final void
Encode the initial vocabulary of a fast infoset document.protected final boolean
encodeLiteralAttributeQualifiedNameOnSecondBit
(String namespaceURI, String prefix, String localName, LocalNameQualifiedNamesMap.Entry entry) Encode a literal qualified name of an Attribute InforImplementation of clause C.17 of ITU-T Rec.maiton IX.891 | ISO/IEC 24824-1.ause C.17 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeLiteralElementQualifiedNameOnThirdBit
(String namespaceURI, String prefix, String localName, LocalNameQualifiedNamesMap.Entry entry) Encode a literal qualified name of an Element InforImplementation of clause C.18 of ITU-T Rec.maiton IX.891 | ISO/IEC 24824-1.ause C.18 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeNamespaceAttribute
(String prefix, String uri) Encode a Attribute Information Item that is a namespace declaration.protected final void
encodeNonEmptyCharacterStringOnFifthBit
(char[] ch, int offset, int length) Encode a non empty string on the fifth bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.23 of ITU-T Rec.protected final void
Encode a non empty string on the fifth bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.23 of ITU-T Rec.protected final void
encodeNonEmptyCharacterStringOnSeventhBit
(char[] ch, int offset, int length) Encode a non empty string on the seventh bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.24 of ITU-T Rec.protected final void
encodeNonEmptyFourBitCharacterString
(int[] table, char[] ch, int offset, int octetPairLength, int octetSingleLength) protected final void
encodeNonEmptyFourBitCharacterStringOnSeventhBit
(int[] table, char[] ch, int offset, int length) Encode a non empty string on the seventh bit of an octet using a restricted alphabet that results in the encoding of a character in 4 bits (or two characters per octet).Implementation of clause C.24 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
encodeNonEmptyNBitCharacterStringOnSeventhBit
(String alphabet, char[] ch, int offset, int length) Encode a non empty string on the seventh bit of an octet using a restricted alphabet table.Implementation of clause C.24 of ITU-T Rec.X.891 | ISO/IEC 24824-1.protected final void
Encode a non empty string on the second bit of an octet using the UTF-8 encoding.Implementation of clause C.22 of ITU-T Rec.protected final void
encodeNonEmptyUTF8StringAsOctetString
(int b, char[] ch, int offset, int length, int[] constants) Encode a non empty string using the UTF-8 encoding.protected final void
encodeNonEmptyUTF8StringAsOctetString
(int b, String s, int[] constants) Encode a non empty string using the UTF-8 encoding.protected final void
encodeNonIdentifyingStringOnFirstBit
(char[] ch, int offset, int length, CharArrayIntMap map, boolean addToTable, boolean clone) Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnFirstBit
(int id, int[] table, String s, boolean addToTable, boolean mustBeAddedToTable) protected final void
encodeNonIdentifyingStringOnFirstBit
(String URI, int id, Object data) Encode a non identifying string on the first bit of an octet as binary data using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnFirstBit
(String s, CharArrayIntMap map, boolean addToTable) Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnFirstBit
(String s, StringIntMap map, boolean addToTable, boolean mustBeAddedToTable) Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnThirdBit
(char[] ch, int offset, int length, CharArrayIntMap map, boolean addToTable, boolean clone) Encode a non identifying string on the third bit of an octet.Implementation of clause C.15 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnThirdBit
(String URI, int id, byte[] d, int offset, int length) Encode a non identifying string on the third bit of an octet as binary data using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.protected final void
encodeNonIdentifyingStringOnThirdBit
(String URI, int id, Object data) Encode a non identifying string on the third bit of an octet as binary data using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.protected final void
encodeNonZeroInteger
(int b, int i, int[] constants) Encode a non zero integer.protected final void
Encode a non zero integer on the fourth bit of an octet.Implementation of clause C.28 of ITU-T Rec.protected final void
Encode a non zero integer on the second bit of an octet, setting the first bit to 1.Implementation of clause C.24 of ITU-T Rec.protected final void
Encode a non zero integer on the second bit of an octet, setting the first bit to 0.Implementation of clause C.25 of ITU-T Rec.protected final void
Encode a non zero integer on the third bit of an octet.Implementation of clause C.27 of ITU-T Rec.protected final void
encodeNonZeroOctetStringLength
(int b, int length, int[] constants) Encode the length of non empty UTF-8 encoded string.protected final void
encodeNonZeroOctetStringLengthOnFifthBit
(int length) Encode the length of a UTF-8 or UTF-16 encoded string on the fifth bit of an octet.Implementation of clause C.23 of ITU-T Rec.protected final void
encodeNonZeroOctetStringLengthOnSecondBit
(int length) Encode the length of a UTF-8 encoded string on the second bit of an octet.Implementation of clause C.22 of ITU-T Rec.protected final void
encodeNonZeroOctetStringLengthOnSenventhBit
(int length) Encode the length of a encoded string on the seventh bit of an octet.Implementation of clause C.24 of ITU-T Rec.protected final void
encodeNumericFourBitCharacters
(char[] ch, int offset, int length, boolean addToTable) Encode a chunk of Character Information Items using a numeric alphabet that results in the encoding of a character in 4 bits (or two characters per octet).protected final void
encodeNumericNonIdentifyingStringOnFirstBit
(String s, boolean addToTable, boolean mustBeAddedToTable) protected final void
encodeProcessingInstruction
(String target, String data) Encode a Processing Instruction Information Item.protected final void
Encode a termination if required.protected final int
encodeUtf16String
(char[] ch, int offset, int length) Encode a string using the UTF-16 encoding.protected final int
Encode a string using the UTF-16 encoding.protected final int
encodeUTF8String
(char[] ch, int offset, int length) Encode a string using the UTF-8 encoding.protected final int
Encode a string using the UTF-8 encoding.private void
ensureEncodingBufferSizeForUtf16String
(int length) private void
ensureEncodingBufferSizeForUtf8String
(int length) private void
ensureSize
(int length) int
Gets the limit on the memory size of Map of attribute values that will be indexed.int
Gets the limit on the memory size, allocated for indexed character content chunks.Gets the character encoding scheme.private static String
final boolean
final boolean
final boolean
final boolean
int
Gets the maximum size of attribute values that will be indexed.int
Gets the maximum size of character content chunks that might be indexed.int
Gets the minimum size of attribute values that will be indexed.int
Gets the minimum size of character content chunks that will be indexed.static String
getPrefixFromQualifiedName
(String qName) Obtain the prefix from a qualified name.Gets the set of registered encoding algorithms.Get the application data associated with the serializer vocabulary.protected final boolean
hasMark()
boolean
isAttributeValueLengthMatchesLimit
(int length) Checks whether attribute value (its length) matches length limitboolean
isCharacterContentChunkLengthMatchesLimit
(int length) Checks whether character content chunk (its length) matches length limitstatic boolean
isWhiteSpace
(char[] ch, int start, int length) Check if character array contains characters that are all white space.static boolean
Check if a String contains characters that are all white space.protected final void
mark()
Mark the current position in the buffered stream.private static int
maxCharacter
(String alphabet) void
reset()
Reset the encoder for reuse encoding another XML infoset.private void
protected final void
Reset the marked position in the buffered stream.private void
resize
(int length) void
setAttributeValueMapMemoryLimit
(int size) Sets the limit on the memory size of Map of attribute values that will be indexed.void
setCharacterContentChunkMapMemoryLimit
(int size) Sets the limit on the memory size, allocated for indexed character content chunks.final void
setCharacterEncodingScheme
(String characterEncodingScheme) Sets the character encoding scheme.void
Set the external vocabulary that shall be used when serializing.final void
setIgnoreComments
(boolean ignoreComments) final void
setIgnoreDTD
(boolean ignoreDTD) final void
setIgnoreProcesingInstructions
(boolean ignoreProcesingInstructions) final void
setIgnoreWhiteSpaceTextContent
(boolean ignoreWhiteSpaceTextContent) void
setMaxAttributeValueSize
(int size) Sets the maximum size of attribute values that will be indexed.void
setMaxCharacterContentChunkSize
(int size) Sets the maximum size of character content chunks that might be indexed.void
setMinAttributeValueSize
(int size) Sets the minimum size of attribute values that will be indexed.void
setMinCharacterContentChunkSize
(int size) Sets the minimum size of character content chunks that will be indexed.void
Set the OutputStream to encode the XML infoset to a fast infoset document.void
setRegisteredEncodingAlgorithms
(Map<String, EncodingAlgorithm> algorithms) Sets the set of registered encoding algorithms.void
setVocabulary
(SerializerVocabulary vocabulary) Set the SerializerVocabulary to be used for encoding.void
Set the application data to be associated with the serializer vocabulary.protected final void
write
(byte[] b, int length) Write an array of bytes to the buffered stream.protected final void
write
(byte[] b, int offset, int length) Write an array of bytes to the buffered stream.protected final void
write
(int i) Write a byte to the buffered stream.private void
writeBits
(int bits, int v) Methods inherited from class org.xml.sax.helpers.DefaultHandler
characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning
-
Field Details
-
CHARACTER_ENCODING_SCHEME_SYSTEM_PROPERTY
Character encoding scheme system property for the encoding of content and attribute values.- See Also:
-
_characterEncodingSchemeSystemDefault
Default character encoding scheme system property for the encoding of content and attribute values. -
NUMERIC_CHARACTERS_TABLE
private static int[] NUMERIC_CHARACTERS_TABLE -
DATE_TIME_CHARACTERS_TABLE
private static int[] DATE_TIME_CHARACTERS_TABLE -
_ignoreDTD
private boolean _ignoreDTDTrue if DTD and internal subset shall be ignored. -
_ignoreComments
private boolean _ignoreCommentsTrue if comments shall be ignored. -
_ignoreProcessingInstructions
private boolean _ignoreProcessingInstructionsTrue if procesing instructions shall be ignored. -
_ignoreWhiteSpaceTextContent
private boolean _ignoreWhiteSpaceTextContentTrue if white space characters for text content shall be ignored. -
_useLocalNameAsKeyForQualifiedNameLookup
private boolean _useLocalNameAsKeyForQualifiedNameLookupTrue, if the local name string is used as the key to find the associated set of qualified names.False, if the
<prefix>:<local name>
string is used as the key to find the associated set of qualified names. -
_encodingStringsAsUtf8
private boolean _encodingStringsAsUtf8True if strings for text content and attribute values will be UTF-8 encoded otherwise they will be UTF-16 encoded. -
_nonIdentifyingStringOnThirdBitCES
private int _nonIdentifyingStringOnThirdBitCESEncoding constant generated from the string encoding. -
_nonIdentifyingStringOnFirstBitCES
private int _nonIdentifyingStringOnFirstBitCESEncoding constant generated from the string encoding. -
_registeredEncodingAlgorithms
The map of URIs to algorithms. -
_v
The vocabulary that is used by the encoder -
_vData
The vocabulary application data that is used by the encoder -
_vIsInternal
private boolean _vIsInternalTrue if the vocubulary is internal to the encoder -
_terminate
protected boolean _terminateTrue if terminatation of an information item is required -
_b
protected int _bThe current octet that is to be written. -
_s
TheOutputStream
that the encoded XML infoset (the fast infoset document) is written to. -
_charBuffer
protected char[] _charBufferThe internal buffer of characters used for the UTF-8 or UTF-16 encoding of characters. -
_octetBuffer
protected byte[] _octetBufferThe internal buffer of bytes. -
_octetBufferIndex
protected int _octetBufferIndexThe current position in the internal buffer. -
_markIndex
protected int _markIndexThe current mark in the internal buffer.If the value of the mark is < 0 then the mark is not set.
-
minAttributeValueSize
protected int minAttributeValueSizeThe minimum size of [normalized value] of Attribute Information Items that will be indexed. -
maxAttributeValueSize
protected int maxAttributeValueSizeThe maximum size of [normalized value] of Attribute Information Items that will be indexed. -
attributeValueMapTotalCharactersConstraint
protected int attributeValueMapTotalCharactersConstraintThe limit on the size of indexed Map for attribute values Limit is measured in characters number -
minCharacterContentChunkSize
protected int minCharacterContentChunkSizeThe minimum size of character content chunks of Character Information Items or Comment Information Items that will be indexed. -
maxCharacterContentChunkSize
protected int maxCharacterContentChunkSizeThe maximum size of character content chunks of Character Information Items or Comment Information Items that will be indexed. -
characterContentChunkMapTotalCharactersConstraint
protected int characterContentChunkMapTotalCharactersConstraintThe limit on the size of indexed Map for character content chunks Limit is measured in characters number -
_bitsLeftInOctet
private int _bitsLeftInOctet -
_encodingBufferOutputStream
-
_encodingBuffer
private byte[] _encodingBuffer -
_encodingBufferIndex
private int _encodingBufferIndex
-
-
Constructor Details
-
Encoder
protected Encoder()Default constructor for the Encoder. -
Encoder
protected Encoder(boolean useLocalNameAsKeyForQualifiedNameLookup)
-
-
Method Details
-
getDefaultEncodingScheme
-
maxCharacter
-
setIgnoreDTD
public final void setIgnoreDTD(boolean ignoreDTD) Description copied from interface:FastInfosetSerializer
- Specified by:
setIgnoreDTD
in interfaceFastInfosetSerializer
- Parameters:
ignoreDTD
- true if the feature shall be ignored.
-
getIgnoreDTD
public final boolean getIgnoreDTD()Description copied from interface:FastInfosetSerializer
- Specified by:
getIgnoreDTD
in interfaceFastInfosetSerializer
- Returns:
- true if the feature is ignored, false otherwise.
-
setIgnoreComments
public final void setIgnoreComments(boolean ignoreComments) Description copied from interface:FastInfosetSerializer
- Specified by:
setIgnoreComments
in interfaceFastInfosetSerializer
- Parameters:
ignoreComments
- true if the feature shall be ignored.
-
getIgnoreComments
public final boolean getIgnoreComments()Description copied from interface:FastInfosetSerializer
- Specified by:
getIgnoreComments
in interfaceFastInfosetSerializer
- Returns:
- true if the feature is ignored, false otherwise.
-
setIgnoreProcesingInstructions
public final void setIgnoreProcesingInstructions(boolean ignoreProcesingInstructions) Description copied from interface:FastInfosetSerializer
- Specified by:
setIgnoreProcesingInstructions
in interfaceFastInfosetSerializer
- Parameters:
ignoreProcesingInstructions
- true if the feature shall be ignored.
-
getIgnoreProcesingInstructions
public final boolean getIgnoreProcesingInstructions()Description copied from interface:FastInfosetSerializer
- Specified by:
getIgnoreProcesingInstructions
in interfaceFastInfosetSerializer
- Returns:
- true if the feature is ignored, false otherwise.
-
setIgnoreWhiteSpaceTextContent
public final void setIgnoreWhiteSpaceTextContent(boolean ignoreWhiteSpaceTextContent) Description copied from interface:FastInfosetSerializer
- Specified by:
setIgnoreWhiteSpaceTextContent
in interfaceFastInfosetSerializer
- Parameters:
ignoreWhiteSpaceTextContent
- true if the feature shall be ignored.
-
getIgnoreWhiteSpaceTextContent
public final boolean getIgnoreWhiteSpaceTextContent()Description copied from interface:FastInfosetSerializer
- Specified by:
getIgnoreWhiteSpaceTextContent
in interfaceFastInfosetSerializer
- Returns:
- true if the feature is ignored, false otherwise.
-
setCharacterEncodingScheme
Description copied from interface:FastInfosetSerializer
Sets the character encoding scheme.The character encoding can be either UTF-8 or UTF-16BE for the the encoding of chunks of CIIs, the [normalized value] property of attribute information items, comment information items and processing instruction information items.
- Specified by:
setCharacterEncodingScheme
in interfaceFastInfosetSerializer
- Parameters:
characterEncodingScheme
- The set of registered algorithms.
-
getCharacterEncodingScheme
Description copied from interface:FastInfosetSerializer
Gets the character encoding scheme.- Specified by:
getCharacterEncodingScheme
in interfaceFastInfosetSerializer
- Returns:
- The character encoding scheme.
-
setRegisteredEncodingAlgorithms
Description copied from interface:FastInfosetSerializer
Sets the set of registered encoding algorithms.- Specified by:
setRegisteredEncodingAlgorithms
in interfaceFastInfosetSerializer
- Parameters:
algorithms
- The set of registered algorithms.
-
getRegisteredEncodingAlgorithms
Description copied from interface:FastInfosetSerializer
Gets the set of registered encoding algorithms.- Specified by:
getRegisteredEncodingAlgorithms
in interfaceFastInfosetSerializer
- Returns:
- The set of registered algorithms.
-
getMinCharacterContentChunkSize
public int getMinCharacterContentChunkSize()Description copied from interface:FastInfosetSerializer
Gets the minimum size of character content chunks that will be indexed.- Specified by:
getMinCharacterContentChunkSize
in interfaceFastInfosetSerializer
- Returns:
- The minimum character content chunk size.
-
setMinCharacterContentChunkSize
public void setMinCharacterContentChunkSize(int size) Description copied from interface:FastInfosetSerializer
Sets the minimum size of character content chunks that will be indexed.- Specified by:
setMinCharacterContentChunkSize
in interfaceFastInfosetSerializer
- Parameters:
size
- the minimum character content chunk size.
-
getMaxCharacterContentChunkSize
public int getMaxCharacterContentChunkSize()Description copied from interface:FastInfosetSerializer
Gets the maximum size of character content chunks that might be indexed.- Specified by:
getMaxCharacterContentChunkSize
in interfaceFastInfosetSerializer
- Returns:
- The maximum character content chunk size.
-
setMaxCharacterContentChunkSize
public void setMaxCharacterContentChunkSize(int size) Description copied from interface:FastInfosetSerializer
Sets the maximum size of character content chunks that might be indexed.- Specified by:
setMaxCharacterContentChunkSize
in interfaceFastInfosetSerializer
- Parameters:
size
- the maximum character content chunk size.
-
getCharacterContentChunkMapMemoryLimit
public int getCharacterContentChunkMapMemoryLimit()Description copied from interface:FastInfosetSerializer
Gets the limit on the memory size, allocated for indexed character content chunks.- Specified by:
getCharacterContentChunkMapMemoryLimit
in interfaceFastInfosetSerializer
- Returns:
- the limit on the memory size, allocated for indexed character content chunks.
-
setCharacterContentChunkMapMemoryLimit
public void setCharacterContentChunkMapMemoryLimit(int size) Description copied from interface:FastInfosetSerializer
Sets the limit on the memory size, allocated for indexed character content chunks.- Specified by:
setCharacterContentChunkMapMemoryLimit
in interfaceFastInfosetSerializer
- Parameters:
size
- the limit on the memory size, allocated for indexed character content chunks.
-
isCharacterContentChunkLengthMatchesLimit
public boolean isCharacterContentChunkLengthMatchesLimit(int length) Checks whether character content chunk (its length) matches length limit- Parameters:
length
- the length of character content chunk is checking to be added to Map.- Returns:
- whether character content chunk length matches limit
-
canAddCharacterContentToTable
Checks whether character content table has enough memory to store character content chunk with the given length- Parameters:
length
- the length of character content chunk is checking to be added to Map.map
- the custom CharArrayIntMap, which memory limits will be checked.- Returns:
- whether character content map has enough memory
-
getMinAttributeValueSize
public int getMinAttributeValueSize()Description copied from interface:FastInfosetSerializer
Gets the minimum size of attribute values that will be indexed.- Specified by:
getMinAttributeValueSize
in interfaceFastInfosetSerializer
- Returns:
- The minimum attribute values size.
-
setMinAttributeValueSize
public void setMinAttributeValueSize(int size) Description copied from interface:FastInfosetSerializer
Sets the minimum size of attribute values that will be indexed.- Specified by:
setMinAttributeValueSize
in interfaceFastInfosetSerializer
- Parameters:
size
- the minimum attribute values size.
-
getMaxAttributeValueSize
public int getMaxAttributeValueSize()Description copied from interface:FastInfosetSerializer
Gets the maximum size of attribute values that will be indexed.- Specified by:
getMaxAttributeValueSize
in interfaceFastInfosetSerializer
- Returns:
- The maximum attribute values size.
-
setMaxAttributeValueSize
public void setMaxAttributeValueSize(int size) Description copied from interface:FastInfosetSerializer
Sets the maximum size of attribute values that will be indexed.- Specified by:
setMaxAttributeValueSize
in interfaceFastInfosetSerializer
- Parameters:
size
- the maximum attribute values size.
-
setAttributeValueMapMemoryLimit
public void setAttributeValueMapMemoryLimit(int size) Description copied from interface:FastInfosetSerializer
Sets the limit on the memory size of Map of attribute values that will be indexed.- Specified by:
setAttributeValueMapMemoryLimit
in interfaceFastInfosetSerializer
- Parameters:
size
- The attribute value size limit. Any value less that a length of size limit will be indexed.
-
getAttributeValueMapMemoryLimit
public int getAttributeValueMapMemoryLimit()Description copied from interface:FastInfosetSerializer
Gets the limit on the memory size of Map of attribute values that will be indexed.- Specified by:
getAttributeValueMapMemoryLimit
in interfaceFastInfosetSerializer
- Returns:
- The attribute value size limit.
-
isAttributeValueLengthMatchesLimit
public boolean isAttributeValueLengthMatchesLimit(int length) Checks whether attribute value (its length) matches length limit- Parameters:
length
- the length of attribute- Returns:
- whether attribute value matches limit
-
canAddAttributeToTable
public boolean canAddAttributeToTable(int length) Checks whether attribute table has enough memory to store attribute value with the given length- Parameters:
length
- the length of attribute value is checking to be added to Map.- Returns:
- whether attribute map has enough memory
-
setExternalVocabulary
Description copied from interface:FastInfosetSerializer
Set the external vocabulary that shall be used when serializing.- Specified by:
setExternalVocabulary
in interfaceFastInfosetSerializer
- Parameters:
v
- the vocabulary.
-
setVocabularyApplicationData
Description copied from interface:FastInfosetSerializer
Set the application data to be associated with the serializer vocabulary.- Specified by:
setVocabularyApplicationData
in interfaceFastInfosetSerializer
- Parameters:
data
- the application data.
-
getVocabularyApplicationData
Description copied from interface:FastInfosetSerializer
Get the application data associated with the serializer vocabulary.- Specified by:
getVocabularyApplicationData
in interfaceFastInfosetSerializer
- Returns:
- the application data.
-
reset
public void reset()Reset the encoder for reuse encoding another XML infoset.- Specified by:
reset
in interfaceFastInfosetSerializer
-
setOutputStream
Set the OutputStream to encode the XML infoset to a fast infoset document.- Specified by:
setOutputStream
in interfaceFastInfosetSerializer
- Parameters:
s
- the OutputStream where the fast infoset document is written to.
-
setVocabulary
Set the SerializerVocabulary to be used for encoding.- Parameters:
vocabulary
- the vocabulary to be used for encoding.
-
encodeHeader
Encode the header of a fast infoset document.- Parameters:
encodeXmlDecl
- true if the XML declaration should be encoded.- Throws:
IOException
- on error
-
encodeInitialVocabulary
Encode the initial vocabulary of a fast infoset document.- Throws:
IOException
- on error
-
encodeDocumentTermination
Encode the termination of the Document Information Item.- Throws:
IOException
- on error
-
encodeElementTermination
Encode the termination of an Element Information Item.- Throws:
IOException
- on error
-
encodeTermination
Encode a termination if required.- Throws:
IOException
- on error
-
encodeNamespaceAttribute
Encode a Attribute Information Item that is a namespace declaration.- Parameters:
prefix
- the prefix of the namespace declaration, if "" then there is no prefix for the namespace declaration.uri
- the URI of the namespace declaration, if "" then there is no URI for the namespace declaration.- Throws:
IOException
- on error
-
encodeCharacters
Encode a chunk of Character Information Items.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeCharactersNoClone
Encode a chunk of Character Information Items. If the array of characters is to be indexed (as determined byisCharacterContentChunkLengthMatchesLimit(int)
) then the array is not cloned when adding the array to the vocabulary.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeNumericFourBitCharacters
protected final void encodeNumericFourBitCharacters(char[] ch, int offset, int length, boolean addToTable) throws FastInfosetException, IOException Encode a chunk of Character Information Items using a numeric alphabet that results in the encoding of a character in 4 bits (or two characters per octet).- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.addToTable
- if characters should be added to table.- Throws:
IOException
- on errorArrayIndexOutOfBoundsException
- on errorFastInfosetException
-
encodeDateTimeFourBitCharacters
protected final void encodeDateTimeFourBitCharacters(char[] ch, int offset, int length, boolean addToTable) throws FastInfosetException, IOException Encode a chunk of Character Information Items using a date-time alphabet that results in the encoding of a character in 4 bits (or two characters per octet).- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.addToTable
- if characters should be added to table.- Throws:
FastInfosetException
- on errorIOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeFourBitCharacters
protected final void encodeFourBitCharacters(int id, int[] table, char[] ch, int offset, int length, boolean addToTable) throws FastInfosetException, IOException Encode a chunk of Character Information Items using a restricted alphabet that results in the encoding of a character in 4 bits (or two characters per octet).- Parameters:
id
- the restricted alphabet identifier.table
- the table mapping characters to 4 bit values.ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.addToTable
- if characters should be added to table.- Throws:
FastInfosetException
- on errorIOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeAlphabetCharacters
protected final void encodeAlphabetCharacters(String alphabet, char[] ch, int offset, int length, boolean addToTable) throws FastInfosetException, IOException Encode a chunk of Character Information Items using a restricted alphabet table.- Parameters:
alphabet
- the alphabet defining the mapping between characters and integer values.ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.addToTable
- if characters should be added to table- Throws:
ArrayIndexOutOfBoundsException
- on errorIOException
- on errorFastInfosetException
- if the alphabet is not present in the vocabulary.
-
encodeProcessingInstruction
Encode a Processing Instruction Information Item.- Parameters:
target
- the target of the processing instruction.data
- the data of the processing instruction.- Throws:
IOException
- on error
-
encodeDocumentTypeDeclaration
protected final void encodeDocumentTypeDeclaration(String systemId, String publicId) throws IOException Encode a Document Type Declaration.- Parameters:
systemId
- the system identifier of the external subset.publicId
- the public identifier of the external subset.- Throws:
IOException
- on error
-
encodeComment
Encode a Comment Information Item.- Parameters:
ch
- the array of characters that is as comment.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeCommentNoClone
Encode a Comment Information Item.If the array of characters that is a comment is to be indexed (as determined byisCharacterContentChunkLengthMatchesLimit(int)
) then the array is not cloned when adding the array to the vocabulary.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on errorArrayIndexOutOfBoundsException
- on error
-
encodeElementQualifiedNameOnThirdBit
protected final void encodeElementQualifiedNameOnThirdBit(String namespaceURI, String prefix, String localName) throws IOException Encode a qualified name of an Element Information Item on the third bit of an octet.Implementation of clause C.18 of ITU-T Rec. X.891 | ISO/IEC 24824-1.The index of the qualified name will be encoded if the name is present in the vocabulary otherwise the qualified name will be encoded literally (see
encodeLiteralElementQualifiedNameOnThirdBit(java.lang.String, java.lang.String, java.lang.String, com.sun.xml.fastinfoset.util.LocalNameQualifiedNamesMap.Entry)
).- Parameters:
namespaceURI
- the namespace URI of the qualified name.prefix
- the prefix of the qualified name.localName
- the local name of the qualified name.- Throws:
IOException
- on error
-
encodeLiteralElementQualifiedNameOnThirdBit
protected final void encodeLiteralElementQualifiedNameOnThirdBit(String namespaceURI, String prefix, String localName, LocalNameQualifiedNamesMap.Entry entry) throws IOException Encode a literal qualified name of an Element InforImplementation of clause C.18 of ITU-T Rec.maiton IX.891 | ISO/IEC 24824-1.ause C.18 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
namespaceURI
- the namespace URI of the qualified name.prefix
- the prefix of the qualified name.- Throws:
IOException
- localName the local name of the qualified name.
-
encodeAttributeQualifiedNameOnSecondBit
protected final void encodeAttributeQualifiedNameOnSecondBit(String namespaceURI, String prefix, String localName) throws IOException Encode a qualified name of an Attribute Informaiton Item on the third bit of an octet.Implementation of clause C.17 of ITU-T Rec. X.891 | ISO/IEC 24824-1.The index of the qualified name will be encoded if the name is present in the vocabulary otherwise the qualified name will be encoded literally (see
encodeLiteralAttributeQualifiedNameOnSecondBit(java.lang.String, java.lang.String, java.lang.String, com.sun.xml.fastinfoset.util.LocalNameQualifiedNamesMap.Entry)
).- Parameters:
namespaceURI
- the namespace URI of the qualified name.prefix
- the prefix of the qualified name.localName
- the local name of the qualified name.- Throws:
IOException
- on error
-
encodeLiteralAttributeQualifiedNameOnSecondBit
protected final boolean encodeLiteralAttributeQualifiedNameOnSecondBit(String namespaceURI, String prefix, String localName, LocalNameQualifiedNamesMap.Entry entry) throws IOException Encode a literal qualified name of an Attribute InforImplementation of clause C.17 of ITU-T Rec.maiton IX.891 | ISO/IEC 24824-1.ause C.17 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
namespaceURI
- the namespace URI of the qualified name.prefix
- the prefix of the qualified name.localName
- the local name of the qualified name.- Returns:
- localName the local name of the qualified name.
- Throws:
IOException
- on error
-
encodeNonIdentifyingStringOnFirstBit
protected final void encodeNonIdentifyingStringOnFirstBit(String s, StringIntMap map, boolean addToTable, boolean mustBeAddedToTable) throws IOException Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
s
- the string to encodemap
- the vocabulary table of strings to indexes.addToTable
- true if the string could be added to the vocabulary table (if table has enough memory)mustBeAddedToTable
- true if the string must be added to the vocabulary table (if not already present in the table).- Throws:
IOException
- on error
-
encodeNonIdentifyingStringOnFirstBit
protected final void encodeNonIdentifyingStringOnFirstBit(String s, CharArrayIntMap map, boolean addToTable) throws IOException Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
s
- the string to encodemap
- the vocabulary table of character arrays to indexes.addToTable
- true if the string should be added to the vocabulary table (if not already present in the table).- Throws:
IOException
- on error
-
encodeNonIdentifyingStringOnFirstBit
protected final void encodeNonIdentifyingStringOnFirstBit(char[] ch, int offset, int length, CharArrayIntMap map, boolean addToTable, boolean clone) throws IOException Encode a non identifying string on the first bit of an octet.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.map
- the vocabulary table of character arrays to indexes.addToTable
- true if the string should be added to the vocabulary table (if not already present in the table).clone
- true if the array of characters should be cloned if added to the vocabulary table.- Throws:
IOException
- on error
-
encodeNumericNonIdentifyingStringOnFirstBit
protected final void encodeNumericNonIdentifyingStringOnFirstBit(String s, boolean addToTable, boolean mustBeAddedToTable) throws IOException, FastInfosetException - Throws:
IOException
FastInfosetException
-
encodeDateTimeNonIdentifyingStringOnFirstBit
protected final void encodeDateTimeNonIdentifyingStringOnFirstBit(String s, boolean addToTable, boolean mustBeAddedToTable) throws IOException, FastInfosetException - Throws:
IOException
FastInfosetException
-
encodeNonIdentifyingStringOnFirstBit
protected final void encodeNonIdentifyingStringOnFirstBit(int id, int[] table, String s, boolean addToTable, boolean mustBeAddedToTable) throws IOException, FastInfosetException - Throws:
IOException
FastInfosetException
-
encodeNonIdentifyingStringOnFirstBit
protected final void encodeNonIdentifyingStringOnFirstBit(String URI, int id, Object data) throws FastInfosetException, IOException Encode a non identifying string on the first bit of an octet as binary data using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
URI
- the encoding algorithm URI. If the URI == null then the encoding algorithm identifier takes precendence.id
- the encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm.- Throws:
EncodingAlgorithmException
- if the encoding algorithm URI is not present in the vocabulary, or the encoding algorithm identifier is not with the required range.IOException
- on errorFastInfosetException
-
encodeAIIOctetAlgorithmData
protected final void encodeAIIOctetAlgorithmData(int id, byte[] d, int offset, int length) throws IOException Encode the [normalized value] of an Attribute Information Item using using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
id
- the encoding algorithm identifier.d
- the data, as an array of bytes, to be encoded.offset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
IOException
- on error
-
encodeAIIObjectAlgorithmData
protected final void encodeAIIObjectAlgorithmData(int id, Object data, EncodingAlgorithm ea) throws FastInfosetException, IOException Encode the [normalized value] of an Attribute Information Item using using an encoding algorithm.Implementation of clause C.14 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
id
- the encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm.ea
- the encoding algorithm to use to encode the data into an array of bytes.- Throws:
FastInfosetException
- on errorIOException
- on error
-
encodeAIIBuiltInAlgorithmData
protected final void encodeAIIBuiltInAlgorithmData(int id, Object data, int offset, int length) throws IOException Encode the [normalized value] of an Attribute Information Item using using a built in encoding algorithm.Implementation of clause C.14 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
id
- the built in encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm. The data represents an array of items specified by the encoding algorithm identifieroffset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
IOException
-
encodeNonIdentifyingStringOnThirdBit
protected final void encodeNonIdentifyingStringOnThirdBit(char[] ch, int offset, int length, CharArrayIntMap map, boolean addToTable, boolean clone) throws IOException Encode a non identifying string on the third bit of an octet.Implementation of clause C.15 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.map
- the vocabulary table of character arrays to indexes.addToTable
- true if the array of characters should be added to the vocabulary table (if not already present in the table).clone
- true if the array of characters should be cloned if added to the vocabulary table.- Throws:
IOException
- on error
-
encodeNonIdentifyingStringOnThirdBit
protected final void encodeNonIdentifyingStringOnThirdBit(String URI, int id, Object data) throws FastInfosetException, IOException Encode a non identifying string on the third bit of an octet as binary data using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
URI
- the encoding algorithm URI. If the URI == null then the encoding algorithm identifier takes precendence.id
- the encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm.- Throws:
EncodingAlgorithmException
- if the encoding algorithm URI is not present in the vocabulary, or the encoding algorithm identifier is not with the required range.IOException
- on errorFastInfosetException
-
encodeNonIdentifyingStringOnThirdBit
protected final void encodeNonIdentifyingStringOnThirdBit(String URI, int id, byte[] d, int offset, int length) throws FastInfosetException, IOException Encode a non identifying string on the third bit of an octet as binary data using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
URI
- the encoding algorithm URI. If the URI == null then the encoding algorithm identifier takes precendence.id
- the encoding algorithm identifier.d
- the data, as an array of bytes, to be encoded.offset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
EncodingAlgorithmException
- if the encoding algorithm URI is not present in the vocabulary.IOException
- on errorFastInfosetException
-
encodeCIIOctetAlgorithmData
protected final void encodeCIIOctetAlgorithmData(int id, byte[] d, int offset, int length) throws IOException Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
id
- the encoding algorithm identifier.d
- the data, as an array of bytes, to be encoded.offset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
IOException
- on error
-
encodeCIIObjectAlgorithmData
protected final void encodeCIIObjectAlgorithmData(int id, Object data, EncodingAlgorithm ea) throws FastInfosetException, IOException Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
id
- the encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm.ea
- the encoding algorithm to use to encode the data into an array of bytes.- Throws:
FastInfosetException
- on errorIOException
- on error
-
encodeCIIBuiltInAlgorithmData
protected final void encodeCIIBuiltInAlgorithmData(int id, Object data, int offset, int length) throws FastInfosetException, IOException Encode a chunk of Character Information Items using using an encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
id
- the built in encoding algorithm identifier.data
- the data to be encoded using an encoding algorithm. The data represents an array of items specified by the encoding algorithm identifieroffset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
FastInfosetException
- on errorIOException
- on error
-
encodeCIIBuiltInAlgorithmDataAsCDATA
protected final void encodeCIIBuiltInAlgorithmDataAsCDATA(char[] ch, int offset, int length) throws FastInfosetException, IOException Encode a chunk of Character Information Items using using the CDATA built in encoding algorithm.Implementation of clause C.15 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
FastInfosetException
- on errorIOException
- on error
-
encodeIdentifyingNonEmptyStringOnFirstBit
protected final void encodeIdentifyingNonEmptyStringOnFirstBit(String s, StringIntMap map) throws IOException Encode a non empty identifying string on the first bit of an octet.Implementation of clause C.13 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
s
- the identifying string.map
- the vocabulary table to use to determin the index of the identifying string- Throws:
IOException
- on error
-
encodeNonEmptyOctetStringOnSecondBit
Encode a non empty string on the second bit of an octet using the UTF-8 encoding.Implementation of clause C.22 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
s
- the string.- Throws:
IOException
- on error
-
encodeNonZeroOctetStringLengthOnSecondBit
Encode the length of a UTF-8 encoded string on the second bit of an octet.Implementation of clause C.22 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
length
- the length to encode.- Throws:
IOException
- on error
-
encodeNonEmptyCharacterStringOnFifthBit
Encode a non empty string on the fifth bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.23 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
s
- the string.- Throws:
IOException
- on error
-
encodeNonEmptyCharacterStringOnFifthBit
protected final void encodeNonEmptyCharacterStringOnFifthBit(char[] ch, int offset, int length) throws IOException Encode a non empty string on the fifth bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.23 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on error
-
encodeNonZeroOctetStringLengthOnFifthBit
Encode the length of a UTF-8 or UTF-16 encoded string on the fifth bit of an octet.Implementation of clause C.23 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
length
- the length to encode.- Throws:
IOException
- on error
-
encodeNonEmptyCharacterStringOnSeventhBit
protected final void encodeNonEmptyCharacterStringOnSeventhBit(char[] ch, int offset, int length) throws IOException Encode a non empty string on the seventh bit of an octet using the UTF-8 or UTF-16 encoding.Implementation of clause C.24 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on error
-
encodeNonEmptyFourBitCharacterStringOnSeventhBit
protected final void encodeNonEmptyFourBitCharacterStringOnSeventhBit(int[] table, char[] ch, int offset, int length) throws FastInfosetException, IOException Encode a non empty string on the seventh bit of an octet using a restricted alphabet that results in the encoding of a character in 4 bits (or two characters per octet).Implementation of clause C.24 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
table
- the table mapping characters to 4 bit values.ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
FastInfosetException
- on errorIOException
- on error
-
encodeNonEmptyFourBitCharacterString
protected final void encodeNonEmptyFourBitCharacterString(int[] table, char[] ch, int offset, int octetPairLength, int octetSingleLength) throws FastInfosetException, IOException - Throws:
FastInfosetException
IOException
-
encodeNonEmptyNBitCharacterStringOnSeventhBit
protected final void encodeNonEmptyNBitCharacterStringOnSeventhBit(String alphabet, char[] ch, int offset, int length) throws FastInfosetException, IOException Encode a non empty string on the seventh bit of an octet using a restricted alphabet table.Implementation of clause C.24 of ITU-T Rec.X.891 | ISO/IEC 24824-1.- Parameters:
alphabet
- the alphabet defining the mapping between characters and integer values.ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
FastInfosetException
- on errorIOException
- on error
-
resetBits
private void resetBits() -
writeBits
- Throws:
IOException
-
encodeNonZeroOctetStringLengthOnSenventhBit
Encode the length of a encoded string on the seventh bit of an octet.Implementation of clause C.24 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
length
- the length to encode.- Throws:
IOException
- on error
-
encodeNonZeroIntegerOnSecondBitFirstBitOne
Encode a non zero integer on the second bit of an octet, setting the first bit to 1.Implementation of clause C.24 of ITU-T Rec. X.891 | ISO/IEC 24824-1.The first bit of the first octet is set, as specified in clause C.13 of ITU-T Rec. X.891 | ISO/IEC 24824-1
- Parameters:
i
- The integer to encode, which is a member of the interval [0, 1048575]. In the specification the interval is [1, 1048576]- Throws:
IOException
- on error
-
encodeNonZeroIntegerOnSecondBitFirstBitZero
Encode a non zero integer on the second bit of an octet, setting the first bit to 0.Implementation of clause C.25 of ITU-T Rec. X.891 | ISO/IEC 24824-1.The first bit of the first octet is set, as specified in clause C.13 of ITU-T Rec. X.891 | ISO/IEC 24824-1
- Parameters:
i
- The integer to encode, which is a member of the interval [0, 1048575]. In the specification the interval is [1, 1048576]- Throws:
IOException
- on error
-
encodeNonZeroIntegerOnThirdBit
Encode a non zero integer on the third bit of an octet.Implementation of clause C.27 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
i
- The integer to encode, which is a member of the interval [0, 1048575]. In the specification the interval is [1, 1048576]- Throws:
IOException
- on error
-
encodeNonZeroIntegerOnFourthBit
Encode a non zero integer on the fourth bit of an octet.Implementation of clause C.28 of ITU-T Rec. X.891 | ISO/IEC 24824-1.- Parameters:
i
- The integer to encode, which is a member of the interval [0, 1048575]. In the specification the interval is [1, 1048576]- Throws:
IOException
- on error
-
encodeNonEmptyUTF8StringAsOctetString
protected final void encodeNonEmptyUTF8StringAsOctetString(int b, String s, int[] constants) throws IOException Encode a non empty string using the UTF-8 encoding.- Parameters:
b
- the current octet that is being written.s
- the string to be UTF-8 encoded.constants
- the array of constants to use when encoding to determin how the length of the UTF-8 encoded string is encoded.- Throws:
IOException
- on error
-
encodeNonEmptyUTF8StringAsOctetString
protected final void encodeNonEmptyUTF8StringAsOctetString(int b, char[] ch, int offset, int length, int[] constants) throws IOException Encode a non empty string using the UTF-8 encoding.- Parameters:
b
- the current octet that is being written.ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters. how the length of the UTF-8 encoded string is encoded.constants
- the array of constants to use when encoding to determin how the length of the UTF-8 encoded string is encoded.- Throws:
IOException
-
encodeNonZeroOctetStringLength
protected final void encodeNonZeroOctetStringLength(int b, int length, int[] constants) throws IOException Encode the length of non empty UTF-8 encoded string.- Parameters:
b
- the current octet that is being written.length
- the length of the UTF-8 encoded string. how the length of the UTF-8 encoded string is encoded.constants
- the array of constants to use when encoding to determin how the length of the UTF-8 encoded string is encoded.- Throws:
IOException
- on error
-
encodeNonZeroInteger
Encode a non zero integer.- Parameters:
b
- the current octet that is being written.i
- the non zero integer.constants
- the array of constants to use when encoding to determin how the non zero integer is encoded.- Throws:
IOException
- on error
-
mark
protected final void mark()Mark the current position in the buffered stream. -
resetMark
protected final void resetMark()Reset the marked position in the buffered stream. -
hasMark
protected final boolean hasMark()- Returns:
- true if the mark has been set, otherwise false if the mark has not been set.
-
write
Write a byte to the buffered stream.- Throws:
IOException
- on error
-
write
Write an array of bytes to the buffered stream.- Parameters:
b
- the array of bytes.length
- the length of bytes.- Throws:
IOException
- on error
-
write
Write an array of bytes to the buffered stream.- Parameters:
b
- the array of bytes.offset
- the offset into the array of bytes.length
- the length of bytes.- Throws:
IOException
- on error
-
ensureSize
private void ensureSize(int length) -
resize
private void resize(int length) -
_flush
- Throws:
IOException
-
encodeUTF8String
Encode a string using the UTF-8 encoding.- Parameters:
s
- the string to encode.- Throws:
IOException
- on error
-
ensureEncodingBufferSizeForUtf8String
private void ensureEncodingBufferSizeForUtf8String(int length) -
encodeUTF8String
Encode a string using the UTF-8 encoding.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on error
-
encodeCharacterAsUtf8FourByte
private void encodeCharacterAsUtf8FourByte(int c, char[] ch, int chpos, int chend, int bpos) throws IOException - Throws:
IOException
-
encodeUtf16String
Encode a string using the UTF-16 encoding.- Parameters:
s
- the string to encode.- Throws:
IOException
- on error
-
ensureEncodingBufferSizeForUtf16String
private void ensureEncodingBufferSizeForUtf16String(int length) -
encodeUtf16String
Encode a string using the UTF-16 encoding.- Parameters:
ch
- the array of characters.offset
- the offset into the array of characters.length
- the length of characters.- Throws:
IOException
- on error
-
getPrefixFromQualifiedName
Obtain the prefix from a qualified name.- Parameters:
qName
- the qualified name- Returns:
- the prefix, or "" if there is no prefix.
-
isWhiteSpace
public static boolean isWhiteSpace(char[] ch, int start, int length) Check if character array contains characters that are all white space.- Parameters:
ch
- the character arraystart
- the starting character index into the array to check fromlength
- the number of characters to check- Returns:
- true if all characters are white space, false otherwise
-
isWhiteSpace
Check if a String contains characters that are all white space.- Parameters:
s
- the string- Returns:
- true if all characters are white space, false otherwise
-