meka.core

Class OptionUtils

java.lang.Object

meka.core.OptionUtils

public class OptionUtils
extends Object

Helper class for option parsing.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Constructor Summary

Constructors

Constructor and Description
OptionUtils()

Method Summary

Modifier and Type	Method and Description
static void	add(List<String> options, char option, boolean value) Adds the boolean flag (if true) to the options.
static void	add(List<String> options, char option, double value) Adds the double value to the options.
static void	add(List<String> options, char option, File value) Adds the File value to the options.
static void	add(List<String> options, char option, float value) Adds the float value to the options.
static void	add(List<String> options, char option, int value) Adds the int value to the options.
static void	add(List<String> options, char option, long value) Adds the long value to the options.
static void	add(List<String> options, char option, Object value) Adds the array to the options.
static void	add(List<String> options, char option, weka.core.OptionHandler value) Adds the OptionHandler to the options.
static void	add(List<String> options, char option, String value) Adds the String value to the options.
static void	add(List<String> options, String[] superOptions) Adds the "super" options to the current list.
static void	add(List<String> options, String option, boolean value) Adds the boolean flag (if true) to the options.
static void	add(List<String> options, String option, double value) Adds the double value to the options.
static void	add(List<String> options, String option, File value) Adds the File value to the options.
static void	add(List<String> options, String option, float value) Adds the float value to the options.
static void	add(List<String> options, String option, int value) Adds the int value to the options.
static void	add(List<String> options, String option, long value) Adds the long value to the options.
static void	add(List<String> options, String option, Object value) Adds the array to the options.
static void	add(List<String> options, String option, weka.core.OptionHandler value) Adds the OptionHandler to the options.
static void	add(List<String> options, String option, String value) Adds the String value to the options.
static void	add(Vector current, Enumeration superOptions) Adds the option description of the super class.
static void	addFlag(Vector options, String text, char flag) Adds an Option for a flag to the list of options.
static void	addFlag(Vector options, String text, String flag) Adds an Option for a flag to the list of options.
static void	addOption(Vector options, String text, String defValue, char option) Adds an Option for a flag to the list of options.
static void	addOption(Vector options, String text, String defValue, String option) Adds an Option for a flag to the list of options.
static String	backQuoteChars(String string) Converts carriage returns and new lines in a string into \r and \n.
static String	backQuoteChars(String string, char[] find, String[] replace) Converts specified characters into the string equivalents.
static <T> T	fromCommandLine(Class<T> cls, String cmdline) Turns a commandline into an object.
static String[]	parse(String[] options, char option) Parses an array option, returns all the occurrences of the option as a string array.
static boolean	parse(String[] options, char option, boolean defValue) Parses a double option, uses default if option is missing.
static <T> T[]	parse(String[] options, char option, Class<T> cls) Parses an array option, returns all the occurrences of the option as a string array.
static double	parse(String[] options, char option, double defValue) Parses a double option, uses default if option is missing.
static File	parse(String[] options, char option, File defValue) Parses a File option, uses default if option is missing.
static float	parse(String[] options, char option, float defValue) Parses a float option, uses default if option is missing.
static int	parse(String[] options, char option, int defValue) Parses an int option, uses default if option is missing.
static long	parse(String[] options, char option, long defValue) Parses an long option, uses default if option is missing.
static weka.core.OptionHandler	parse(String[] options, char option, weka.core.OptionHandler defValue) Parses an OptionHandler option, uses default if option is missing.
static String	parse(String[] options, char option, String defValue) Parses a String option, uses default if option is missing.
static String[]	parse(String[] options, String option) Parses an array option, returns all the occurrences of the option as a string array.
static boolean	parse(String[] options, String option, boolean defValue) Parses a double option, uses default if option is missing.
static <T> T[]	parse(String[] options, String option, Class<T> cls) Parses an array option, returns all the occurrences of the option as a string array.
static double	parse(String[] options, String option, double defValue) Parses a double option, uses default if option is missing.
static File	parse(String[] options, String option, File defValue) Parses a File option, uses default if option is missing.
static float	parse(String[] options, String option, float defValue) Parses a float option, uses default if option is missing.
static int	parse(String[] options, String option, int defValue) Parses an int option, uses default if option is missing.
static long	parse(String[] options, String option, long defValue) Parses a long option, uses default if option is missing.
static weka.core.OptionHandler	parse(String[] options, String option, weka.core.OptionHandler defValue) Parses an OptionHandler option, uses default if option is missing.
static String	parse(String[] options, String option, String defValue) Parses a String option, uses default if option is missing.
static weka.core.OptionHandler	shallowCopy(weka.core.OptionHandler obj) Creates a shallow copy of the option handler, just using its options.
static String[]	toArray(List<String> options) Turns the list of options into an array.
static String	toCommandLine(Object obj) Returns the commandline string for the object.
static Enumeration	toEnumeration(Vector options) Returns the option descriptions as an enumeration.
static String	unbackQuoteChars(String string) The inverse operation of backQuoteChars().
static String	unbackQuoteChars(String string, String[] find, char[] replace) The inverse operation of backQuoteChars().

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionUtils

