net.bitform.api.options

Class OptionContainer

java.lang.Object

net.bitform.api.options.OptionContainer

Direct Known Subclasses:

SecureOptions, SecureOptions.Fields, SecureOptions.Fields.Field, SecureOptions.Properties, SecureOptions.Properties.Property, SharedOptions

public abstract class OptionContainer
extends java.lang.Object

Abstract base class for a list of options.

Method Summary

Modifier and Type	Method and Description
abstract OptionContainer[]	getAllContainers() Get all the option containers in this container
abstract Option[]	getAllOptions() Gets all the options in this container
java.lang.String	getId()
abstract Option	mapOptionId(int id) Maps an integer id of an option in this list to the option itself.
abstract Option	mapOptionId(java.lang.String id) Maps an string id of an option in this list to the option itself.
void	writeXML(org.xml.sax.ContentHandler ch, OptionSet os)

Methods inherited from class java.lang.Object

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

Method Detail

getId

public java.lang.String getId()

getAllOptions

public abstract Option[] getAllOptions()

Gets all the options in this container

Returns:

an array containing all the requested options

mapOptionId

public abstract Option mapOptionId(java.lang.String id)

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.

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 abstract Option mapOptionId(int id)

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.

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 abstract OptionContainer[] getAllContainers()

Get all the option containers in this container

Returns:

an array containing all the containers

writeXML

public void writeXML(org.xml.sax.ContentHandler ch,
                     OptionSet os)
              throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException