net.bitform.api.options

Class AnalyzeOption.Action

java.lang.Object

net.bitform.api.options.AnalyzeOption.Action

Enclosing class:

AnalyzeOption

public static class AnalyzeOption.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 an AnalysisOption in the setOption method of SecureRequest.

Field Summary

Fields

Modifier and Type	Field and Description
static AnalyzeOption.Action	ANALYZE Report on the target's existence in the document.
static AnalyzeOption.Action	NONE Do not perform any action.

Method Summary

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

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

ANALYZE

public static final AnalyzeOption.Action ANALYZE

Report on the target's existence in the document. SecureResponse will include information as to the existence of the target.

Method Detail

getDescription

public java.lang.String getDescription()

Get a description of this action.

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object