ca.uqac.lif.ecp.cli

Class CliParser.Argument

java.lang.Object

ca.uqac.lif.ecp.cli.CliParser.Argument

Enclosing class:

CliParser

public static class CliParser.Argument
extends java.lang.Object

Representation of a command line argument. An argument can have:

• A "short" name, such as -s. Short names generally have a single symbol and are prefixed with a single dash
• A "long" name, such as --server. Long names have multiple symbols and are prefixed with two dashes
• A description, only used when printing command line usage
• A value, such as --port 80

Author:

Sylvain Hallé

Constructor Summary

Constructors

Constructor and Description
Argument() Constructs an empty argument

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()
CliParser.Argument	withArgument(java.lang.String name) Set the name of the value for this argument
CliParser.Argument	withDescription(java.lang.String description) Set the description for this argument
CliParser.Argument	withLongName(java.lang.String name) Set the short name of the argument
CliParser.Argument	withShortName(java.lang.String name) Set the short name of the argument

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument()

Constructs an empty argument

Method Detail

withShortName

public CliParser.Argument withShortName(java.lang.String name)

Set the short name of the argument

Parameters:

name - The short name

Returns:

This argument

withLongName

public CliParser.Argument withLongName(java.lang.String name)

Set the short name of the argument

Parameters:

name - The short name

Returns:

This argument

withDescription

public CliParser.Argument withDescription(java.lang.String description)

Set the description for this argument

Parameters:

description - The description

Returns:

This argument

withArgument

public CliParser.Argument withArgument(java.lang.String name)

Set the name of the value for this argument

Parameters:

name - The name of the value

Returns:

This argument

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object