Package org.apache.abdera.util

Class AbstractParserOptions

java.lang.Object

org.apache.abdera.util.AbstractParserOptions

All Implemented Interfaces:

Cloneable, ParserOptions

public abstract class AbstractParserOptions
extends Object
implements ParserOptions, Cloneable

Non thread-safe abstract implementation of ParserOptions

Method Summary

Modifier and Type	Method	Description
Object	clone()
boolean	getAutodetectCharset()	Returns true if the parser should attempt to automatically detect the character encoding from the stream
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.
Map<QName,QName>	getQNameAliasMap()	Get the QName-Alias Mapping (default null)
boolean	getResolveEntities()	True if undeclared named entities should be resolved.
boolean	isQNameAliasMappingEnabled()	True if QName-Alias mapping is enabled (default is false)
ParserOptions	registerEntity(String name, String value)	Register a named entity.
String	resolveEntity(String name)	Resolves a value for a named entity.
ParserOptions	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.
ParserOptions	setCharset(String charset)	Sets the character set to use for the parsed document
ParserOptions	setCompressionCodecs(CompressionUtil.CompressionCodec... codecs)	When parsing an InputStream that contains compressed data, use these codecs to decompress the stream.
ParserOptions	setFactory(Factory factory)	Sets the factory the parser should use
ParserOptions	setFilterRestrictedCharacterReplacement(char replacement)	If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character
ParserOptions	setFilterRestrictedCharacters(boolean filter)	If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document
ParserOptions	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".
ParserOptions	setParseFilter(ParseFilter parseFilter)	Sets the Parse Filter.
ParserOptions	setQNameAliasMap(Map<QName,QName> map)	Set the QName-Alias Mapping
ParserOptions	setQNameAliasMappingEnabled(boolean enabled)	True if QName-Alias mapping is enabled
ParserOptions	setResolveEntities(boolean resolve)	True if undeclared named entities should be resolved.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface ParserOptions

Throws:

CloneNotSupportedException

getFactory

public Factory getFactory()

Description copied from interface: ParserOptions

Returns the factory the parser should use

Specified by:

getFactory in interface ParserOptions

setFactory

public ParserOptions setFactory(Factory factory)

Description copied from interface: ParserOptions

Sets the factory the parser should use

Specified by:

setFactory in interface ParserOptions

getCharset

public String getCharset()

Description copied from interface: ParserOptions

Returns the default character set to use for the parsed document

Specified by:

getCharset in interface ParserOptions

setCharset

public ParserOptions setCharset(String charset)

Description copied from interface: ParserOptions

Sets the character set to use for the parsed document

Specified by:

setCharset in interface ParserOptions

getParseFilter

public ParseFilter getParseFilter()

Description copied from interface: ParserOptions

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.

Specified by:

getParseFilter in interface ParserOptions

setParseFilter

public ParserOptions setParseFilter(ParseFilter parseFilter)

Description copied from interface: ParserOptions

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.

Specified by:

setParseFilter in interface ParserOptions

getAutodetectCharset

public boolean getAutodetectCharset()

Description copied from interface: ParserOptions

Returns true if the parser should attempt to automatically detect the character encoding from the stream

Specified by:

getAutodetectCharset in interface ParserOptions

setAutodetectCharset

public ParserOptions setAutodetectCharset(boolean detect)

Description copied from interface: ParserOptions

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.

Specified by:

setAutodetectCharset in interface ParserOptions

getMustPreserveWhitespace

public boolean getMustPreserveWhitespace()

Description copied from interface: ParserOptions

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

Specified by:

getMustPreserveWhitespace in interface ParserOptions

setMustPreserveWhitespace

public ParserOptions setMustPreserveWhitespace(boolean preserve)

Description copied from interface: ParserOptions

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

Specified by:

setMustPreserveWhitespace in interface ParserOptions

getFilterRestrictedCharacters

public boolean getFilterRestrictedCharacters()

Description copied from interface: ParserOptions

If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document.

Specified by:

getFilterRestrictedCharacters in interface ParserOptions

setFilterRestrictedCharacters

public ParserOptions setFilterRestrictedCharacters(boolean filter)

Description copied from interface: ParserOptions

If true, the parser will attempt to silently filter out invalid XML characters appearing within the XML document

Specified by:

setFilterRestrictedCharacters in interface ParserOptions

getFilterRestrictedCharacterReplacement

public char getFilterRestrictedCharacterReplacement()

Description copied from interface: ParserOptions

If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character

Specified by:

getFilterRestrictedCharacterReplacement in interface ParserOptions

setFilterRestrictedCharacterReplacement

public ParserOptions setFilterRestrictedCharacterReplacement(char replacement)

Description copied from interface: ParserOptions

If getFilterRestrictedCharacters is true, restricted characters will be replaced with the specified character

Specified by:

setFilterRestrictedCharacterReplacement in interface ParserOptions

getCompressionCodecs

public CompressionUtil.CompressionCodec[] getCompressionCodecs()

Description copied from interface: ParserOptions

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

Specified by:

getCompressionCodecs in interface ParserOptions

setCompressionCodecs

public ParserOptions setCompressionCodecs(CompressionUtil.CompressionCodec... codecs)

Description copied from interface: ParserOptions

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

Specified by:

setCompressionCodecs in interface ParserOptions

registerEntity

public ParserOptions registerEntity(String name,
                                    String value)

Description copied from interface: ParserOptions

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

Specified by:

registerEntity in interface ParserOptions

resolveEntity

public String resolveEntity(String name)

Description copied from interface: ParserOptions

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

Specified by:

resolveEntity in interface ParserOptions

setResolveEntities

public ParserOptions setResolveEntities(boolean resolve)

Description copied from interface: ParserOptions

True if undeclared named entities should be resolved.

Specified by:

setResolveEntities in interface ParserOptions

getResolveEntities

public boolean getResolveEntities()

Description copied from interface: ParserOptions

True if undeclared named entities should be resolved.

Specified by:

getResolveEntities in interface ParserOptions

getQNameAliasMap

public Map<QName,QName> getQNameAliasMap()

Description copied from interface: ParserOptions

Get the QName-Alias Mapping (default null)

Specified by:

getQNameAliasMap in interface ParserOptions

setQNameAliasMap

public ParserOptions setQNameAliasMap(Map<QName,QName> map)

Description copied from interface: ParserOptions

Set the QName-Alias Mapping

Specified by:

setQNameAliasMap in interface ParserOptions

isQNameAliasMappingEnabled

public boolean isQNameAliasMappingEnabled()

Description copied from interface: ParserOptions

True if QName-Alias mapping is enabled (default is false)

Specified by:

isQNameAliasMappingEnabled in interface ParserOptions

setQNameAliasMappingEnabled

public ParserOptions setQNameAliasMappingEnabled(boolean enabled)

Description copied from interface: ParserOptions

True if QName-Alias mapping is enabled

Specified by:

setQNameAliasMappingEnabled in interface ParserOptions