net.termer.rtflc.utils

Class ArgParser

java.lang.Object

net.termer.rtflc.utils.ArgParser

public class ArgParser
extends java.lang.Object

Utility class to parse command line arguments.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ArgParser(java.lang.String[] args) Instantiates a new ArgParser object and parses the provided arguments.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	arguments() Returns all normal (non-flag/option arguments).
boolean	flag(char flag) Returns whether the specified flag exists.
java.lang.Character[]	flags() Returns all flag arguments.
boolean	hasValue(java.lang.String option) Returns whether the specified option has a value.
boolean	option(java.lang.String name) Returns whether the specified option exists.
char	optionChar(java.lang.String option) Returns the value of the specified option as a char.
double	optionDouble(java.lang.String option) Returns the value of the specified option as a double.
int	optionInt(java.lang.String option) Returns the value of the specified option as an int.
java.util.HashMap<java.lang.String,java.lang.String>	options() Returns all options as a HashMap.
java.lang.String	optionString(java.lang.String option) Returns the value of the specified option as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgParser

public ArgParser(java.lang.String[] args)

Instantiates a new ArgParser object and parses the provided arguments.

Parameters:

args - the command line arguments to parse

Since:

1.0

Method Detail

arguments

public java.lang.String[] arguments()

Returns all normal (non-flag/option arguments).

Returns:

all normal arguments

Since:

1.0

flags

public java.lang.Character[] flags()

Returns all flag arguments.

Returns:

all flag arguments

Since:

1.0

options

public java.util.HashMap<java.lang.String,java.lang.String> options()

Returns all options as a HashMap. Option arguments that don't have a value will have null set as their value in the HashMap.

Returns:

all options

Since:

1.0

option

public boolean option(java.lang.String name)

Returns whether the specified option exists.

Parameters:

name - the name of the option

Returns:

whether the option exists

Since:

1.0

flag

public boolean flag(char flag)

Returns whether the specified flag exists.

Parameters:

flag - the flag char

Returns:

whether the flag exists

Since:

1.0

optionString

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

Returns the value of the specified option as a String. Returns null if the option does not have a value.

Parameters:

option - the name of the option

Returns:

the value of the option

Since:

1.0

optionInt

public int optionInt(java.lang.String option)

Returns the value of the specified option as an int. Returns null if the option does not have a value. If the value of the option is not an int, this method will throw a NumberFormatException.

Parameters:

option - the name of the option

Returns:

the value of the option

Since:

1.0

optionChar

public char optionChar(java.lang.String option)

Returns the value of the specified option as a char. Returns null if the option does not have a value.

Parameters:

option - the name of the option

Returns:

the value of the option

Since:

1.0

optionDouble

public double optionDouble(java.lang.String option)

Returns the value of the specified option as a double. Returns null if the option does not have a value. If the value of the option is not a double, this method will throw a NumberFormatException.

Parameters:

option - the name of the option

Returns:

the value of the option

Since:

1.0

hasValue

public boolean hasValue(java.lang.String option)

Returns whether the specified option has a value.

Parameters:

option - the name of the option

Returns:

whether the option has a value

Since:

1.0