com.hp.util.syntax

Class SyntaxPackage

java.lang.Object

com.hp.util.syntax.SyntaxNode

com.hp.util.syntax.SyntaxPackage

All Implemented Interfaces:

TokenTranslator, ParserLoader, SyntaxKeywords, Serializable

public class SyntaxPackage
extends SyntaxNode
implements ParserLoader

Class representing a package of syntax definitions. This class is not thread-safe and relies on external synchronization, should its instances be used by multiple simultaneous threads.

Author:

Thomas Vachuska

See Also:

Serialized Form

Field Summary

Fields inherited from class com.hp.util.syntax.SyntaxNode

ABBREV_DELIMITER, RESOURCE_PREFIX, VALUE_DELIMITER

Fields inherited from interface com.hp.util.syntax.SyntaxKeywords

KW_ACTION_NAME, KW_CLASS, KW_CONSTRAINTS_PARSER, KW_CONSTRAINTS_TYPE, KW_DEFAULT, KW_DESCRIPTION, KW_EXTENDS, KW_FLOATING, KW_HELP_TEXT, KW_HELP_TOPICS, KW_NAME, KW_PACKAGE, KW_PARAMETER, KW_PARAMETER_PARSER, KW_PRIORITY, KW_PROPERTY, KW_RESOURCES, KW_SUPER, KW_SYNTAX, KW_USAGE, KW_VALUE, KW_VALUE_TYPE, MAX_OCCURRENCES, MIN_OCCURRENCES, OPTIONAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SyntaxPackage() Default constructor.
	SyntaxPackage(Properties db, Locale locale) Constructs a new syntax package using the given properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNode(SyntaxNode node) Adds the given node to the syntax package.
void	addParser(TypedParser parser, Class<?> parserInterface) Registers the specified parser, using its type token, in the pool of parsers that implement the specified interface.
SyntaxNode	getNode(String name) Get the named node using its fully qualified node name.
Map<String,SyntaxNode>	getNodes() Get a map of name/node bindings for all syntax nodes defined in this package.
TypedParser	getParser(String name, Class<?> parserInterface) Returns the parser with the specified name and from the specified intefrace pool.
List<Syntax>	getSyntaxes() Get prioritized list of syntaxes (instances of Syntax) defined within this package.

Methods inherited from class com.hp.util.syntax.SyntaxNode

error, getContainer, getDB, getDescription, getHelpText, getLocale, getName, getResourceBundle, getShortName, isFloating, matches, setDescription, setFloating, setHelpText, setName, setResourceBundle, toString, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxPackage

protected SyntaxPackage()

Default constructor.

SyntaxPackage

public SyntaxPackage(Properties db,
             Locale locale)

Constructs a new syntax package using the given properties.

Parameters:

db - Properties containing definition of this node.

locale - Locale context for this node's attributes.

Method Detail

getParser

public TypedParser getParser(String name,
                    Class<?> parserInterface)

Returns the parser with the specified name and from the specified intefrace pool.

Specified by:

getParser in interface ParserLoader

Parameters:

name - Type token associated with this parser.

parserInterface - ConstraintsParser or ParameterParser class object that identifies the general interface pool.

Returns:

Concrete instance that implements the specified interface.

addParser

public void addParser(TypedParser parser,
             Class<?> parserInterface)

Registers the specified parser, using its type token, in the pool of parsers that implement the specified interface.

Specified by:

addParser in interface ParserLoader

Parameters:

parser - Class that implements the given parser interface and should therefore be added to the corresponding pool

parserInterface - ConstraintsParser or ParameterParser class object that identifies the general interface pool.

getSyntaxes

public List<Syntax> getSyntaxes()

Get prioritized list of syntaxes (instances of Syntax) defined within this package.

Returns:

List of syntaxes ordered by their priority.

getNodes

public Map<String,SyntaxNode> getNodes()

Get a map of name/node bindings for all syntax nodes defined in this package.

Returns:

Map of name/syntax node bindings.

addNode

public void addNode(SyntaxNode node)

Adds the given node to the syntax package. If the node is Syntax then it will also be added, according to its priority to the ordered list of syntaxes.

Parameters:

node - Syntax node to be added to this package.

getNode

public SyntaxNode getNode(String name)

Get the named node using its fully qualified node name.

Parameters:

name - Fully qualified node name.

Returns:

Syntax node instance with the specified name; null if there is no node registered using that name.