Top Description Fields Methods
org.jvnet.fastinfoset

public Interface FastInfosetSerializer

Known Direct Subinterfaces
org.jvnet.fastinfoset.sax.FastInfosetWriter
Known Direct Implementers
com.sun.xml.fastinfoset.Encoder
Imports
java.io.OutputStream, java.util.Map
A general interface for serializers of fast infoset documents.

This interface contains common methods that are not specific to any API associated with the serialization of XML Infoset to fast infoset documents.

Author
[email protected]

Field Summary

Modifier and TypeField and Description
public 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

public static final String
BUFFER_SIZE_PROPERTY

The property name to be used for getting and setting the buffer size of a parser.

public 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

public static final String
EXTERNAL_VOCABULARIES_PROPERTY

The property name to be used for getting and setting the Map containing external vocabularies.

public static final String
IGNORE_COMMENTS_FEATURE

The feature to ignore comments.

public static final String
IGNORE_DTD_FEATURE

The feature to ignore the document type declaration and the internal subset.

public static final String
IGNORE_PROCESSING_INSTRUCTIONS_FEATURE

The feature to ignore processing instructions.

public static final String
IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE

The feature to ignore text content that consists completely of white space characters.

public static final int
MAX_ATTRIBUTE_VALUE_SIZE

The default maximum size of the attribute values, that will be indexed.

public static final int
MAX_CHARACTER_CONTENT_CHUNK_SIZE

The default maximum size of the character content chunks, that will be indexed.

public static final int
MIN_ATTRIBUTE_VALUE_SIZE

The default minimum size of the attribute values, that will be indexed.

public static final int
MIN_CHARACTER_CONTENT_CHUNK_SIZE

The default minimum size of the character content chunks, that will be indexed.

public static final String
REGISTERED_ENCODING_ALGORITHMS_PROPERTY

The property name to be used for getting and setting the Map containing encoding algorithms.

public static final String
UTF_16BE

The character encoding scheme string for UTF-16BE.

public static final String
UTF_8

The character encoding scheme string for UTF-8.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The attribute value size limit.
getAttributeValueMapMemoryLimit()

Gets the limit on the memory size of Map of attribute values that will be indexed.

public int

Returns:

the limit on the memory size, allocated for indexed character content chunks.
getCharacterContentChunkMapMemoryLimit()

Gets the limit on the memory size, allocated for indexed character content chunks.

public String

Returns:

The character encoding scheme.
getCharacterEncodingScheme()

Gets the character encoding scheme.

public boolean

Returns:

true if the feature is ignored, false otherwise.
getIgnoreComments()

Get the IGNORE_COMMENTS_FEATURE.

public boolean

Returns:

true if the feature is ignored, false otherwise.
getIgnoreDTD()

Get the IGNORE_DTD_FEATURE.

public boolean

Returns:

true if the feature is ignored, false otherwise.
getIgnoreProcesingInstructions()

Get the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE.

public boolean

Returns:

true if the feature is ignored, false otherwise.
getIgnoreWhiteSpaceTextContent()

Get the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE.

public int

Returns:

The maximum attribute values size.
getMaxAttributeValueSize()

Gets the maximum size of attribute values that will be indexed.

public int

Returns:

The maximum character content chunk size.
getMaxCharacterContentChunkSize()

Gets the maximum size of character content chunks that might be indexed.

public int

Returns:

The minimum attribute values size.
getMinAttributeValueSize()

Gets the minimum size of attribute values that will be indexed.

public int

Returns:

The minimum character content chunk size.
getMinCharacterContentChunkSize()

Gets the minimum size of character content chunks that will be indexed.

public Map<String, EncodingAlgorithm>

Returns:

The set of registered algorithms.
getRegisteredEncodingAlgorithms()

Gets the set of registered encoding algorithms.

public VocabularyApplicationData

Returns:

the application data.
getVocabularyApplicationData()

Get the application data associated with the serializer vocabulary.

public void
reset()

Reset the serializer for reuse serializing another XML infoset.

public void
setAttributeValueMapMemoryLimit(int
The attribute value size limit. Any value less that a length of size limit will be indexed.
size)

Sets the limit on the memory size of Map of attribute values that will be indexed.

public void
setCharacterContentChunkMapMemoryLimit(int
the limit on the memory size, allocated for indexed character content chunks.
size)

Sets the limit on the memory size, allocated for indexed character content chunks.

public void
setCharacterEncodingScheme(String
The set of registered algorithms.
characterEncodingScheme)

Sets the character encoding scheme.

public void
setExternalVocabulary(ExternalVocabulary
the vocabulary.
v)

Set the external vocabulary that shall be used when serializing.

public void
setIgnoreComments(boolean
true if the feature shall be ignored.
ignoreComments)

Set the IGNORE_COMMENTS_FEATURE.

