org.jruby.util.cli

Class Option<T>

java.lang.Object

org.jruby.util.cli.Option<T>

Type Parameters:

T - the type of value associated with the option

Direct Known Subclasses:

BooleanOption, EnumerationOption, IntegerOption, StringOption

public abstract class Option<T>
extends Object

Represents a single option, with a category, name, value type, options, default value, and description. This type should be subclassed for specific types of values.

Property Summary

Properties

Type	Property and Description
String	load

Field Summary

Fields

Modifier and Type	Field and Description
Enum	category
T	defval
String	description
String	displayName
String	longName
String	name
Object[]	options
String	prefix
Class<T>	type
T	value

Constructor Summary

Constructors

Constructor and Description
Option(String longName, Class<T> type, Enum category, T[] options, T defval, String description) Create a new option with the given values.
Option(String prefix, String name, Class<T> type, Enum category, T[] options, T defval, String description) Create a new option with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
static Option<Boolean>	bool(String longName, Enum category, Boolean defval, String description)
static Option<Boolean>	bool(String longName, Enum category, String description)
static Option<Boolean>	bool(String prefix, String name, Enum category, Boolean defval, String description)
static Option<Boolean>	bool(String prefix, String name, Enum category, String description)
static <T extends Enum<T>> Option<T>	enumeration(String longName, Enum category, Class<T> enumClass, String description)
static <T extends Enum<T>> Option<T>	enumeration(String longName, Enum category, Class<T> enumClass, T defval, String description)
static <T extends Enum<T>> Option<T>	enumeration(String prefix, String name, Enum category, Class<T> enumClass, String description)
static <T extends Enum<T>> Option<T>	enumeration(String prefix, String name, Enum category, Class<T> enumClass, T defval, String description)
static String	formatOptions(Collection<Option> options)
static String	formatValues(Collection<Option> options)
static Option<Integer>	integer(String longName, Enum category, Integer[] options, Integer defval, String description)
static Option<Integer>	integer(String longName, Enum category, Integer defval, String description)
static Option<Integer>	integer(String longName, Enum category, String description)
static Option<Integer>	integer(String prefix, String name, Enum category, Integer[] options, Integer defval, String description)
static Option<Integer>	integer(String prefix, String name, Enum category, Integer defval, String description)
static Option<Integer>	integer(String prefix, String name, Enum category, String description)
boolean	isSpecified()
T	load()
String	loadProperty()
abstract T	reload()
static Option<String>	string(String longName, Enum category, String description)
static Option<String>	string(String longName, Enum category, String[] options, String description)
static Option<String>	string(String longName, Enum category, String[] options, String defval, String description)
static Option<String>	string(String longName, Enum category, String defval, String description)
static Option<String>	string(String prefix, String name, Enum category, String description)
static Option<String>	string(String prefix, String name, Enum category, String[] options, String description)
static Option<String>	string(String prefix, String name, Enum category, String[] options, String defval, String description)
static Option<String>	string(String prefix, String name, Enum category, String defval, String description)
String	toString()

Methods inherited from class java.lang.Object

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

Property Detail

load

Field Detail

category

public final Enum category

prefix

public final String prefix

name

public final String name

longName

public final String longName

displayName

public final String displayName

type

public final Class<T> type

options

public final Object[] options

defval

public final T defval

description

public final String description

value

public T value

Constructor Detail

Option

public Option(String prefix,
      String name,
      Class<T> type,
      Enum category,
      T[] options,
      T defval,
      String description)

Create a new option with the given values.

Type Parameters:

C - an enumeration type

Parameters:

prefix - the prefix used for loading this option from properties

name - the rest of the property name

type - the value type of the option

category - the category to which this option belongs

options - a list of supported for the option, or null if the set is not applicable

defval - the default value for the option

description - a description for the option

Option

public Option(String longName,
      Class<T> type,
      Enum category,
      T[] options,
      T defval,
      String description)

Create a new option with the given values.

Type Parameters:

C - an enumeration type

Parameters:

longName - the property name

type - the value type of the option

category - the category to which this option belongs

options - a list of supported for the option, or null if the set is not applicable

defval - the default value for the option

description - a description for the option

Method Detail

string

public static Option<String> string(String prefix,
                    String name,
                    Enum category,
                    String description)

string

public static Option<String> string(String longName,
                    Enum category,
                    String description)

string

public static Option<String> string(String prefix,
                    String name,
                    Enum category,
                    String defval,
                    String description)

string

public static Option<String> string(String longName,
                    Enum category,
                    String defval,
                    String description)

string

public static Option<String> string(String prefix,
                    String name,
                    Enum category,
                    String[] options,
                    String description)

string

public static Option<String> string(String longName,
                    Enum category,
                    String[] options,
                    String description)

string

public static Option<String> string(String prefix,
                    String name,
                    Enum category,
                    String[] options,
                    String defval,
                    String description)

string

public static Option<String> string(String longName,
                    Enum category,
                    String[] options,
                    String defval,
                    String description)

bool

public static Option<Boolean> bool(String prefix,
                   String name,
                   Enum category,
                   String description)

bool

public static Option<Boolean> bool(String longName,
                   Enum category,
                   String description)

bool

public static Option<Boolean> bool(String prefix,
                   String name,
                   Enum category,
                   Boolean defval,
                   String description)

bool

public static Option<Boolean> bool(String longName,
                   Enum category,
                   Boolean defval,
                   String description)

integer

public static Option<Integer> integer(String prefix,
                      String name,
                      Enum category,
                      String description)

integer

public static Option<Integer> integer(String longName,
                      Enum category,
                      String description)

integer

public static Option<Integer> integer(String prefix,
                      String name,
                      Enum category,
                      Integer defval,
                      String description)

integer

public static Option<Integer> integer(String longName,
                      Enum category,
                      Integer defval,
                      String description)

integer

public static Option<Integer> integer(String prefix,
                      String name,
                      Enum category,
                      Integer[] options,
                      Integer defval,
                      String description)

integer

public static Option<Integer> integer(String longName,
                      Enum category,
                      Integer[] options,
                      Integer defval,
                      String description)

enumeration

public static <T extends Enum<T>> Option<T> enumeration(String prefix,
                                        String name,
                                        Enum category,
                                        Class<T> enumClass,
                                        String description)

enumeration

public static <T extends Enum<T>> Option<T> enumeration(String longName,
                                        Enum category,
                                        Class<T> enumClass,
                                        String description)

enumeration

public static <T extends Enum<T>> Option<T> enumeration(String prefix,
                                        String name,
                                        Enum category,
                                        Class<T> enumClass,
                                        T defval,
                                        String description)

enumeration

public static <T extends Enum<T>> Option<T> enumeration(String longName,
                                        Enum category,
                                        Class<T> enumClass,
                                        T defval,
                                        String description)

formatValues

public static String formatValues(Collection<Option> options)

formatOptions

public static String formatOptions(Collection<Option> options)

toString

public String toString()

Overrides:

toString in class Object

loadProperty

public String loadProperty()

isSpecified

public boolean isSpecified()

load

public T load()

reload

public abstract T reload()