net.sf.gogui.util

Class Options

java.lang.Object

net.sf.gogui.util.Options

public class Options
extends java.lang.Object

Parser for command line options. Options begin with a single '-' character.

Constructor Summary

Constructors

Constructor and Description
Options(java.lang.String[] args, java.lang.String[] specs) Parse options.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkNoArguments() Check that the number of non-option arguments is zero.
boolean	contains(java.lang.String option) Check if option is present.
java.lang.String	get(java.lang.String option) Return string option value.
java.lang.String	get(java.lang.String option, java.lang.String defaultValue) Return string option value.
java.util.ArrayList<java.lang.String>	getArguments() Get remaining arguments that are not options.
double	getDouble(java.lang.String option) Parse double option.
double	getDouble(java.lang.String option, double defaultValue) Parse double option.
int	getInteger(java.lang.String option) Parse integer option.
int	getInteger(java.lang.String option, int defaultValue) Parse integer option.
int	getInteger(java.lang.String option, int defaultValue, int min) Parse integer option with range check.
int	getInteger(java.lang.String option, int defaultValue, int min, int max) Parse integer option with range check.
long	getLong(java.lang.String option) Parse long integer option.
long	getLong(java.lang.String option, long defaultValue) Parse long integer option.
void	handleConfigOption() Read options from a file given with the option "config".
static Options	parse(java.lang.String[] args, java.lang.String[] specs) Creates a new Options instance from command line.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(java.lang.String[] args,
       java.lang.String[] specs)
        throws ErrorMessage

Parse options.

Parameters:

args - Command line args from main method

specs - Specification of allowed options. Contains option names (without '-'). Options that need an argument must have a ':' appended. The special argument '--' stops option parsing, all following arguments are treated as non-option arguments.

Throws:

ErrorMessage - If options are not valid according to specs.

Method Detail

contains

public boolean contains(java.lang.String option)

Check if option is present.

get

public java.lang.String get(java.lang.String option)

Return string option value.

Parameters:

option - The option key.

Returns:

The option value or en empty string, if option is not present.

get

public java.lang.String get(java.lang.String option,
                   java.lang.String defaultValue)

Return string option value.

Parameters:

option - The option key.

defaultValue - The default value.

Returns:

The option value or defaultValue, if option is not present.

getArguments

public java.util.ArrayList<java.lang.String> getArguments()

Get remaining arguments that are not options.

Returns:

The sequence of non-option arguments.

checkNoArguments

public void checkNoArguments()
                      throws ErrorMessage

Check that the number of non-option arguments is zero.

Throws:

ErrorMessage - If there are any non-option arguments.

getDouble

public double getDouble(java.lang.String option)
                 throws ErrorMessage

Parse double option.

Parameters:

option - The option key.

Returns:

The option value or 0, if option is not present.

Throws:

ErrorMessage - If option value is not a double.

getDouble

public double getDouble(java.lang.String option,
               double defaultValue)
                 throws ErrorMessage

Parse double option.

Parameters:

option - The option key.

defaultValue - The default value.

Returns:

The option value or defaultValue, if option is not present.

Throws:

ErrorMessage - If option value is not a double.

getInteger

public int getInteger(java.lang.String option)
               throws ErrorMessage

Parse integer option.

Parameters:

option - The option key.

Returns:

The option value or 0, if option is not present.

Throws:

ErrorMessage - If option value is not an integer.

getInteger

public int getInteger(java.lang.String option,
             int defaultValue)
               throws ErrorMessage

Parse integer option.

Parameters:

option - The option key.

defaultValue - The default value.

Returns:

The option value or defaultValue, if option is not present.

Throws:

ErrorMessage - If option value is not an integer.

getInteger

public int getInteger(java.lang.String option,
             int defaultValue,
             int min)
               throws ErrorMessage

Parse integer option with range check.

Parameters:

option - The option key.

defaultValue - The default value.

min - The minimum valid value.

Returns:

The option value or defaultValue, if option is not present.

Throws:

ErrorMessage - If option value is less than min.

getInteger

public int getInteger(java.lang.String option,
             int defaultValue,
             int min,
             int max)
               throws ErrorMessage

Parse integer option with range check.

Parameters:

option - The option key.

defaultValue - The default value.

min - The minimum valid value.

max - The maximum valid value.

Returns:

The option value or defaultValue, if option is not present.

Throws:

ErrorMessage - If option value is less than min or greater than max.

getLong

public long getLong(java.lang.String option)
             throws ErrorMessage

Parse long integer option.

Parameters:

option - The option key.

Returns:

The option value or 0, if option is not present.

Throws:

ErrorMessage - If option value is not a long integer.

getLong

public long getLong(java.lang.String option,
           long defaultValue)
             throws ErrorMessage

Parse long integer option.

Parameters:

option - The option key.

defaultValue - The default value.

Returns:

The option value or defaultValue, if option is not present.

Throws:

ErrorMessage - If option value is not a long integer.

handleConfigOption

public void handleConfigOption()
                        throws ErrorMessage

Read options from a file given with the option "config". Requires that "config" is an allowed option.

Throws:

ErrorMessage - If options in file are not valid according to the specification.

parse

public static Options parse(java.lang.String[] args,
            java.lang.String[] specs)
                     throws ErrorMessage

Creates a new Options instance from command line. Automatically calls handleConfigOption.

Parameters:

args - The command line split into arguments.

specs - Option specification as in constructor.

Returns:

The new Options instance.

Throws:

ErrorMessage - If options are not valid according to specs.