cpptools
Class Usage

java.lang.Object
  cpptools.Usage

public final class Usage
extends java.lang.Object

Provides a means to format an application usage.

Author:

Mathieu Champlon

Constructor Summary

Usage(java.lang.String name, java.lang.String url, java.lang.String version)
Create a usage helper.

Method Summary

void	addOption(java.lang.String option, java.lang.String description) Add an option description.
void	display() Display the usage information.

Methods inherited from class java.lang.Object

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

Constructor Detail

Usage

public Usage(java.lang.String name,
             java.lang.String url,
             java.lang.String version)

Create a usage helper.

Parameters:

name - the application name

url - the application site url

version - the application version

Method Detail

addOption

public void addOption(java.lang.String option,
                      java.lang.String description)

Add an option description.

Parameters:

option - the name of the option

description - the description of the option

display

public void display()

Display the usage information.