Package noaa.coastwatch.tools

Class UsageInfo

java.lang.Object

noaa.coastwatch.tools.UsageInfo

public class UsageInfo
extends Object

The UsageInfo class holds information about how to call a command line tool: its main function, options, and parameters.

Since:

3.5.0

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
UsageInfo(String command)

Method Summary

Modifier and Type	Method	Description
void	func(String func)
String	getFunc()	Gets the function of the command.
String	getName()	Gets the name of the command.
void	option(String option, String desc)
void	param(String param, String desc)
void	param(String param, String desc, int group)
void	section(String section)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UsageInfo

public UsageInfo(String command)

Method Details

getName

public String getName()

Gets the name of the command.

Returns:

the name of the command.

Since:

3.8.0

getFunc

public String getFunc()

Gets the function of the command.

Returns:

the function or null if none has been set.

Since:

3.8.0

func

public void func(String func)

param

public void param(String param,
 String desc)

param

public void param(String param,
 String desc,
 int group)

option

public void option(String option,
 String desc)

section

public void section(String section)

toString

public String toString()

Overrides:

toString in class Object