com.hp.util.syntax

Class SyntaxMatcher

java.lang.Object

com.hp.util.syntax.SyntaxMatcher

public class SyntaxMatcher
extends Object

Matches command-line arguments against a pre-compiled set of syntaxes.

Author:

Thomas Vachuska

Constructor Summary

Constructors

Constructor and Description
SyntaxMatcher(Locale locale) Constructs the syntax compiler in the context of the given locale.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPackage(SyntaxPackage syntaxPackage) Registers the given set of packages with this matcher.
void	addPackages(Set<SyntaxPackage> packages) Registers the given set of packages with this matcher.
Locale	getLocale() Returns the locale with which this matcher is associated.
Syntax	getMatchingSyntax(String[] args, Parameters parameters) Matches command-line arguments against pre-compiled set of syntaxes.
Set<SyntaxPackage>	getPackages() Returns an unmodifiable copy of the set of registered packages.
List<Syntax>	getSyntaxes() Returns an unmodifiable copy of the prioritized syntax list.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxMatcher

public SyntaxMatcher(Locale locale)

Constructs the syntax compiler in the context of the given locale.

Parameters:

locale - Locale context to use for matching the otherwise locale-independent syntax.

Method Detail

getLocale

public Locale getLocale()

Returns the locale with which this matcher is associated.

Returns:

matcher locale

addPackage

public void addPackage(SyntaxPackage syntaxPackage)

Registers the given set of packages with this matcher.

Parameters:

syntaxPackage - syntax package to be added

addPackages

public void addPackages(Set<SyntaxPackage> packages)

Registers the given set of packages with this matcher.

Parameters:

packages - set of syntax packages to be added

getPackages

public Set<SyntaxPackage> getPackages()

Returns an unmodifiable copy of the set of registered packages.

Returns:

set of registered syntax packages

getSyntaxes

public List<Syntax> getSyntaxes()

Returns an unmodifiable copy of the prioritized syntax list.

Returns:

list of registered syntaxes

getMatchingSyntax

public Syntax getMatchingSyntax(String[] args,
                       Parameters parameters)
                         throws BadUsageException

Matches command-line arguments against pre-compiled set of syntaxes.

Parameters:

args - Command-line arguments to be parsed.

parameters - Parameter map to be populated (on success) with string name to serializable object bindings. syntax definitions.

Returns:

Syntax instance that successfully matched the specified command-line arguments

Throws:

BadUsageException - thrown if the specified arguments failed to match any of the syntaxes registered with this matcher.