com.hp.util.syntax

Class SyntaxRepository

java.lang.Object

com.hp.util.syntax.SyntaxRepository

public class SyntaxRepository
extends Object

Aggregation facility for discovering and compiling available syntax packages and for matching command-line arguments against their syntax sets.

Author:

Thomas Vachuska

Constructor Summary

Constructors

Constructor and Description
SyntaxRepository() Create a syntax repository using all syntaxes found ...

Method Summary

Modifier and Type	Method and Description
void	addSyntaxDefinitions(InputStream is) Parses the command-line syntax definitions supplied through the given input stream and adds the resulting syntax package to the repository.
SyntaxCompiler	compiler() Get the syntax compiler utility instance
SyntaxMatch	match(String[] args) Matches an array of string arguments that were present on the CLIF client's arguments list, and attempts to match them against a defined syntax.
Set<SyntaxPackage>	packages() Gets the set of all discovered syntax packages.
SyntaxUsage	syntaxUsage() Get the syntax usage utility instance

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxRepository

public SyntaxRepository()

Create a syntax repository using all syntaxes found ...

Method Detail

packages

public Set<SyntaxPackage> packages()

Gets the set of all discovered syntax packages.

Returns:

set of discovered syntax packages

addSyntaxDefinitions

public void addSyntaxDefinitions(InputStream is)
                          throws IOException

Parses the command-line syntax definitions supplied through the given input stream and adds the resulting syntax package to the repository.

Parameters:

is - input stream containing the XML definition of command-line syntax

Throws:

IOException - if issues are encountered reading from the given input stream

match

public SyntaxMatch match(String[] args)
                  throws BadUsageException

Matches an array of string arguments that were present on the CLIF client's arguments list, and attempts to match them against a defined syntax. If no syntax can be found a BadUsageException will be thrown.

Parameters:

args - arguments that have been pulled from a the CLIF client's execution of a command line command

Returns:

syntax match descriptor that contains the syntax and parameters that resulted from the successful match

Throws:

BadUsageException - if the given arguments do not match with any defined syntax

syntaxUsage

public SyntaxUsage syntaxUsage()

Get the syntax usage utility instance

Returns:

SyntaxUsage utility

compiler

public SyntaxCompiler compiler()

Get the syntax compiler utility instance

Returns:

syntax compiler utility in use by the syntax repository