public void
setIgnoreDTD(boolean
true if the feature shall be ignored.
ignoreDTD)

Set the IGNORE_DTD_FEATURE.

public void
setIgnoreProcesingInstructions(boolean
true if the feature shall be ignored.
ignoreProcesingInstructions)

Set the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE.

public void
setIgnoreWhiteSpaceTextContent(boolean
true if the feature shall be ignored.
ignoreWhiteSpaceTextContent)

Set the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE.

public void
setMaxAttributeValueSize(int
the maximum attribute values size.
size)

Sets the maximum size of attribute values that will be indexed.

public void
setMaxCharacterContentChunkSize(int
the maximum character content chunk size.
size)

Sets the maximum size of character content chunks that might be indexed.

public void
setMinAttributeValueSize(int
the minimum attribute values size.
size)

Sets the minimum size of attribute values that will be indexed.

public void
setMinCharacterContentChunkSize(int
the minimum character content chunk size.
size)

Sets the minimum size of character content chunks that will be indexed.

public void
setOutputStream(OutputStream
the OutputStream where the fast infoset document is written to.
s)

Set the OutputStream to serialize the XML infoset to a fast infoset document.

public void
setRegisteredEncodingAlgorithms(Map<String, EncodingAlgorithm>
The set of registered algorithms.
algorithms)

Sets the set of registered encoding algorithms.

public void
setVocabularyApplicationData(VocabularyApplicationData
the application data.
data)

Set the application data to be associated with the serializer vocabulary.

Field Detail

ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINTback to summary
public 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

BUFFER_SIZE_PROPERTYback to summary
public static final String BUFFER_SIZE_PROPERTY

The property name to be used for getting and setting the buffer size of a parser.

CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINTback to summary
public 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

EXTERNAL_VOCABULARIES_PROPERTYback to summary
public static final String EXTERNAL_VOCABULARIES_PROPERTY

The property name to be used for getting and setting the Map containing external vocabularies.

IGNORE_COMMENTS_FEATUREback to summary
public static final 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.

IGNORE_DTD_FEATUREback to summary
public static final 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.

IGNORE_PROCESSING_INSTRUCTIONS_FEATUREback to summary
public static final 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.

IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATUREback to summary
public static final 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.

MAX_ATTRIBUTE_VALUE_SIZEback to summary
public static final int MAX_ATTRIBUTE_VALUE_SIZE

The default maximum size of the attribute values, that will be indexed.

MAX_CHARACTER_CONTENT_CHUNK_SIZEback to summary
public static final int MAX_CHARACTER_CONTENT_CHUNK_SIZE

The default maximum size of the character content chunks, that will be indexed.

MIN_ATTRIBUTE_VALUE_SIZEback to summary
public static final int MIN_ATTRIBUTE_VALUE_SIZE

The default minimum size of the attribute values, that will be indexed.

MIN_CHARACTER_CONTENT_CHUNK_SIZEback to summary
public static final int MIN_CHARACTER_CONTENT_CHUNK_SIZE

The default minimum size of the character content chunks, that will be indexed.

REGISTERED_ENCODING_ALGORITHMS_PROPERTYback to summary
public static final String REGISTERED_ENCODING_ALGORITHMS_PROPERTY

The property name to be used for getting and setting the Map containing encoding algorithms.

UTF_16BEback to summary
public static final String UTF_16BE

The character encoding scheme string for UTF-16BE.

UTF_8back to summary
public static final String UTF_8

The character encoding scheme string for UTF-8.

Method Detail

getAttributeValueMapMemoryLimitback to summary
public int getAttributeValueMapMemoryLimit()

Gets the limit on the memory size of Map of attribute values that will be indexed.

Returns:int

The attribute value size limit.

getCharacterContentChunkMapMemoryLimitback to summary
public int getCharacterContentChunkMapMemoryLimit()

Gets the limit on the memory size, allocated for indexed character content chunks.

Returns:int

the limit on the memory size, allocated for indexed character content chunks.

getCharacterEncodingSchemeback to summary
public String getCharacterEncodingScheme()

Gets the character encoding scheme.

Returns:String

The character encoding scheme.

getIgnoreCommentsback to summary
public boolean getIgnoreComments()

Get the IGNORE_COMMENTS_FEATURE.

Returns:boolean

true if the feature is ignored, false otherwise.

getIgnoreDTDback to summary
public boolean getIgnoreDTD()

Get the IGNORE_DTD_FEATURE.

Returns:boolean

true if the feature is ignored, false otherwise.

getIgnoreProcesingInstructionsback to summary
public boolean getIgnoreProcesingInstructions()

Get the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE.

Returns:boolean

true if the feature is ignored, false otherwise.

getIgnoreWhiteSpaceTextContentback to summary
public boolean getIgnoreWhiteSpaceTextContent()

