org.jvnet.fastinfoset
Interface FastInfosetParser

All Known Subinterfaces:
FastInfosetReader
All Known Implementing Classes:
Decoder, DOMDocumentParser, SAXDocumentParser, StAXDocumentParser

public interface FastInfosetParser

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:
Paul.Sandoz@Sun.Com

Field Summary
static java.lang.String BUFFER_SIZE_PROPERTY
          The property name to be used for getting and setting the buffer size of a parser.
static java.lang.String EXTERNAL_VOCABULARIES_PROPERTY
          The property name to be used for getting and setting the Map containing external vocabularies.
static java.lang.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
static java.lang.String REGISTERED_ENCODING_ALGORITHMS_PROPERTY
          The property name to be used for getting and setting the Map containing encoding algorithms.
static java.lang.String STRING_INTERNING_PROPERTY
          The property name to be used for getting and setting the string interning property of a parser.
 
Method Summary
 int getBufferSize()
          Get the buffer size.
 java.util.Map getExternalVocabularies()
          Deprecated. The map returned will not be the same instance and contain the same entries as the map set by setExternalVocabularies(java.util.Map) method.
 boolean getForceStreamClose()
          Return the force stream close property.
 boolean getParseFragments()
          Return the parse fragments property.
 java.util.Map getRegisteredEncodingAlgorithms()
          Gets the set of registered encoding algorithms.
 boolean getStringInterning()
          Return the string interning property.
 void setBufferSize(int bufferSize)
          Set the buffer size.
 void setExternalVocabularies(java.util.Map referencedVocabualries)
          Set the map of referenced external vocabularies.
 void setForceStreamClose(boolean needForceStreamClose)
          Set the force stream close property.
 void setParseFragments(boolean parseFragments)
          Set the parse fragments property.
 void setRegisteredEncodingAlgorithms(java.util.Map algorithms)
          Sets the set of registered encoding algorithms.
 void setStringInterning(boolean stringInterning)
          Set the string interning property.
 

Field Detail

STRING_INTERNING_PROPERTY

static final java.lang.String STRING_INTERNING_PROPERTY
The property name to be used for getting and setting the string interning property of a parser.

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

FORCE_STREAM_CLOSE_PROPERTY

static final java.lang.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

See Also:
Constant Field Values
Method Detail

setStringInterning

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 - The string interning property.

getStringInterning

boolean getStringInterning()
Return the string interning property.

Returns:
The string interning property.

setBufferSize

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 - The requested buffer size.

getBufferSize

int getBufferSize()
Get the buffer size.

Returns:
The buffer size.

setRegisteredEncodingAlgorithms

void setRegisteredEncodingAlgorithms(java.util.Map algorithms)
Sets the set of registered encoding algorithms.

Parameters:
algorithms - The set of registered algorithms.

getRegisteredEncodingAlgorithms

java.util.Map getRegisteredEncodingAlgorithms()
Gets the set of registered encoding algorithms.

Returns:
The set of registered algorithms.

setExternalVocabularies

void setExternalVocabularies(java.util.Map referencedVocabualries)
Set the map of referenced external vocabularies.

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

Parameters:
referencedVocabualries - the map of URI to vocabulary.

getExternalVocabularies

java.util.Map getExternalVocabularies()
Deprecated. The map returned will not be the same instance and contain the same entries as the map set by setExternalVocabularies(java.util.Map) method.

Get the map of referenced external vocabularies.

Returns:
the map of URI to vocabulary.

setParseFragments

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 - The parse fragments property.

getParseFragments

boolean getParseFragments()
Return the parse fragments property.

Returns:
The parse fragments property.

setForceStreamClose

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 - The force stream close property.

getForceStreamClose

boolean getForceStreamClose()
Return the force stream close property.

Returns:
The force stream close property.