de.lmu.ifi.dbs.elki.utilities.optionhandling

Class OptionID

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID

public final class OptionID
extends Object

An OptionID is used by option handlers as a unique identifier for specific options. There is no option possible without a specific OptionID defined within this class.

Field Summary

Fields

Modifier and Type	Field and Description
private String	description The description of the OptionID.
private String	name Option name

Constructor Summary

Constructors

Constructor and Description
OptionID(String name, String description) Provides a new OptionID of the given name and description.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description of this OptionID.
String	getName() Get the option name.
static OptionID	getOrCreateOptionID(String name, String description) Gets or creates the OptionID for the given class and given name.
String	toString() Returns the name of this OptionID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

private String name

Option name

description

private String description

The description of the OptionID.

Constructor Detail

OptionID

public OptionID(String name,
        String description)

Provides a new OptionID of the given name and description.

All OptionIDs are unique w.r.t. their name. An OptionID provides additionally a description of the option.

Parameters:

name - the name of the option

description - the description of the option

Method Detail

getDescription

public String getDescription()

Returns the description of this OptionID.

Returns:

the description of this OptionID

getOrCreateOptionID

public static OptionID getOrCreateOptionID(String name,
                           String description)

Gets or creates the OptionID for the given class and given name. The OptionID usually is named as the classes name (lowercase) as name-prefix and the given name as suffix of the complete name, separated by a dot. For example, the parameter epsilon for the class DBSCAN will be named dbscan.epsilon.

Parameters:

name - the name

description - the description is also set if the named OptionID does exist already

Returns:

the OptionID for the given name

toString

public String toString()

Returns the name of this OptionID.

Overrides:

toString in class Object

Returns:

the name

See Also:

Object.toString()

getName

public String getName()

Get the option name.

Returns:

Option name