org.xwiki.xml.html
Interface HTMLCleanerConfiguration

All Known Implementing Classes:

DefaultHTMLCleanerConfiguration

public interface HTMLCleanerConfiguration

Represents a configuration for the HTMLCleaner and allows to configure the cleaning parameters and cleaning filters to apply.

Since:

1.8.1

Version:

$Id$

Field Summary

static java.lang.String

NAMESPACES_AWARE Cleaning property identifier which decides if parsing should omit/keep namespace information.

Method Summary

java.util.List<HTMLFilter>	getFilters()
java.util.Map<java.lang.String,java.lang.String>	getParameters()
void	setFilters(java.util.List<HTMLFilter> filters)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> cleaningParameters)

Field Detail

NAMESPACES_AWARE

static final java.lang.String NAMESPACES_AWARE

Cleaning property identifier which decides if parsing should omit/keep namespace information.

See Also:

Constant Field Values

Method Detail

getFilters

java.util.List<HTMLFilter> getFilters()

Returns:

the ordered list of filters to use for cleaning the HTML content

setFilters

void setFilters(java.util.List<HTMLFilter> filters)

Parameters:

filters - the ordered list of filters to use for cleaning the HTML content

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns:

the list of cleaning parameters that will be used to clean the HTML content. Note that these parameters are implementation dependent and thus depend on the HTML cleaner implementation used.

setParameters

void setParameters(java.util.Map<java.lang.String,java.lang.String> cleaningParameters)

Parameters:

cleaningParameters - the list of cleaning parameters that will be used to clean the HTML content