org.dishevelled.commandline.argument

Class AbstractArgument<E>

java.lang.Object

org.dishevelled.commandline.argument.AbstractArgument<E>

Type Parameters:

E - argument type

All Implemented Interfaces:

Argument<E>

Direct Known Subclasses:

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

public abstract class AbstractArgument<E>
extends Object
implements Argument<E>

Abstract implementation of Argument.

Author:

Michael Heuer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArgument(String shortName, String longName, String description, boolean required) Create a new abstract argument.

Method Summary

Modifier and Type	Method and Description
protected abstract E	convert(String s) Convert the specified string value into an instance of class E.
boolean	equals(Object o)
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.
int	hashCode()
protected boolean	isArgumentString(String s) Return true if the specified string is an argument name.
boolean	isRequired() Return true if this argument is required.
protected boolean	isValueString(String s) Return true if the specified string is a value.
void	visit(String current, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArgument

protected AbstractArgument(String shortName,
                           String longName,
                           String description,
                           boolean required)

Create a new abstract argument.

Parameters:

shortName - short argument name

longName - long argument name

description - argument description

required - true if this argument is required

Method Detail

visit

public final void visit(String current,
                        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.

Specified by:

visit in interface Argument<E>

Parameters:

current - current argument string

commandLine - command line to visit

Throws:

Exception - if any error occurs

isArgumentString

protected boolean isArgumentString(String s)

Return true if the specified string is an argument name.

Parameters:

s - string

Returns:

true if the specified string is an argument name

isValueString

protected boolean isValueString(String s)

Return true if the specified string is a value.

Parameters:

s - string

Returns:

true if the specified string is a value

convert

protected abstract E convert(String s)
                      throws Exception

Convert the specified string value into an instance of class E.

Parameters:

s - string value

Returns:

an instance of class E converted from the specified string value

Throws:

Exception - if an error occurs

getShortName

public final String getShortName()

Return the short name of this argument.

Specified by:

getShortName in interface Argument<E>

Returns:

the short name of this argument

getLongName

public final String getLongName()

Return the long name of this argument.

Specified by:

getLongName in interface Argument<E>

Returns:

the long name of this argument

getDescription

public final String getDescription()

Return the description of this argument.

Specified by:

getDescription in interface Argument<E>

Returns:

the description of this argument

isRequired

public final boolean isRequired()

Return true if this argument is required.

Specified by:

isRequired in interface Argument<E>

Returns:

true if this argument is required

wasFound

public final 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.

Specified by:

wasFound in interface Argument<E>

Returns:

true if this argument was found in the command line

See Also:

Argument.visit(String, CommandLine)

getValue

public final E getValue()

Return the value of this argument.

Specified by:

getValue in interface Argument<E>

Returns:

the value of this argument

getValue

public final 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.

Specified by:

getValue in interface Argument<E>

Returns:

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

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object