Interface FastInfosetSerializer

    • Field Detail

      • IGNORE_DTD_FEATURE

        static final java.lang.String IGNORE_DTD_FEATURE
        The feature to ignore the document type declaration and the internal subset.

        The default value is false. If true a serializer shall ignore document type declaration and the internal subset.

        See Also:
        Constant Field Values
      • IGNORE_COMMENTS_FEATURE

        static final java.lang.String IGNORE_COMMENTS_FEATURE
        The feature to ignore comments.

        The default value is false. If true a serializer shall ignore comments and shall not serialize them.

        See Also:
        Constant Field Values
      • IGNORE_PROCESSING_INSTRUCTIONS_FEATURE

        static final java.lang.String IGNORE_PROCESSING_INSTRUCTIONS_FEATURE
        The feature to ignore processing instructions.

        The default value is false. If true a serializer shall ignore processing instructions and shall not serialize them.

        See Also:
        Constant Field Values
      • IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE

        static final java.lang.String IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE
        The feature to ignore text content that consists completely of white space characters.

        The default value is false. If true a serializer shall ignore text content that consists completely of white space characters.

        See Also:
        Constant Field Values
      • BUFFER_SIZE_PROPERTY

        static final java.lang.String BUFFER_SIZE_PROPERTY
        The property name to be used for getting and setting the buffer size of a parser.
        See Also:
        Constant Field Values
      • REGISTERED_ENCODING_ALGORITHMS_PROPERTY

        static final java.lang.String REGISTERED_ENCODING_ALGORITHMS_PROPERTY
        The property name to be used for getting and setting the Map containing encoding algorithms.
        See Also:
        Constant Field Values
      • EXTERNAL_VOCABULARIES_PROPERTY

        static final java.lang.String EXTERNAL_VOCABULARIES_PROPERTY
        The property name to be used for getting and setting the Map containing external vocabularies.
        See Also:
        Constant Field Values
      • MIN_CHARACTER_CONTENT_CHUNK_SIZE

        static final int MIN_CHARACTER_CONTENT_CHUNK_SIZE
        The default minimum size of the character content chunks, that will be indexed.
        See Also:
        Constant Field Values
      • MAX_CHARACTER_CONTENT_CHUNK_SIZE

        static final int MAX_CHARACTER_CONTENT_CHUNK_SIZE
        The default maximum size of the character content chunks, that will be indexed.
        See Also:
        Constant Field Values
      • CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINT

        static final int CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINT
        The default value for limit on the size of indexed Map for attribute values Limit is measured in bytes not in number of entries
        See Also:
        Constant Field Values
      • MIN_ATTRIBUTE_VALUE_SIZE

        static final int MIN_ATTRIBUTE_VALUE_SIZE
        The default minimum size of the attribute values, that will be indexed.
        See Also:
        Constant Field Values
      • MAX_ATTRIBUTE_VALUE_SIZE

        static final int MAX_ATTRIBUTE_VALUE_SIZE
        The default maximum size of the attribute values, that will be indexed.
        See Also:
        Constant Field Values
      • ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINT

        static final int ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINT
        The default value for limit on the size of indexed Map for attribute values Limit is measured in bytes not in number of entries
        See Also:
        Constant Field Values
      • UTF_8

        static final java.lang.String UTF_8
        The character encoding scheme string for UTF-8.
        See Also:
        Constant Field Values
      • UTF_16BE

        static final java.lang.String UTF_16BE
        The character encoding scheme string for UTF-16BE.
        See Also:
        Constant Field Values
    • Method Detail

      • setIgnoreDTD

        void setIgnoreDTD​(boolean ignoreDTD)
        Parameters:
        ignoreDTD - true if the feature shall be ignored.
      • getIgnoreDTD

        boolean getIgnoreDTD()
        Returns:
        true if the feature is ignored, false otherwise.
      • setIgnoreComments

        void setIgnoreComments​(boolean ignoreComments)
        Parameters:
        ignoreComments - true if the feature shall be ignored.
      • getIgnoreComments

        boolean getIgnoreComments()
        Returns:
        true if the feature is ignored, false otherwise.
      • setIgnoreProcesingInstructions

        void setIgnoreProcesingInstructions​(boolean ignoreProcesingInstructions)
        Parameters:
        ignoreProcesingInstructions - true if the feature shall be ignored.
      • setIgnoreWhiteSpaceTextContent

        void setIgnoreWhiteSpaceTextContent​(boolean ignoreWhiteSpaceTextContent)
        Parameters:
        ignoreWhiteSpaceTextContent - true if the feature shall be ignored.
      • setCharacterEncodingScheme

        void setCharacterEncodingScheme​(java.lang.String characterEncodingScheme)
        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.
        Parameters:
        characterEncodingScheme - The set of registered algorithms.
      • getCharacterEncodingScheme

        java.lang.String getCharacterEncodingScheme()
        Gets the character encoding scheme.
        Returns:
        The character encoding scheme.
      • setRegisteredEncodingAlgorithms

        void setRegisteredEncodingAlgorithms​(java.util.Map<java.lang.String,​EncodingAlgorithm> algorithms)
        Sets the set of registered encoding algorithms.
        Parameters:
        algorithms - The set of registered algorithms.
      • getRegisteredEncodingAlgorithms

        java.util.Map<java.lang.String,​EncodingAlgorithm> getRegisteredEncodingAlgorithms()
        Gets the set of registered encoding algorithms.
        Returns:
        The set of registered algorithms.
      • getMinCharacterContentChunkSize

        int getMinCharacterContentChunkSize()
        Gets the minimum size of character content chunks that will be indexed.
        Returns:
        The minimum character content chunk size.
      • setMinCharacterContentChunkSize

        void setMinCharacterContentChunkSize​(int size)
        Sets the minimum size of character content chunks that will be indexed.
        Parameters:
        size - the minimum character content chunk size.
      • getMaxCharacterContentChunkSize

        int getMaxCharacterContentChunkSize()
        Gets the maximum size of character content chunks that might be indexed.
        Returns:
        The maximum character content chunk size.
      • setMaxCharacterContentChunkSize

        void setMaxCharacterContentChunkSize​(int size)
        Sets the maximum size of character content chunks that might be indexed.
        Parameters:
        size - the maximum character content chunk size.
      • getCharacterContentChunkMapMemoryLimit

        int getCharacterContentChunkMapMemoryLimit()
        Gets the limit on the memory size, allocated for indexed character content chunks.
        Returns:
        the limit on the memory size, allocated for indexed character content chunks.
      • setCharacterContentChunkMapMemoryLimit

        void setCharacterContentChunkMapMemoryLimit​(int size)
        Sets the limit on the memory size, allocated for indexed character content chunks.
        Parameters:
        size - the limit on the memory size, allocated for indexed character content chunks.
      • getMinAttributeValueSize

        int getMinAttributeValueSize()
        Gets the minimum size of attribute values that will be indexed.
        Returns:
        The minimum attribute values size.
      • setMinAttributeValueSize

        void setMinAttributeValueSize​(int size)
        Sets the minimum size of attribute values that will be indexed.
        Parameters:
        size - the minimum attribute values size.
      • getMaxAttributeValueSize

        int getMaxAttributeValueSize()
        Gets the maximum size of attribute values that will be indexed.
        Returns:
        The maximum attribute values size.
      • setMaxAttributeValueSize

        void setMaxAttributeValueSize​(int size)
        Sets the maximum size of attribute values that will be indexed.
        Parameters:
        size - the maximum attribute values size.
      • getAttributeValueMapMemoryLimit

        int getAttributeValueMapMemoryLimit()
        Gets the limit on the memory size of Map of attribute values that will be indexed.
        Returns:
        The attribute value size limit.
      • setAttributeValueMapMemoryLimit

        void setAttributeValueMapMemoryLimit​(int size)
        Sets the limit on the memory size of Map of attribute values that will be indexed.
        Parameters:
        size - The attribute value size limit. Any value less that a length of size limit will be indexed.
      • setExternalVocabulary

        void setExternalVocabulary​(ExternalVocabulary v)
        Set the external vocabulary that shall be used when serializing.
        Parameters:
        v - the vocabulary.
      • setVocabularyApplicationData

        void setVocabularyApplicationData​(VocabularyApplicationData data)
        Set the application data to be associated with the serializer vocabulary.
        Parameters:
        data - the application data.
      • getVocabularyApplicationData

        VocabularyApplicationData getVocabularyApplicationData()
        Get the application data associated with the serializer vocabulary.
        Returns:
        the application data.
      • reset

        void reset()
        Reset the serializer for reuse serializing another XML infoset.
      • setOutputStream

        void setOutputStream​(java.io.OutputStream s)
        Set the OutputStream to serialize the XML infoset to a fast infoset document.
        Parameters:
        s - the OutputStream where the fast infoset document is written to.