net.bitform.api.secure

Class SecureOptions.Fields.StringField

java.lang.Object

net.bitform.api.options.OptionContainer

net.bitform.api.secure.SecureOptions.Fields.Field

net.bitform.api.secure.SecureOptions.Fields.StringField

Enclosing class:

SecureOptions.Fields

public static class SecureOptions.Fields.StringField
extends SecureOptions.Fields.Field

Field Summary

Fields

Modifier and Type	Field and Description
StringOption	newValue

Fields inherited from class net.bitform.api.secure.SecureOptions.Fields.Field

action, STRING, type

Method Summary

Modifier and Type	Method and Description
OptionContainer[]	getAllContainers() Get all the option containers in this container
Option[]	getAllOptions() Gets all the options in this container
Option	mapOptionId(int id) Maps an integer id of an option in this list to the option itself.
Option	mapOptionId(java.lang.String id) Maps an string id of an option in this list to the option itself.

Methods inherited from class net.bitform.api.secure.SecureOptions.Fields.Field

getDescription, getExtraId, getName, getUid, toString

Methods inherited from class net.bitform.api.options.OptionContainer

getId, writeXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

newValue

public final StringOption newValue

Method Detail

getAllOptions

public Option[] getAllOptions()

Description copied from class: OptionContainer

Gets all the options in this container

Specified by:

getAllOptions in class OptionContainer

Returns:

an array containing all the requested options

mapOptionId

public Option mapOptionId(java.lang.String id)

Description copied from class: OptionContainer

Maps an string id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found

mapOptionId

public Option mapOptionId(int id)

Description copied from class: OptionContainer

Maps an integer id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found

getAllContainers

public OptionContainer[] getAllContainers()

Description copied from class: OptionContainer

Get all the option containers in this container

Specified by:

getAllContainers in class OptionContainer

Returns:

an array containing all the containers