org.eiichiro.ash

Class Usage

java.lang.Object

org.eiichiro.ash.Usage

public class Usage
extends Object

Usage represents a command usage.

Author:

Eiichiro Uchiumi

Constructor Summary

Constructors

Constructor and Description
Usage(String synopsis) Constructs a new Usage with the specified command syntax.

Method Summary

Modifier and Type	Method and Description
void	option(String opt, boolean required, String description)
void	option(String opt, boolean required, String description, String arg)
void	option(String opt, String longOpt, boolean required, String description)
void	option(String opt, String longOpt, boolean required, String description, String arg)
Set<org.eiichiro.ash.Usage.Option>	options()
String	synopsis() Returns the command synopsis.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Usage

public Usage(String synopsis)

Constructs a new Usage with the specified command syntax.

Parameters:

synopsis - Command synopsis.

Method Detail

synopsis

public String synopsis()

Returns the command synopsis.

Returns:

The command synopsis.

options

public Set<org.eiichiro.ash.Usage.Option> options()

option

public void option(String opt,
                   boolean required,
                   String description)

option

public void option(String opt,
                   boolean required,
                   String description,
                   String arg)

option

public void option(String opt,
                   String longOpt,
                   boolean required,
                   String description)

option

public void option(String opt,
                   String longOpt,
                   boolean required,
                   String description,
                   String arg)

toString

public String toString()

Overrides:

toString in class Object