de.vandermeer.skb.categories.options

Class OptionList

java.lang.Object

de.vandermeer.skb.categories.options.OptionList

public class OptionList
extends Object

Constructor Summary

Constructors

Constructor and Description
OptionList() Creates a new OptionList with an empty list of options
OptionList(Collection<Option<?>> options) Creates a new OptionList initialised with all non-null options from the collection
OptionList(Option<?> option) Creates a new OptionList with given input option (if not null)
OptionList(Option<?>[] options) Creates a new OptionList initialised with all non-null options from the array

Method Summary

Modifier and Type	Method and Description
OptionList	addOption(Collection<Option<?>> options) Adds options from a collection to the list (all non-null options)
OptionList	addOption(Option<?> option) Adds an option to the list
OptionList	addOption(Option<?>[] options) Adds options from an array to the list (all non-null options)
Option<?>	getOption(String option) Returns the option that uses the given string as option, null otherwise
Boolean	getOptValue(String option, Boolean def) Returns the boolean value of the requested option or the default value
char[]	getOptValue(String option, char[] def) Returns the character array value of the requested option or the default value
Character	getOptValue(String option, Character def) Returns the character value of the requested option or the default value
Double	getOptValue(String option, Double def) Returns the double value of the requested option or the default value
Integer	getOptValue(String option, Integer def) Returns the integer value of the requested option or the default value
String	getOptValue(String option, String def) Returns the string value of the requested option or the default value
boolean	hasOption(Option<?> option) Returns true if the list contains the option
boolean	hasOption(String option) Returns true if the list contains an option whos getOption returns the given string
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionList

public OptionList()

Creates a new OptionList with an empty list of options

OptionList

public OptionList(Option<?> option)

Creates a new OptionList with given input option (if not null)

Parameters:

option - initial option

OptionList

public OptionList(Collection<Option<?>> options)

Creates a new OptionList initialised with all non-null options from the collection

Parameters:

options - collection of options

OptionList

public OptionList(Option<?>[] options)

Creates a new OptionList initialised with all non-null options from the array

Parameters:

options - array of options

Method Detail

addOption

public OptionList addOption(Option<?> option)

Adds an option to the list

Parameters:

option - option to be added

Returns:

self

addOption

public OptionList addOption(Option<?>[] options)

Adds options from an array to the list (all non-null options)

Parameters:

options - array of options to be added

Returns:

self

addOption

public OptionList addOption(Collection<Option<?>> options)

Adds options from a collection to the list (all non-null options)

Parameters:

options - collection of options to be added

Returns:

self

hasOption

public boolean hasOption(Option<?> option)

Returns true if the list contains the option

Parameters:

option - option to test for

Returns:

true if the list contains the option, false otherwise

hasOption

public boolean hasOption(String option)

Returns true if the list contains an option whos getOption returns the given string

Parameters:

option - string to test

Returns:

true if the list contains an option that return the given string, false otherwise

getOption

public Option<?> getOption(String option)

Returns the option that uses the given string as option, null otherwise

Parameters:

option - option to test for

Returns:

the option that uses the given string as option, null otherwise

getOptValue

public Character getOptValue(String option,
                             Character def)

Returns the character value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

character value of the option if found, default value otherwise

getOptValue

public char[] getOptValue(String option,
                          char[] def)

Returns the character array value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

character array value of the option if found, default value otherwise

getOptValue

public String getOptValue(String option,
                          String def)

Returns the string value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

string value of the option if found, default value otherwise

getOptValue

public Boolean getOptValue(String option,
                           Boolean def)

Returns the boolean value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

boolean value of the option if found, default value otherwise

getOptValue

public Integer getOptValue(String option,
                           Integer def)

Returns the integer value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

integer value of the option if found, default value otherwise

getOptValue

public Double getOptValue(String option,
                          Double def)

Returns the double value of the requested option or the default value

Parameters:

option - option to search for

def - default value to return

Returns:

double value of the option if found, default value otherwise

toString

public String toString()

Overrides:

toString in class Object