Get the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE.

Returns:boolean

true if the feature is ignored, false otherwise.

getMaxAttributeValueSizeback to summary
public int getMaxAttributeValueSize()

Gets the maximum size of attribute values that will be indexed.

Returns:int

The maximum attribute values size.

getMaxCharacterContentChunkSizeback to summary
public int getMaxCharacterContentChunkSize()

Gets the maximum size of character content chunks that might be indexed.

Returns:int

The maximum character content chunk size.

getMinAttributeValueSizeback to summary
public int getMinAttributeValueSize()

Gets the minimum size of attribute values that will be indexed.

Returns:int

The minimum attribute values size.

getMinCharacterContentChunkSizeback to summary
public int getMinCharacterContentChunkSize()

Gets the minimum size of character content chunks that will be indexed.

Returns:int

The minimum character content chunk size.

getRegisteredEncodingAlgorithmsback to summary
public Map<String, EncodingAlgorithm> getRegisteredEncodingAlgorithms()

Gets the set of registered encoding algorithms.

Returns:Map<String, EncodingAlgorithm>

The set of registered algorithms.

getVocabularyApplicationDataback to summary
public VocabularyApplicationData getVocabularyApplicationData()

Get the application data associated with the serializer vocabulary.

Returns:VocabularyApplicationData

the application data.

resetback to summary
public void reset()

Reset the serializer for reuse serializing another XML infoset.

setAttributeValueMapMemoryLimitback to summary
public void setAttributeValueMapMemoryLimit(int size)

Sets the limit on the memory size of Map of attribute values that will be indexed.

Parameters
size:int

The attribute value size limit. Any value less that a length of size limit will be indexed.

setCharacterContentChunkMapMemoryLimitback to summary
public void setCharacterContentChunkMapMemoryLimit(int size)

Sets the limit on the memory size, allocated for indexed character content chunks.

Parameters
size:int

the limit on the memory size, allocated for indexed character content chunks.

setCharacterEncodingSchemeback to summary
public void setCharacterEncodingScheme(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:String

The set of registered algorithms.

setExternalVocabularyback to summary
public void setExternalVocabulary(ExternalVocabulary v)

Set the external vocabulary that shall be used when serializing.

Parameters
v:ExternalVocabulary

the vocabulary.

setIgnoreCommentsback to summary
public void setIgnoreComments(boolean ignoreComments)

Set the IGNORE_COMMENTS_FEATURE.

Parameters
ignoreComments:boolean

true if the feature shall be ignored.

setIgnoreDTDback to summary
public void setIgnoreDTD(boolean ignoreDTD)

Set the IGNORE_DTD_FEATURE.

Parameters
ignoreDTD:boolean

true if the feature shall be ignored.

setIgnoreProcesingInstructionsback to summary
public void setIgnoreProcesingInstructions(boolean ignoreProcesingInstructions)

Set the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE.

Parameters
ignoreProcesingInstructions:boolean

true if the feature shall be ignored.

setIgnoreWhiteSpaceTextContentback to summary
public void setIgnoreWhiteSpaceTextContent(boolean ignoreWhiteSpaceTextContent)

Set the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE.

Parameters
ignoreWhiteSpaceTextContent:boolean

true if the feature shall be ignored.

setMaxAttributeValueSizeback to summary
public void setMaxAttributeValueSize(int size)

Sets the maximum size of attribute values that will be indexed.

Parameters
size:int

the maximum attribute values size.

setMaxCharacterContentChunkSizeback to summary
public void setMaxCharacterContentChunkSize(int size)

Sets the maximum size of character content chunks that might be indexed.

Parameters
size:int

the maximum character content chunk size.

setMinAttributeValueSizeback to summary
public void setMinAttributeValueSize(int size)

Sets the minimum size of attribute values that will be indexed.

Parameters
size:int

the minimum attribute values size.

setMinCharacterContentChunkSizeback to summary
public void setMinCharacterContentChunkSize(int size)

Sets the minimum size of character content chunks that will be indexed.

Parameters
size:int

the minimum character content chunk size.

setOutputStreamback to summary
public void setOutputStream(OutputStream s)

Set the OutputStream to serialize the XML infoset to a fast infoset document.

Parameters
s:OutputStream

the OutputStream where the fast infoset document is written to.

setRegisteredEncodingAlgorithmsback to summary
public void setRegisteredEncodingAlgorithms(Map<String, EncodingAlgorithm> algorithms)

Sets the set of registered encoding algorithms.

Parameters
algorithms:Map<String, EncodingAlgorithm>

The set of registered algorithms.

setVocabularyApplicationDataback to summary
public void setVocabularyApplicationData(VocabularyApplicationData data)

Set the application data to be associated with the serializer vocabulary.

Parameters
data:VocabularyApplicationData

the application data.