Top Description Fields Methods
org.jvnet.fastinfoset

public Interface FastInfosetParser

Known Direct Subinterfaces
org.jvnet.fastinfoset.sax.FastInfosetReader
Known Direct Implementers
com.sun.xml.fastinfoset.Decoder
Imports
java.util.Map, com.sun.xml.fastinfoset.vocab.ParserVocabulary

A general interface for parsers of fast infoset documents.

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

Author
[email protected]

Field Summary

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

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

public static final String
FORCE_STREAM_CLOSE_PROPERTY

The property name to be used for getting and setting the flag, which will indicate whether underlying Parser's input stream should be really closed

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
STRING_INTERNING_PROPERTY

The property name to be used for getting and setting the string interning property of a parser.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The buffer size.
getBufferSize
()

Get the buffer size.

public Map<String, ParserVocabulary>

Returns:

the map of URI to vocabulary.
getExternalVocabularies
()
Deprecated The map returned will not be the same instance and contain the same entries as the map set by setExternalVocabularies method.

Get the map of referenced external vocabularies.

public boolean

Returns:

The force stream close property.
getForceStreamClose
()

Return the force stream close property.

public boolean

Returns:

The parse fragments property.
getParseFragments
()

Return the parse fragments property.

public Map<String, EncodingAlgorithm>

Returns:

The set of registered algorithms.
getRegisteredEncodingAlgorithms
()

Gets the set of registered encoding algorithms.

public boolean

Returns:

The string interning property.
getStringInterning
()

Return the string interning property.

public void
setBufferSize(int
The requested buffer size.
bufferSize
)

Set the buffer size.

public void
setExternalVocabularies(Map<String, ParserVocabulary>
the map of URI to vocabulary.
referencedVocabualries
)

Set the map of referenced external vocabularies.

public void
setForceStreamClose(boolean
The force stream close property.
needForceStreamClose
)

Set the force stream close property.

public void
setParseFragments(boolean
The parse fragments property.
parseFragments
)

Set the parse fragments property.

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

Sets the set of registered encoding algorithms.

public void
setStringInterning(boolean
The string interning property.
stringInterning
)

Set the string interning property.

Field Detail

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.

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.

FORCE_STREAM_CLOSE_PROPERTYback to summary
public static final String FORCE_STREAM_CLOSE_PROPERTY

The property name to be used for getting and setting the flag, which will indicate whether underlying Parser's input stream should be really closed

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.

STRING_INTERNING_PROPERTYback to summary
public static final String STRING_INTERNING_PROPERTY

The property name to be used for getting and setting the string interning property of a parser.

Method Detail

getBufferSizeback to summary
public int getBufferSize()

Get the buffer size.

Returns:int

The buffer size.

getExternalVocabulariesback to summary
public Map<String, ParserVocabulary> getExternalVocabularies()

Deprecated

The map returned will not be the same instance and contain the same entries as the map set by setExternalVocabularies method.

Get the map of referenced external vocabularies.

Returns:Map<String, ParserVocabulary>

the map of URI to vocabulary.

Annotations
@Deprecated
getForceStreamCloseback to summary
public boolean getForceStreamClose()

Return the force stream close property.

Returns:boolean

The force stream close property.

getParseFragmentsback to summary
public boolean getParseFragments()

Return the parse fragments property.

Returns:boolean

The parse fragments property.

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

Gets the set of registered encoding algorithms.

Returns:Map<String, EncodingAlgorithm>

The set of registered algorithms.

getStringInterningback to summary
public boolean getStringInterning()

Return the string interning property.

Returns:boolean

The string interning property.

setBufferSizeback to summary
public void setBufferSize(int bufferSize)

Set the buffer size.

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.

Parameters
bufferSize:int

The requested buffer size.

setExternalVocabulariesback to summary
public void setExternalVocabularies(Map<String, ParserVocabulary> referencedVocabualries)

Set the map of referenced external vocabularies.

The map (but not the keys and values) be cloned.

Parameters
referencedVocabualries:Map<String, ParserVocabulary>

the map of URI to vocabulary.

setForceStreamCloseback to summary
public void setForceStreamClose(boolean needForceStreamClose)

Set the force stream close property.

If the force stream property is set to true then Parser's underlying InputStream will be closed.

Parameters
needForceStreamClose:boolean

The force stream close property.

setParseFragmentsback to summary
public void setParseFragments(boolean parseFragments)

Set the parse fragments property.

If the parse fragments property is set to true then fragments of an XML infoset may be parsed.

Parameters
parseFragments:boolean

The parse fragments property.

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.

setStringInterningback to summary
public void setStringInterning(boolean stringInterning)

Set the string interning property.

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().

Parameters
stringInterning:boolean

The string interning property.