org.dishevelled.commandline

Class Switch

java.lang.Object

org.dishevelled.commandline.Switch

All Implemented Interfaces:

Argument<Boolean>

public final class Switch
extends Object
implements Argument<Boolean>

Switch.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
Switch(String shortName, String longName, String description) Create a new switch.

Method Summary

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.
Boolean	getValue() Return the value of this argument.
Boolean	getValue(Boolean 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 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Switch

public Switch(String shortName,
              String longName,
              String description)

Create a new switch.

Parameters:

shortName - short switch name

longName - long switch name

description - switch description

Method Detail

visit

public 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<Boolean>

Parameters:

current - current argument string

commandLine - command line to visit

Throws:

Exception - if any error occurs

getShortName

public String getShortName()

Return the short name of this argument.

Specified by:

getShortName in interface Argument<Boolean>

Returns:

the short name of this argument

getLongName

public String getLongName()

Return the long name of this argument.

Specified by:

getLongName in interface Argument<Boolean>

Returns:

the long name of this argument

getDescription

public String getDescription()

Return the description of this argument.

Specified by:

getDescription in interface Argument<Boolean>

Returns:

the description of this argument

isRequired

public boolean isRequired()

Return true if this argument is required.

Specified by:

isRequired in interface Argument<Boolean>

Returns:

true if this argument is required

wasFound

public 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<Boolean>

Returns:

true if this argument was found in the command line

See Also:

Argument.visit(String, CommandLine)

getValue

public Boolean getValue()

Return the value of this argument.

Specified by:

getValue in interface Argument<Boolean>

Returns:

the value of this argument

getValue

public Boolean getValue(Boolean 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<Boolean>

Returns:

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