net.bitform.api.options

Class BasicOption

java.lang.Object

net.bitform.api.options.BasicOption

All Implemented Interfaces:

Option

Direct Known Subclasses:

BooleanOption, DateOption, DirectoryOption, DurationOption, EnumListOption, EnumOption, FileFormatListOption, FileFormatOption, FileListOption, FileOption, FloatOption, HandlerOption, IntegerOption, ObjectListOption, ObjectOption, StringListOption, StringOption, TargetOption

public abstract class BasicOption
extends java.lang.Object
implements Option

Default implementation of the Option interface. All other option types extend from this type. Developers should not need to use this class in the normal course of using this API.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the string id for this option.
java.lang.String	getLongDescription() Gets a multi-line description for this option
java.lang.String	getName() Gets a short name for this option, suitable for UI elements like list boxes
java.lang.String	getShortDescription() Gets a one line description for this option
int	getUid() Gets the unique integer id for this option.
boolean	isRequest() Is the option usable in a request
boolean	isResponse() Is the option usable in a response
java.lang.String	toString() Returns a string representation of the option.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Option

Gets a short name for this option, suitable for UI elements like list boxes

Specified by:

getName in interface Option

Returns:

A short name

getShortDescription

public java.lang.String getShortDescription()

Description copied from interface: Option

Gets a one line description for this option

Specified by:

getShortDescription in interface Option

Returns:

Description

getLongDescription

public java.lang.String getLongDescription()

Description copied from interface: Option

Gets a multi-line description for this option

Specified by:

getLongDescription in interface Option

Returns:

Description

getId

public java.lang.String getId()

Description copied from interface: Option

Gets the string id for this option. This id is invariant for lifetime of the API and may be used for persisting the option.

Specified by:

getId in interface Option

Returns:

The id

getUid

public int getUid()

Description copied from interface: Option

Gets the unique integer id for this option. This id is invariant for lifetime of the API and may be used for persisting the option.

Specified by:

getUid in interface Option

Returns:

The id

isRequest

public boolean isRequest()

Description copied from interface: Option

Is the option usable in a request

Specified by:

isRequest in interface Option

Returns:

true if this option is an input option and may be set on a request object.

isResponse

public boolean isResponse()

Description copied from interface: Option

Is the option usable in a response

Specified by:

isResponse in interface Option

Returns:

true if this option is an output option and may be retrieved from a response object.

toString

public java.lang.String toString()

Returns a string representation of the option.

Overrides:

toString in class java.lang.Object

Returns:

Returns same string as the getName method.