net.bitform.api.options

Class EnumOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.EnumOption

All Implemented Interfaces:

Option

Direct Known Subclasses:

SecureOptions.ColorObfuscatedTextRemediationOption, SecureOptions.DecryptionStatusOption, SecureOptions.Fields.Action, SecureOptions.OutputTypeOption, SecureOptions.ProcessingStatusOption, SecureOptions.Properties.Action, SecureOptions.ToTextEncodingOption

public abstract class EnumOption
extends BasicOption

An option that represents an integer value.

Constructor Summary

Constructors

Constructor and Description
EnumOption(java.lang.String id, int uid, java.lang.String name, java.lang.String shortDescription, java.lang.String longDescription, boolean isRequest, boolean isResponse, EnumOptionValue defaultValue, boolean dontpersist)

Method Summary

Modifier and Type	Method and Description
EnumOptionValue	getDefault() Gets the default value for this option.
abstract EnumOptionValue	mapId(int id) Map a integer id to a value
abstract EnumOptionValue	mapId(java.lang.String id) Map a string id to a value

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

Constructor Detail

EnumOption

public EnumOption(java.lang.String id,
                  int uid,
                  java.lang.String name,
                  java.lang.String shortDescription,
                  java.lang.String longDescription,
                  boolean isRequest,
                  boolean isResponse,
                  EnumOptionValue defaultValue,
                  boolean dontpersist)

Method Detail

getDefault

public EnumOptionValue getDefault()

Gets the default value for this option.

Returns:

Default value

mapId

public abstract EnumOptionValue mapId(int id)

Map a integer id to a value

Parameters:

id - The integer id of a value for this enum

Returns:

The value or null if the id cannot be mapped

mapId

public abstract EnumOptionValue mapId(java.lang.String id)

Map a string id to a value

Parameters:

id - The sting id of a value for this enum

Returns:

The value or null if the id cannot be mapped