org.protempa.cli

Class CLI.Argument

java.lang.Object

org.protempa.cli.CLI.Argument

Enclosing class:

CLI

public static final class CLI.Argument
extends Object

For defining command line arguments that are not prefixed by the option syntax.

Constructor Summary

Constructors

Constructor and Description
Argument(String name, boolean required) Instantiates an instance with the name of the argument and whether or not it is required.

Method Summary

Modifier and Type	Method and Description
String	getFormatted() Gets the argument formatted as a string suitable for a usage statement.
String	getName() Returns the argument's name.
boolean	isRequired() Returns whether the argument is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument(String name,
                boolean required)

Instantiates an instance with the name of the argument and whether or not it is required.

Parameters:

name - the argument's name, a String.

required - true if the argument is required, false if not.

Method Detail

getName

public String getName()

Returns the argument's name.

Returns:

a String.

isRequired

public boolean isRequired()

Returns whether the argument is required.

Returns:

true if the argument is required, false if not.

getFormatted

public String getFormatted()

Gets the argument formatted as a string suitable for a usage statement.

Returns:

a String.