Package org.springframework.shell.command.parser

Class AbstractNodeVisitor

java.lang.Object

org.springframework.shell.command.parser.AbstractNodeVisitor

All Implemented Interfaces:

NodeVisitor

Direct Known Subclasses:

Parser.DefaultNodeVisitor

public abstract class AbstractNodeVisitor
extends Object
implements NodeVisitor

Base abstract NodeVisitor which visits all nodes allowing user to implement callback methods.

Constructor Summary

Constructors

Constructor	Description
AbstractNodeVisitor()

Method Summary

Modifier and Type	Method	Description
protected abstract Parser.ParseResult	buildResult()	Called after all nodes has been visited to build results.
protected abstract void	onEnterCommandArgumentNode(CommandArgumentNode node)	Called when CommandArgumentNode is entered.
protected abstract void	onEnterCommandNode(CommandNode node)	Called when CommandNode is entered.
protected abstract void	onEnterDirectiveNode(DirectiveNode node)	Called when DirectiveNode is entered.
protected abstract void	onEnterOptionArgumentNode(OptionArgumentNode node)	Called when OptionArgumentNode is entered.
protected abstract void	onEnterOptionNode(OptionNode node)	Called when OptionNode is entered.
protected abstract void	onEnterRootCommandNode(CommandNode node)	Called when CommandNode for root is entered.
protected abstract void	onExitCommandArgumentNode(CommandArgumentNode node)	Called when CommandArgumentNode is exited.
protected abstract void	onExitCommandNode(CommandNode node)	Called when CommandNode is exited.
protected abstract void	onExitDirectiveNode(DirectiveNode node)	Called when DirectiveNode is exited.
protected abstract void	onExitOptionArgumentNode(OptionArgumentNode node)	Called when OptionArgumentNode is exited.
protected abstract void	onExitOptionNode(OptionNode node)	Called when OptionNode is exited.
protected abstract void	onExitRootCommandNode(CommandNode node)	Called when CommandNode for root is exited.
final Parser.ParseResult	visit(List<NonterminalAstNode> nonterminalNodes, List<TerminalAstNode> terminalNodes)	Visit lists of non terminal and terminal nodes.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractNodeVisitor

public AbstractNodeVisitor()

Method Details

visit

public final Parser.ParseResult visit(List<NonterminalAstNode> nonterminalNodes,
 List<TerminalAstNode> terminalNodes)

Description copied from interface: NodeVisitor

Visit lists of non terminal and terminal nodes.

Specified by:

visit in interface NodeVisitor

Parameters:

nonterminalNodes - non terminal nodes

terminalNodes - terminal nodes

Returns:

parser result

buildResult

protected abstract Parser.ParseResult buildResult()

Called after all nodes has been visited to build results.

Returns:

the results from this visit operation

onEnterRootCommandNode

protected abstract void onEnterRootCommandNode(CommandNode node)

Called when CommandNode for root is entered. When node is fully visited, onExitRootCommandNode(CommandNode) is called.

Parameters:

node - the command node

See Also:

• onExitRootCommandNode(CommandNode)

onExitRootCommandNode

protected abstract void onExitRootCommandNode(CommandNode node)

Called when CommandNode for root is exited.

Parameters:

node - the command node

See Also:

• onEnterRootCommandNode(CommandNode)

onEnterCommandNode

protected abstract void onEnterCommandNode(CommandNode node)

Called when CommandNode is entered. When node is fully visited, onExitCommandNode(CommandNode) is called.

Parameters:

node - the command node

See Also:

• onExitCommandNode(CommandNode)

onExitCommandNode

protected abstract void onExitCommandNode(CommandNode node)

Called when CommandNode is exited.

Parameters:

node - the command node

See Also:

• onEnterCommandNode(CommandNode)

onEnterOptionNode

protected abstract void onEnterOptionNode(OptionNode node)

Called when OptionNode is entered. When node is fully visited, onExitOptionNode(OptionNode) is called.

Parameters:

node - the option node

See Also:

• onExitOptionNode(OptionNode)

onExitOptionNode

protected abstract void onExitOptionNode(OptionNode node)

Called when OptionNode is exited.

Parameters:

node - the option node

See Also:

• onEnterOptionNode(OptionNode)

onEnterCommandArgumentNode

protected abstract void onEnterCommandArgumentNode(CommandArgumentNode node)

Called when CommandArgumentNode is entered. When node is fully visited, onExitCommandArgumentNode(CommandArgumentNode) is called.

Parameters:

node - the command argument node

See Also:

• onExitCommandArgumentNode(CommandArgumentNode)

onExitCommandArgumentNode

protected abstract void onExitCommandArgumentNode(CommandArgumentNode node)

Called when CommandArgumentNode is exited.

Parameters:

node - the command argument node

See Also:

• onEnterCommandArgumentNode(CommandArgumentNode)

onEnterOptionArgumentNode

protected abstract void onEnterOptionArgumentNode(OptionArgumentNode node)

Called when OptionArgumentNode is entered. When node is fully visited, onExitOptionArgumentNode(OptionArgumentNode) is called.

Parameters:

node - the option argument node

See Also:

• onExitOptionArgumentNode(OptionArgumentNode)

onExitOptionArgumentNode

protected abstract void onExitOptionArgumentNode(OptionArgumentNode node)

Called when OptionArgumentNode is exited.

Parameters:

node - the command argument node

See Also:

• onEnterOptionArgumentNode(OptionArgumentNode)

onEnterDirectiveNode

protected abstract void onEnterDirectiveNode(DirectiveNode node)

Called when DirectiveNode is entered. When node is fully visited, onExitDirectiveNode(DirectiveNode) is called.

Parameters:

node - the option node

See Also:

• onExitDirectiveNode(DirectiveNode)

onExitDirectiveNode

protected abstract void onExitDirectiveNode(DirectiveNode node)

Called when DirectiveNode is exited.

Parameters:

node - the option node

See Also:

• onEnterDirectiveNode(DirectiveNode)