com.hp.util.syntax.usage

Class SyntaxUsage

java.lang.Object

com.hp.util.syntax.usage.SyntaxUsage

public class SyntaxUsage
extends Object

Provides facilities to generate localizable usage help messages from syntax packages and syntaxes.

Author:

Thomas Vachuska

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILL_LENGTH
static int	MAX_LINE_LENGTH
static int	NROFF
static int	TEXT

Constructor Summary

Constructors

Constructor and Description
SyntaxUsage(Locale locale) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addPackage(SyntaxPackage syntaxPackage) Registers the given package with the usage generator.
void	addPackages(Set<SyntaxPackage> packages) Registers all syntax packages in the given set with the usage generator.
Set<String>	getPrimaryTopics() Gets a list of all primary topics associated with this SyntaxUsage.
Set<String>	getTopics() Gets all of the topics associated with this SyntaxUsage.
void	printDescription(PrintWriter writer, Syntax syntax, int format) Prints a short message describing the command associated with the specified syntax.
void	printHelp(PrintWriter writer, Syntax syntax) Prints the usage help message for the specified syntax.
void	printHelp(String topic, PrintWriter writer) Prints the usage message for the specified syntax.
void	printHelpText(PrintWriter writer, Syntax syntax, int format) Prints a long help message describing the behaviour of the command associated with the specified syntax.
void	printUsage(PrintWriter writer, Syntax syntax, int format) Prints the usage message for the specified syntax.
void	printUsage(String topic, PrintWriter writer, int format) Prints the usage message for the specified syntax.
void	printUsageDetails(PrintWriter writer, Syntax syntax, int format) Print the usage details message for the specified syntax.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT

public static final int TEXT

See Also:

Constant Field Values

NROFF

public static final int NROFF

See Also:

Constant Field Values

FILL_LENGTH

public static final int FILL_LENGTH

See Also:

Constant Field Values

MAX_LINE_LENGTH

public static final int MAX_LINE_LENGTH

See Also:

Constant Field Values

Constructor Detail

SyntaxUsage

public SyntaxUsage(Locale locale)

Default constructor

Parameters:

locale - context locale for generating usage string

Method Detail

addPackage

public void addPackage(SyntaxPackage syntaxPackage)

Registers the given package with the usage generator.

Parameters:

syntaxPackage - syntax package to be added

addPackages

public void addPackages(Set<SyntaxPackage> packages)

Registers all syntax packages in the given set with the usage generator.

Parameters:

packages - set of syntax packages to be added

getTopics

public Set<String> getTopics()

Gets all of the topics associated with this SyntaxUsage.

Returns:

A set of topics which are associated with this SyntaxUsage.

getPrimaryTopics

public Set<String> getPrimaryTopics()

Gets a list of all primary topics associated with this SyntaxUsage.

Returns:

A set of topics which are associated with this SyntaxUsage.

printUsage

public void printUsage(String topic,
              PrintWriter writer,
              int format)

Prints the usage message for the specified syntax.

Parameters:

topic - help topic for which to generate usage help message

writer - PrintWriter to which output should be generated

format - desired output format TEXT, etc.

printHelp

public void printHelp(String topic,
             PrintWriter writer)

Prints the usage message for the specified syntax.

Parameters:

topic - help topic for which to generate usage help message

writer - PrintWriter to which output should be generated

printHelp

public void printHelp(PrintWriter writer,
             Syntax syntax)

Prints the usage help message for the specified syntax.

Parameters:

writer - PrintWriter to which output should be generated

syntax - syntax for which to generate usage help message

printDescription

public void printDescription(PrintWriter writer,
                    Syntax syntax,
                    int format)

Prints a short message describing the command associated with the specified syntax.

Parameters:

writer - PrintWriter to which output should be generated

syntax - syntax for which to generate description message

format - desired output format TEXT, etc.

printHelpText

public void printHelpText(PrintWriter writer,
                 Syntax syntax,
                 int format)

Prints a long help message describing the behaviour of the command associated with the specified syntax.

Parameters:

writer - PrintWriter to which output should be generated

syntax - syntax for which to generate help message

format - desired output format TEXT, etc.

printUsage

public void printUsage(PrintWriter writer,
              Syntax syntax,
              int format)

Prints the usage message for the specified syntax.

Parameters:

writer - PrintWriter to which output should be generated

syntax - syntax for which to generate usage help message

format - desired output format TEXT, etc.

printUsageDetails

public void printUsageDetails(PrintWriter writer,
                     Syntax syntax,
                     int format)

Print the usage details message for the specified syntax.

Parameters:

writer - PrintWriter to which output should be generated

syntax - syntax for which to generate usage details message

format - desired output format TEXT, etc.