net.bitform.api.options

Class AnalyzeOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.TargetOption

net.bitform.api.options.AnalyzeOption

All Implemented Interfaces:

Option

public class AnalyzeOption
extends TargetOption

Represents a part of a document that can be analyzed by this API. Instances of this class are also called 'analysis 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	AnalyzeOption.Action A typesafe enumeration class that encodes the various actions that can be performed on a given part of a document.
static class	AnalyzeOption.Reaction A typesafe enumeration class that encodes the possible results of an analysis.

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

TargetOption.FormatInformation

Method Summary

Modifier and Type	Method and Description
AnalyzeOption.Action	getDefault() Gets the default action to be executed for this analysis 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 AnalyzeOption.Action getDefault()

Gets the default action to be executed for this analysis target

Returns:

The action that will be executed on this analysis target when its value has not been excplicitly set.