net.bitform.api.options

Class ScrubOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.TargetOption

net.bitform.api.options.ScrubOption

All Implemented Interfaces:

Option

public class ScrubOption
extends TargetOption

Represents a part of the document that can be analyzed or scrubbed by this API. Instances of this class are also called 'scrub targets' throughout this documentation.

The constructor is not visible because all valid options are already available through SecureOptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScrubOption.Action A typesafe enumeration class that encodes the various actions that can be performed on a given part of a document.
static class	ScrubOption.Reaction A typesafe enumeration class that encodes the possible results of a scrub.

Nested classes/interfaces inherited from class net.bitform.api.options.TargetOption

TargetOption.FormatInformation

Method Summary

Modifier and Type	Method and Description
ScrubOption.Action	getDefault() Gets the default action to be executed for this scrub target

Methods inherited from class net.bitform.api.options.TargetOption

appliesTo, getParent

Methods inherited from class net.bitform.api.options.BasicOption

getId, getLongDescription, getName, getShortDescription, getUid, isRequest, isResponse, toString

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public ScrubOption.Action getDefault()

Gets the default action to be executed for this scrub target

Returns:

Default action