Package org.apache.abdera.parser

Interface ParserOptions

All Superinterfaces:
Cloneable
All Known Implementing Classes:
AbstractParserOptions
@Deprecated(since="2021-07-29") public interface ParserOptions extends Cloneable
Deprecated.
This API is deprecated as Apache Abdera is a retired project since 2017.
Parser options are used to modify the behavior of the parser.

  • Method Details

    • clone

      Object clone() throws CloneNotSupportedException
      Deprecated.
      Throws:
      CloneNotSupportedException

    • getFactory

      Factory getFactory()
      Deprecated.
      Returns the factory the parser should use

    • setFactory

      ParserOptions setFactory(Factory factory)
      Deprecated.
      Sets the factory the parser should use

    • getCharset

      String getCharset()
      Deprecated.
      Returns the default character set to use for the parsed document

    • setCharset

      ParserOptions setCharset(String charset)
      Deprecated.
      Sets the character set to use for the parsed document

    • getParseFilter

      ParseFilter getParseFilter()
      Deprecated.
      Returns the Parse Filter. The parse filter is a set of XML QNames that the parse should watch out for. If the filter is null, the parser will parse all elements in the document. I the filter is not null, the parser will only pay attention to elements whose QName's appear in the filter list.

    • setParseFilter

      ParserOptions setParseFilter(ParseFilter parseFilter)
      Deprecated.
      Sets the Parse Filter. The parse filter is a set of XML QNames that the parse should watch out for. If the filter is null, the parser will parse all elements in the document. I the filter is not null, the parser will only pay attention to elements whose QName's appear in the filter list.

    • getAutodetectCharset

      boolean getAutodetectCharset()
      Deprecated.
      Returns true if the parser should attempt to automatically detect the character encoding from the stream

    • setAutodetectCharset

      ParserOptions setAutodetectCharset(boolean detect)
      Deprecated.
      If true, the parser will attempt to automatically detect the character encoding from the stream by checking for the byte order mark or checking the XML prolog.

    • getMustPreserveWhitespace

      boolean getMustPreserveWhitespace()
      Deprecated.
      If false, the parser will trim leading and trailing whitespace in element and attribute values unless there is an in-scope xml:space="preserve".

    • setMustPreserveWhitespace

      ParserOptions setMustPreserveWhitespace(boolean preserve)
      Deprecated.
      If false, the parser will trim leading and trailing whitespace in element and attribute values unless there is an in-scope xml:space="preserve".

    • getFilterRestrictedCharacters

      boolean getFilterRestrictedCharacters()
      Deprecated.
      If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document.

    • setFilterRestrictedCharacters

      ParserOptions setFilterRestrictedCharacters(boolean filter)
      Deprecated.
      If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document

    • getFilterRestrictedCharacterReplacement

      char getFilterRestrictedCharacterReplacement()
      Deprecated.
      If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character

    • setFilterRestrictedCharacterReplacement

      ParserOptions setFilterRestrictedCharacterReplacement(char replacement)
      Deprecated.
      If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character

    • getCompressionCodecs

      CompressionUtil.CompressionCodec[] getCompressionCodecs()
      Deprecated.
      When parsing an InputStream that contains compressed data, use these codecs to decompress the stream. Only used when parsing an InputStream. Ignored when parsing a Reader

    • setCompressionCodecs

      ParserOptions setCompressionCodecs(CompressionUtil.CompressionCodec... codecs)
      Deprecated.
      When parsing an InputStream that contains compressed data, use these codecs to decompress the stream. Only used when parsing an InputStream. Ignored when parsing a Reader

    • registerEntity

      ParserOptions registerEntity(String name, String value)
      Deprecated.
      Register a named entity. This provides an escape clause for when feeds use entities that are not supported in XML without a DTD decl. By default, all of the (X)HTML entities are preregistered

    • resolveEntity

      String resolveEntity(String name)
      Deprecated.
      Resolves a value for a named entity. This provides an escape clause for when feeds use entities that are not supported in XML without a DTD decl. By default, all of the (X)HTML entities are preregistered

    • setResolveEntities

      ParserOptions setResolveEntities(boolean resolve)
      Deprecated.
      True if undeclared named entities should be resolved.

    • getResolveEntities

      boolean getResolveEntities()
      Deprecated.
      True if undeclared named entities should be resolved.

    • setQNameAliasMappingEnabled

      ParserOptions setQNameAliasMappingEnabled(boolean enabled)
      Deprecated.
      True if QName-Alias mapping is enabled

    • isQNameAliasMappingEnabled

      boolean isQNameAliasMappingEnabled()
      Deprecated.
      True if QName-Alias mapping is enabled (default is false)

    • getQNameAliasMap

      Map<QName,QName> getQNameAliasMap()
      Deprecated.
      Get the QName-Alias Mapping (default null)

    • setQNameAliasMap

      ParserOptions setQNameAliasMap(Map<QName,QName> map)
      Deprecated.
      Set the QName-Alias Mapping