net.bitform.api.options

Class ScrubOption.Reaction

java.lang.Object

net.bitform.api.options.ScrubOption.Reaction

Enclosing class:

ScrubOption

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

A typesafe enumeration class that encodes the possible results of a scrub. ScrubReaction is used along with a ScrubOption in the getResult method of SecureResponse.

Field Summary

Fields

Modifier and Type	Field and Description
static ScrubOption.Reaction	DOESNOTEXIST The scrub target does not exist in the document
static ScrubOption.Reaction	EXISTS The scrub target exists in the document
static ScrubOption.Reaction	NONE No action was taken
static ScrubOption.Reaction	PARTIALLYSCRUBBED The scrub target was partially removed from the document.
static ScrubOption.Reaction	SCRUBBED The scrub target was removed from the document.

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

NONE

public static final ScrubOption.Reaction NONE

No action was taken

EXISTS

public static final ScrubOption.Reaction EXISTS

The scrub target exists in the document

DOESNOTEXIST

public static final ScrubOption.Reaction DOESNOTEXIST

The scrub target does not exist in the document

SCRUBBED

public static final ScrubOption.Reaction SCRUBBED

The scrub target was removed from the document.

PARTIALLYSCRUBBED

public static final ScrubOption.Reaction PARTIALLYSCRUBBED

The scrub target was partially removed from the document.

Method Detail

getDescription

public java.lang.String getDescription()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object