net.bitform.api.options

Class AnalyzeOption.Reaction

java.lang.Object

net.bitform.api.options.AnalyzeOption.Reaction

Enclosing class:

AnalyzeOption

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

A typesafe enumeration class that encodes the possible results of an analysis. Reaction is used along with an AnalysisOption in the getResult method of SecureResponse.

Field Summary

Fields

Modifier and Type	Field and Description
static AnalyzeOption.Reaction	DOESNOTEXIST The analysis target does not exist in the document
static AnalyzeOption.Reaction	EXISTS The analysis target exists in the document
static AnalyzeOption.Reaction	NONE No action was taken

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get a description of this reaction.
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 AnalyzeOption.Reaction NONE

No action was taken

EXISTS

public static final AnalyzeOption.Reaction EXISTS

The analysis target exists in the document

DOESNOTEXIST

public static final AnalyzeOption.Reaction DOESNOTEXIST

The analysis target does not exist in the document

Method Detail

getDescription

public java.lang.String getDescription()

Get a description of this reaction.

Returns:

A short string describing this reaction suitable for use in UI or reporting.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object