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.

  • Field Details

    • STRING_INTERNING_PROPERTY

      static final String STRING_INTERNING_PROPERTY
      The property name to be used for getting and setting the string interning property of a parser.
      See Also:
    • BUFFER_SIZE_PROPERTY

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

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

      static final String EXTERNAL_VOCABULARIES_PROPERTY
      The property name to be used for getting and setting the Map containing external vocabularies.
      See Also:
    • FORCE_STREAM_CLOSE_PROPERTY

      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
      See Also:
  • Method Details

    • 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(Map<String,EncodingAlgorithm> algorithms)
      Sets the set of registered encoding algorithms.
      Parameters:
      algorithms - The set of registered algorithms.
    • getRegisteredEncodingAlgorithms

      Map<String,EncodingAlgorithm> getRegisteredEncodingAlgorithms()
      Gets the set of registered encoding algorithms.
      Returns:
      The set of registered algorithms.
    • setExternalVocabularies

      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 - the map of URI to vocabulary.
    • getExternalVocabularies

      @Deprecated 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(java.util.Map<java.lang.String, com.sun.xml.fastinfoset.vocab.ParserVocabulary>) 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.