org.dishevelled.commandline

Interface Argument<E>

Type Parameters:

E - argument type

All Known Implementing Classes:

AbstractArgument, BooleanArgument, BooleanListArgument, BooleanSetArgument, ByteArgument, ByteListArgument, ByteSetArgument, CharacterArgument, DateArgument, DoubleArgument, DoubleListArgument, DoubleSetArgument, FileArgument, FileListArgument, FileSetArgument, FloatArgument, FloatListArgument, FloatSetArgument, IntegerArgument, IntegerListArgument, IntegerSetArgument, LongArgument, LongListArgument, LongSetArgument, StringArgument, StringListArgument, StringSetArgument, Switch, URLArgument, URLListArgument, URLSetArgument

public interface Argument<E>

A typed argument.

Author:

Michael Heuer

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return the description of this argument.
String	getLongName() Return the long name of this argument.
String	getShortName() Return the short name of this argument.
E	getValue() Return the value of this argument.
E	getValue(E defaultValue) Return the value of this argument or the specified default value if this argument was not found in the command line.
boolean	isRequired() Return true if this argument is required.
void	visit(String s, CommandLine commandLine) Visit the specified argument string from the specified command line.
boolean	wasFound() Return true if this argument was found in the command line, false if it was not found or if this argument has not visited a command line yet.

Method Detail

visit

void visit(String s,
         CommandLine commandLine)
           throws Exception

Visit the specified argument string from the specified command line.

Previous and next argument strings in the command line may be interrogated by this argument, but the cursor position of the command line must be reset to what it was at the beginning of this method invocation.

Parameters:

s - current argument string

commandLine - command line to visit

Throws:

Exception - if any error occurs

getShortName

String getShortName()

Return the short name of this argument.

Returns:

the short name of this argument

getLongName

String getLongName()

Return the long name of this argument.

Returns:

the long name of this argument

getDescription

String getDescription()

Return the description of this argument.

Returns:

the description of this argument

isRequired

boolean isRequired()

Return true if this argument is required.

Returns:

true if this argument is required

wasFound

boolean wasFound()

Return true if this argument was found in the command line, false if it was not found or if this argument has not visited a command line yet.

Returns:

true if this argument was found in the command line

See Also:

visit(String, CommandLine)

getValue

E getValue()

Return the value of this argument.

Returns:

the value of this argument

getValue

E getValue(E defaultValue)

Return the value of this argument or the specified default value if this argument was not found in the command line.

Returns:

the value of this argument or the specified default value if this argument was not found in the command line