org.apache.abdera.parser
Interface ParserOptions

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
AbstractParserOptions

public interface ParserOptions
extends java.lang.Cloneable

Parser options are used to modify the behavior of the parser.


Method Summary
 java.lang.Object clone()
           
 boolean getAutodetectCharset()
          Returns true if the parser should attempt to automatically detect the character encoding from the stream
 java.lang.String getCharset()
          Returns the default character set to use for the parsed document
 CompressionUtil.CompressionCodec[] getCompressionCodecs()
          When parsing an InputStream that contains compressed data, use these codecs to decompress the stream.
 Factory getFactory()
          Returns the factory the parser should use
 char getFilterRestrictedCharacterReplacement()
          If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character
 boolean getFilterRestrictedCharacters()
          If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document.
 boolean getMustPreserveWhitespace()
          If false, the parser will trim leading and trailing whitespace in element and attribute values unless there is an in-scope xml:space="preserve".
 ParseFilter getParseFilter()
          Returns the Parse Filter.
 void setAutodetectCharset(boolean detect)
          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.
 void setCharset(java.lang.String charset)
          Sets the character set to use for the parsed document
 void setCompressionCodecs(CompressionUtil.CompressionCodec... codecs)
          When parsing an InputStream that contains compressed data, use these codecs to decompress the stream.
 void setFactory(Factory factory)
          Sets the factory the parser should use
 void setFilterRestrictedCharacterReplacement(char replacement)
          If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character
 void setFilterRestrictedCharacters(boolean filter)
          If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document
 void setMustPreserveWhitespace(boolean preserve)
          If false, the parser will trim leading and trailing whitespace in element and attribute values unless there is an in-scope xml:space="preserve".
 void setParseFilter(ParseFilter parseFilter)
          Sets the Parse Filter.
 

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException

getFactory

Factory getFactory()
Returns the factory the parser should use


setFactory

void setFactory(Factory factory)
Sets the factory the parser should use


getCharset

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


setCharset

void setCharset(java.lang.String charset)
Sets the character set to use for the parsed document


getParseFilter

ParseFilter getParseFilter()
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

void setParseFilter(ParseFilter parseFilter)
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()
Returns true if the parser should attempt to automatically detect the character encoding from the stream


setAutodetectCharset

void setAutodetectCharset(boolean detect)
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()
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

void setMustPreserveWhitespace(boolean preserve)
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()
If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document.


setFilterRestrictedCharacters

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


getFilterRestrictedCharacterReplacement

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


setFilterRestrictedCharacterReplacement

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


getCompressionCodecs

CompressionUtil.CompressionCodec[] getCompressionCodecs()
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

void setCompressionCodecs(CompressionUtil.CompressionCodec... codecs)
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