Package org.basex.util.options

Class Option<O>

java.lang.Object

org.basex.util.options.Option<O>

Type Parameters:

O - option type

Direct Known Subclasses:

BooleanOption, Comment, EnumOption, FuncOption, NumberOption, NumbersOption, OptionsOption, StringOption, StringsOption

public abstract class Option<O>
extends Object

Single option, stored in Options instances.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Method Summary

Modifier and Type	Method	Description
final String	arg(String arg)	Returns a string representation of the option with the specified argument.
O	copy()	Copies mutable default values.
final String	name()	Returns the name of the option.
String	toString()
abstract O	value()	Returns the default value.

Methods inherited from class java.lang.Object

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

Method Details

name

public final String name()

Returns the name of the option.

Returns:

name

value

public abstract O value()

Returns the default value.

Returns:

default value

copy

public O copy()

Copies mutable default values. Otherwise, returns the existing instance.

Returns:

default value

toString

public String toString()

Overrides:

toString in class Object

arg

public final String arg(String arg)

Returns a string representation of the option with the specified argument.

Parameters:

arg - argument

Returns:

string representation