net.bitform.api.secure

Class SecureOptions.Fields.Action

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.EnumOption

net.bitform.api.secure.SecureOptions.Fields.Action

All Implemented Interfaces:

Option

Enclosing class:

SecureOptions.Fields

public static class SecureOptions.Fields.Action
extends EnumOption

Action

Field Summary

Fields

Modifier and Type	Field and Description
static EnumOptionValue	Default
static EnumOptionValue	None
static EnumOptionValue	Replace
static EnumOptionValue	Scrub
static EnumOptionValue	ScrubAndReplace

Method Summary

Modifier and Type	Method and Description
static EnumOptionValue[]	getAll() Get all predefinied Types
EnumOptionValue	getDefault() Gets the default value for this option.
EnumOptionValue	mapId(int id) Map a integer id to a value
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

Field Detail

Default

public static final EnumOptionValue Default

None

public static final EnumOptionValue None

Scrub

public static final EnumOptionValue Scrub

Replace

public static final EnumOptionValue Replace

ScrubAndReplace

public static final EnumOptionValue ScrubAndReplace

Method Detail

getDefault

public EnumOptionValue getDefault()

Description copied from class: EnumOption

Gets the default value for this option.

Overrides:

getDefault in class EnumOption

Returns:

Default value

getAll

public static EnumOptionValue[] getAll()

Get all predefinied Types

Returns:

array containing all possible Types

mapId

public EnumOptionValue mapId(int id)

Description copied from class: EnumOption

Map a integer id to a value

Specified by:

mapId in class EnumOption

Parameters:

id - The integer id of a value for this enum

Returns:

The value or null if the id cannot be mapped

mapId

public EnumOptionValue mapId(java.lang.String id)

Description copied from class: EnumOption

Map a string id to a value

Specified by:

mapId in class EnumOption

Parameters:

id - The sting id of a value for this enum

Returns:

The value or null if the id cannot be mapped