com.hp.util.syntax

Class Syntax

java.lang.Object

com.hp.util.syntax.SyntaxNode

com.hp.util.syntax.SyntaxNodeExtension

com.hp.util.syntax.SyntaxFragment

com.hp.util.syntax.Syntax

All Implemented Interfaces:

TokenTranslator, SyntaxKeywords, Serializable

public class Syntax
extends SyntaxFragment

Class representing a root syntax node, i.e. one that references other syntax nodes via it's own usage string and has a symbolic action associated with it, which makes it a top-level syntax node.

Author:

Thomas Vachuska

See Also:

Serialized Form

Field Summary

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

USAGE_STRING_SEPARATOR

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	Syntax() Default constructor.
	Syntax(SyntaxNode node, SyntaxNodeExtension parent, List<SyntaxNode> anchoredNodes, List<SyntaxNode> floatingNodes, String actionName) Constructs a new syntax node.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionName() Get the symbolic action name associated with this syntax pattern.
int	getPriority() Get the priority of the syntax, which determines the order in which this syntax will be considered relative to other syntax entities.
boolean	isAuxiliary() Returns true if the syntax is purely auxiliary and hence it should never be considered as the closest matching syntax in case of a complete mismatch.
boolean	matches(String[] args, Parameters parameters, Parameters committedParameters, ParsePosition position, ParsePosition start, SyntaxPosition farthestMismatchPosition, boolean indexParameters) Returns true if the node matches the given arguments starting with the specified position.
protected void	setActionName(String actionName) Set the symbolic action name associated with this syntax pattern.
protected void	setPriority(int priority) Set the priority of the syntax, which determines the order in which this syntax will be considered relative to other syntax entities.

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

applyDefaults, getAnchoredNodes, getCanonicNodeLists, getFirstAnchoredNode, getFloatingNodes, getHelpTopics, matchesAnchor, matchesFloater, matchesOnce, setHelpTopics, toString

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

getMaxOccurrences, getMinOccurrences, getParent

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Syntax

protected Syntax()

Default constructor.

Syntax

public Syntax(SyntaxNode node,
      SyntaxNodeExtension parent,
      List<SyntaxNode> anchoredNodes,
      List<SyntaxNode> floatingNodes,
      String actionName)

Constructs a new syntax node.

Parameters:

node - originating node

parent - parent node

anchoredNodes - list of anchored nodes

floatingNodes - list of floating nodes

actionName - action name

Method Detail

getPriority

public int getPriority()

Get the priority of the syntax, which determines the order in which this syntax will be considered relative to other syntax entities.

Returns:

Integer value that specifies the priority of the syntax; lower number means higher priority.

setPriority

protected void setPriority(int priority)

Set the priority of the syntax, which determines the order in which this syntax will be considered relative to other syntax entities.

Parameters:

priority - Integer value that specifies the priority of the syntax; lower number means higher priority.

getActionName

public String getActionName()

Get the symbolic action name associated with this syntax pattern.

Returns:

syntax action name

setActionName

protected void setActionName(String actionName)

Set the symbolic action name associated with this syntax pattern.

Parameters:

actionName - new syntax action name

isAuxiliary

public boolean isAuxiliary()

Returns true if the syntax is purely auxiliary and hence it should never be considered as the closest matching syntax in case of a complete mismatch. Syntax can be designated as an auxiliary one, by setting its priority to -1 in its property DB.

Returns:

true if the syntax is to be considered auxiliary

matches

public boolean matches(String[] args,
              Parameters parameters,
              Parameters committedParameters,
              ParsePosition position,
              ParsePosition start,
              SyntaxPosition farthestMismatchPosition,
              boolean indexParameters)

Returns true if the node matches the given arguments starting with the specified position. If a match is found, the position will be updated to the next unparsed argument. If no match is found the farthestMismatchPosition parameter will hold the index of the farthest argument that failed to match and the reference to the syntax node against which that match failed.

Overrides:

matches in class SyntaxFragment

Parameters:

args - Command-line argument strings

parameters - Parameter map into which this matching attempt should accumulate its (String, Serializable) bindings.

committedParameters - Parameter map of (String, Serializable) bindings that has been committed thus far through the entire syntax matching process.

position - Position within the args, where this matching attempt should start.

start - Position within the defined syntax, where this matching attempt should start.

farthestMismatchPosition - The farthest position where mismatch occured within this matching attempt.

indexParameters - flag indicating whether parameters contained within this node should be added as indexed.

Returns:

true if the arguments matched this syntax node; false otherwise

See Also:

SyntaxNode.matches(java.lang.String[], com.hp.util.syntax.Parameters, com.hp.util.syntax.Parameters, java.text.ParsePosition, java.text.ParsePosition, com.hp.util.syntax.SyntaxPosition, boolean)