net.bitform.api.secure

Class SecureOptions.ToTextEncodingOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.EnumOption

net.bitform.api.secure.SecureOptions.ToTextEncodingOption

All Implemented Interfaces:

Option

Enclosing class:

SecureOptions

public static class SecureOptions.ToTextEncodingOption
extends EnumOption

Field Summary

Fields

Modifier and Type	Field and Description
static EnumOptionValue	UTF16 Output text in UTF-16
static EnumOptionValue	UTF8 Output text in UTF-8

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

UTF16

public static final EnumOptionValue UTF16

Output text in UTF-16

UTF8

public static final EnumOptionValue UTF8

Output text in UTF-8

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