public OptionUtils()

Method Detail

parse

public static int parse(String[] options,
                        char option,
                        int defValue)
                 throws Exception

Parses an int option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static int parse(String[] options,
                        String option,
                        int defValue)
                 throws Exception

Parses an int option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static long parse(String[] options,
                         char option,
                         long defValue)
                  throws Exception

Parses an long option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static long parse(String[] options,
                         String option,
                         long defValue)
                  throws Exception

Parses a long option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static float parse(String[] options,
                          char option,
                          float defValue)
                   throws Exception

Parses a float option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static float parse(String[] options,
                          String option,
                          float defValue)
                   throws Exception

Parses a float option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static double parse(String[] options,
                           char option,
                           double defValue)
                    throws Exception

Parses a double option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static double parse(String[] options,
                           String option,
                           double defValue)
                    throws Exception

Parses a double option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static String parse(String[] options,
                           char option,
                           String defValue)
                    throws Exception

Parses a String option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static String parse(String[] options,
                           String option,
                           String defValue)
                    throws Exception

Parses a String option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static File parse(String[] options,
                         char option,
                         File defValue)
                  throws Exception

Parses a File option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static File parse(String[] options,
                         String option,
                         File defValue)
                  throws Exception

Parses a File option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static weka.core.OptionHandler parse(String[] options,
                                            char option,
                                            weka.core.OptionHandler defValue)
                                     throws Exception

Parses an OptionHandler option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static weka.core.OptionHandler parse(String[] options,
                                            String option,
                                            weka.core.OptionHandler defValue)
                                     throws Exception

Parses an OptionHandler option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static String[] parse(String[] options,
                             char option)
                      throws Exception

Parses an array option, returns all the occurrences of the option as a string array.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static String[] parse(String[] options,
                             String option)
                      throws Exception

Parses an array option, returns all the occurrences of the option as a string array.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static <T> T[] parse(String[] options,
                            char option,
                            Class<T> cls)
                     throws Exception

Parses an array option, returns all the occurrences of the option as a string array.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

cls - the class type to use (requires a constructor that takes a string)

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static boolean parse(String[] options,
                            char option,
                            boolean defValue)
                     throws Exception

Parses a double option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static boolean parse(String[] options,
                            String option,
                            boolean defValue)
                     throws Exception

Parses a double option, uses default if option is missing.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

defValue - the default value

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

parse

public static <T> T[] parse(String[] options,
                            String option,
                            Class<T> cls)
                     throws Exception

Parses an array option, returns all the occurrences of the option as a string array.

Parameters:

options - the option array to use

option - the option to look for in the options array (no leading dash)

cls - the class type to use (requires a constructor that takes a string)

Returns:

the parsed value (or default value if option not present)

Throws:

Exception - if parsing of value fails

add

public static void add(List<String> options,
                       char option,
                       int value)

Adds the int value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       int value)

Adds the int value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       long value)

Adds the long value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       long value)

Adds the long value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       float value)

Adds the float value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       float value)

Adds the float value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       double value)

Adds the double value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       double value)

Adds the double value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       String value)

