nz.ac.waikato.cms.jenericcmdline.core

Class OptionUtils

java.lang.Object

nz.ac.waikato.cms.jenericcmdline.core.OptionUtils

public class OptionUtils
extends Object

Helper class for option-related operations.

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 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 String	displayNameToFlag(String name) Turns a camel case display name of a property into a commandline flag that uses lowercase and hyphens.
static String	joinOptions(String[] optionArray) Joins all the options in an option array into a single string, as might be used on the command line.
static String[]	splitOptions(String quotedOptionString) Split up a string containing options into an array of strings, one for each option.
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

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)

splitOptions

public static String[] splitOptions(String quotedOptionString)
                             throws Exception

Split up a string containing options into an array of strings, one for each option.

Parameters:

quotedOptionString - the string containing the options

Returns:

the array of options

Throws:

Exception - in case of an unterminated string, unknown character or a parse error

joinOptions

public static String joinOptions(String[] optionArray)

Joins all the options in an option array into a single string, as might be used on the command line.

Parameters:

optionArray - the array of options

Returns:

the string containing all options.

displayNameToFlag

public static String displayNameToFlag(String name)

Turns a camel case display name of a property into a commandline flag that uses lowercase and hyphens.

Parameters:

name - the display name of the property

Returns:

the flag