net.bitform.api.options

Class ScrubOption.Action

java.lang.Object

net.bitform.api.options.ScrubOption.Action

Enclosing class:

ScrubOption

public static class ScrubOption.Action
extends java.lang.Object

A typesafe enumeration class that encodes the various actions that can be performed on a given part of a document. Action is used along with a TargetOption in the setOption method of SecureRequest.

Field Summary

Fields

Modifier and Type	Field and Description
static ScrubOption.Action	ANALYZE Report on the scrub target's existence in the document but do not scrub it.
static ScrubOption.Action	DEFAULT Perform the default action as defined by SecureOptions.DefaultScrubBehavior.
static ScrubOption.Action	NONE Do not perform any action.
static ScrubOption.Action	SCRUB Remove the target from the document if it exists.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ScrubOption.Action DEFAULT

Perform the default action as defined by SecureOptions.DefaultScrubBehavior.

NONE

public static final ScrubOption.Action NONE

Do not perform any action. In a few cases it may improve performance to perform no action instead of ANALYZE or SCRUB. See the individual descriptions in SecureOptions for any performance saving by using NONE.

ANALYZE

public static final ScrubOption.Action ANALYZE

Report on the scrub target's existence in the document but do not scrub it. ScrubResponse will include information as to the existance of the target.

SCRUB

public static final ScrubOption.Action SCRUB

Remove the target from the document if it exists. ScrubResponse will include information about this data and its removal.

Method Detail

getDescription

public java.lang.String getDescription()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object