com.eibus.util

Class CommandLine.ParseResult

java.lang.Object

com.eibus.util.CommandLine.ParseResult

Enclosing class:

CommandLine

public static class CommandLine.ParseResult
extends java.lang.Object

This class is used to store the result of a command line parse.

See Also:

CommandLine.parse()

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_ARGUMENT A unique empty String to represent the argument of an option when no argument was given.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllOptions() Get all arguments for all options.
java.lang.String	getOptionArgument(char option) Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without a argument.
java.lang.String	getOptionArgument(java.lang.Character option) Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without a argument.
java.lang.String	getOptionArgument(java.lang.String option) Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without an argument.
java.util.List<java.lang.String>	getOptionArguments(java.lang.String option) Get all arguments for the given option, or null if the option was not present; an argument is identical (in the sense of ==) to NO_ARGUMENT if the option was given without an argument.
java.util.List<java.lang.String>	getParameters() Get all command line arguments except options and their arguments.
boolean	hasOption(char option) Check whether the last parsed command line has the given option.
boolean	hasOption(java.lang.Character option) Check whether the last parsed command line has the given option.
boolean	hasOption(java.lang.String option) Check whether the last parsed command line has the given option.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGUMENT

public static final java.lang.String NO_ARGUMENT

A unique empty String to represent the argument of an option when no argument was given.

Method Detail

getOptionArgument

public java.lang.String getOptionArgument(char option)

Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without a argument.

Parameters:

option - the option for which the argument is requested

Returns:

the argument for the option, or null if the option was not present

See Also:

NO_ARGUMENT

getOptionArgument

public java.lang.String getOptionArgument(java.lang.Character option)

Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without a argument.

Parameters:

option - the option for which the argument is requested

Returns:

the argument for the option, or null if the option was not present

See Also:

NO_ARGUMENT

getOptionArgument

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

Get the (last) argument for the given option, or null if the option was not present; the result is identical to (in the sense of ==) NO_ARGUMENT if the option was given without an argument.

Parameters:

option - the option for which the argument is requested

Returns:

the argument for the option, or null if the option was not present

See Also:

NO_ARGUMENT

getOptionArguments

public java.util.List<java.lang.String> getOptionArguments(java.lang.String option)

Get all arguments for the given option, or null if the option was not present; an argument is identical (in the sense of ==) to NO_ARGUMENT if the option was given without an argument.

Parameters:

option - the option for which the arguments are requested

Returns:

the arguments for the option, or null if the option was not present

See Also:

NO_ARGUMENT

getAllOptions

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllOptions()

Get all arguments for all options.

Returns:

all arguments for all options in a Map mapping option names to Vectors of Strings

getParameters

public java.util.List<java.lang.String> getParameters()

Get all command line arguments except options and their arguments.

hasOption

public boolean hasOption(char option)

Check whether the last parsed command line has the given option.

Parameters:

option - the option

hasOption

public boolean hasOption(java.lang.Character option)

Check whether the last parsed command line has the given option.

Parameters:

option - the option

hasOption

public boolean hasOption(java.lang.String option)

Check whether the last parsed command line has the given option.

Parameters:

option - the option