io.shick.jsoup

Interface MutableWhitelistConfiguration

All Superinterfaces:

WhitelistConfiguration

All Known Implementing Classes:

BasicWhitelistConfiguration

public interface MutableWhitelistConfiguration
extends WhitelistConfiguration

MutableWhitelistConfiguration interface.

Author:

Trever Shick - trever@shick.io

Method Summary

Modifier and Type	Method and Description
MutableWhitelistConfiguration	allowAttribute(String tagName, String attrName) Add an allowed attribute to the configuration
MutableWhitelistConfiguration	allowProtocol(String tagName, String attrName, String protocol) Add an allowed protocol to the configuration
MutableWhitelistConfiguration	allowTag(String tagName) Add an allowed tag to the configuration
MutableWhitelistConfiguration	base(String name) Sets the base whitelist to use when configuring a Whitelist, 'none' is the default value.
MutableWhitelistConfiguration	enforceAttribute(String tagName, String attrName, String enforcedValue) Add an enforced attribute value to the configuration

Methods inherited from interface io.shick.jsoup.WhitelistConfiguration

allowedAttributes, allowedProtocols, allowedTags, allowsAttribute, allowsProtocol, allowsTag, apply, base, enforcedAttributes, enforcesAttribute, enforcesAttribute, hasAllowedAttributes, hasAllowedProtocols, hasAllowedProtocols, hasEnforcedAttributes, whitelist

Method Detail

base

MutableWhitelistConfiguration base(String name)

Sets the base whitelist to use when configuring a Whitelist, 'none' is the default value.

Parameters:

name - an instance of whitelist to use as the base whitelist

Returns:

a MutableWhitelistConfiguration object.

allowTag

MutableWhitelistConfiguration allowTag(String tagName)

Add an allowed tag to the configuration

Parameters:

tagName - (non null) an HTML tag name

Returns:

a MutableWhitelistConfiguration object.

enforceAttribute

MutableWhitelistConfiguration enforceAttribute(String tagName,
                                               String attrName,
                                               String enforcedValue)

Add an enforced attribute value to the configuration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

enforcedValue - (non null) the string value for the specified attribute.

Returns:

a MutableWhitelistConfiguration object.

allowProtocol

MutableWhitelistConfiguration allowProtocol(String tagName,
                                            String attrName,
                                            String protocol)

Add an allowed protocol to the configuration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

protocol - (non null) a protocol like 'https' or 'http'

Returns:

a MutableWhitelistConfiguration object.

allowAttribute

MutableWhitelistConfiguration allowAttribute(String tagName,
                                             String attrName)

Add an allowed attribute to the configuration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

Returns:

a MutableWhitelistConfiguration object.