Adds the String value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       String value)

Adds the String value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       boolean value)

Adds the boolean flag (if true) to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       boolean value)

Adds the boolean flag (if true) to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       File value)

Adds the File value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       File value)

Adds the File value to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       weka.core.OptionHandler value)

Adds the OptionHandler to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       weka.core.OptionHandler value)

Adds the OptionHandler to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       char option,
                       Object value)

Adds the array to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String option,
                       Object value)

Adds the array to the options.

Parameters:

options - the current list of options to extend

option - the option (without the leading dash)

value - the current value

add

public static void add(List<String> options,
                       String[] superOptions)

Adds the "super" options to the current list.

Parameters:

options - the current options

superOptions - the "super" options to add

addFlag

public static void addFlag(Vector options,
                           String text,
                           char flag)

Adds an Option for a flag to the list of options.

Parameters:

options - the options to extend

text - the description

flag - the flag (no dash)

addFlag

public static void addFlag(Vector options,
                           String text,
                           String flag)

Adds an Option for a flag to the list of options.

Parameters:

options - the options to extend

text - the description

flag - the flag (no dash)

addOption

public static void addOption(Vector options,
                             String text,
                             String defValue,
                             char option)

Adds an Option for a flag to the list of options.

Parameters:

options - the options to extend

text - the description

option - the option (no dash)

addOption

public static void addOption(Vector options,
                             String text,
                             String defValue,
                             String option)

Adds an Option for a flag to the list of options.

Parameters:

options - the options to extend

text - the description

option - the option (no dash)

add

public static void add(Vector current,
                       Enumeration superOptions)

Adds the option description of the super class.

Parameters:

current - the current option descriptions to extend

superOptions - the "super" descriptions

toArray

public static String[] toArray(List<String> options)

Turns the list of options into an array.

Parameters:

options - the list of options to convert

Returns:

the generated array

toEnumeration

public static Enumeration toEnumeration(Vector options)

Returns the option descriptions as an enumeration.

Parameters:

options - the descriptions

Returns:

the enumeration

fromCommandLine

public static <T> T fromCommandLine(Class<T> cls,
                                    String cmdline)
                             throws Exception

Turns a commandline into an object.

Parameters:

cls - the class that the commandline is expected to be

cmdline - the commandline to parse

Returns:

the object, null if failed to instantiate

Throws:

Exception - if parsing fails

toCommandLine

public static String toCommandLine(Object obj)

Returns the commandline string for the object.

Parameters:

obj - the object to generate the commandline for

Returns:

the commandline

See Also:

Utils.toCommandLine(Object)

backQuoteChars

public static String backQuoteChars(String string,
                                    char[] find,
                                    String[] replace)

Converts specified characters into the string equivalents.

Parameters:

string - the string

find - the characters to replace

replace - the replacement strings for the characters

Returns:

the converted string

See Also:

unbackQuoteChars(String, String[], char[])

backQuoteChars

public static String backQuoteChars(String string)

Converts carriage returns and new lines in a string into \r and \n. Backquotes the following characters: ` " \ \t and %

Parameters:

string - the string

Returns:

the converted string

See Also:

unbackQuoteChars(String)

unbackQuoteChars

public static String unbackQuoteChars(String string,
                                      String[] find,
                                      char[] replace)

The inverse operation of backQuoteChars(). Converts the specified strings into their character representations.

Parameters:

string - the string

find - the string to find

replace - the character equivalents of the strings

Returns:

the converted string

See Also:

backQuoteChars(String, char[], String[])

unbackQuoteChars

public static String unbackQuoteChars(String string)

The inverse operation of backQuoteChars(). Converts back-quoted carriage returns and new lines in a string to the corresponding character ('\r' and '\n'). Also "un"-back-quotes the following characters: ` " \ \t and %

Parameters:

string - the string

Returns:

the converted string

See Also:

backQuoteChars(String)

shallowCopy

public static weka.core.OptionHandler shallowCopy(weka.core.OptionHandler obj)

Creates a shallow copy of the option handler, just using its options.

Parameters:

obj - the object to copy

Returns:

the copy, null if failed to copy