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 syntax) Constructs a new Usage with the specified command syntax.

Method Summary

Methods

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	syntax() Returns the command syntax.
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 syntax)

Constructs a new Usage with the specified command syntax.

Parameters:

syntax - Command syntax.

Method Detail

syntax

public String syntax()

Returns the command syntax.

Returns:

The command syntax.

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