Package org.qubership.atp.macros.core.processor

Class SimpleContext

java.lang.Object

org.qubership.atp.macros.core.processor.AbstractContext<SimpleContext>

org.qubership.atp.macros.core.processor.SimpleContext

public class SimpleContext
extends AbstractContext<SimpleContext>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	args
protected Evaluator	evaluator
protected Macros	macro
protected SimpleContext	reducedChild
protected List<String>	text

Fields inherited from class org.qubership.atp.macros.core.processor.AbstractContext

contextMap, contextParameters, parent, strategy

Constructor Summary

Constructors

Constructor	Description
SimpleContext()
SimpleContext(SimpleContext parent, MacrosParser.MacrosStartContext macro, Macros macros, Evaluator evaluator)

Method Summary

Modifier and Type	Method	Description
protected SimpleContext	createChildContext(MacrosParser.MacrosStartContext ctx, Macros macros, Evaluator evaluator)	Invoked when macro denoted by current context contains another macro as argument.
protected SimpleContext	createRootContext()
protected String	getArgument(MacrosParser.MacroArgContext arg)
String	getResultOnEvaluationEnd()
protected void	notifyMacroEnds(MacrosParser.MacrosEndContext ctx)	Args are filled up now.
protected void	notifyMacroStarts(MacrosParser.MacrosStartContext macro, Macros macros, Evaluator evaluator)	Initializes with macro.
protected void	pushArguments(MacrosParser.MacroParamContext arg)
protected void	pushArguments(MacrosParser.MacroParamsContext args)	Invoked only on initialized context (in the macro).
protected void	pushArguments(MacrosParser.MacrosEndContext args)	Invoked only on initialized context (in the macro).
protected void	pushArguments(MacrosParser.MacrosStartContext args)	Invoked only on initialized context (in the macro).
protected void	pushArguments(MacrosParser.QuoteContext args)	Invoked only on initialized context (in the macro).
protected void	pushArguments(MacrosParser.SlashContext args)	Invoked only on initialized context (in the macro).
protected void	pushArguments(MacrosParser.TextContext args)	Invoked only on initialized context (in the macro).
protected void	pushText(MacrosParser.MacroParamsContext text)
protected void	pushText(MacrosParser.MacrosEndContext text)	Invoked only on uninitialized context (outside the macro).
protected void	pushText(MacrosParser.MacrosStartContext text)	Invoked only on uninitialized context (outside the macro).
protected void	pushText(MacrosParser.QuoteContext text)
protected void	pushText(MacrosParser.SlashContext text)
protected void	pushText(MacrosParser.TextContext text)	Invoked only on uninitialized context (outside the macro).
protected void	reduce(MacrosParser.MacrosEndContext ctx, SimpleContext child)	Invoked on parent to notify that child (nested macro) is fully processed and should be aggregated with parent.
SimpleContext	reset()
protected void	resetMacro()

Methods inherited from class java.lang.Object

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

Field Details

args

protected List<String> args

reducedChild

protected SimpleContext reducedChild

text

protected List<String> text

macro

protected Macros macro

evaluator

protected Evaluator evaluator

Constructor Details

SimpleContext

public SimpleContext()

SimpleContext

public SimpleContext(@Nonnull
 SimpleContext parent,
 @Nonnull
 MacrosParser.MacrosStartContext macro,
 @Nonnull
 Macros macros,
 @Nonnull
 Evaluator evaluator)

Method Details

notifyMacroStarts

protected void notifyMacroStarts(@Nonnull
 MacrosParser.MacrosStartContext macro,
 @Nonnull
 Macros macros,
 @Nonnull
 Evaluator evaluator)

Description copied from class: AbstractContext

Initializes with macro. Should clear args in case it was uninitialized previously and reused for next sibling now.

Specified by:

notifyMacroStarts in class AbstractContext<SimpleContext>

getArgument

protected String getArgument(MacrosParser.MacroArgContext arg)

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.MacrosStartContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro). Will be invoked when user has defined a macro which does not exist. May be interpreted as text by default.

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.TextContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro).

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.QuoteContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro).

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.SlashContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro).

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

pushArguments

protected void pushArguments(MacrosParser.MacroParamContext arg)

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.MacroParamsContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro).

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

pushArguments

protected void pushArguments(@Nonnull
 MacrosParser.MacrosEndContext args)

Description copied from class: AbstractContext

Invoked only on initialized context (in the macro). Will be invoked when user has defined a macro which does not exist. May be interpreted as text by default.

Specified by:

pushArguments in class AbstractContext<SimpleContext>

Parameters:

args - - the part of an arguments text.

notifyMacroEnds

protected void notifyMacroEnds(MacrosParser.MacrosEndContext ctx)

Description copied from class: AbstractContext

Args are filled up now. Result of evaluation should be pushed into state text.

Specified by:

notifyMacroEnds in class AbstractContext<SimpleContext>

createRootContext

protected SimpleContext createRootContext()

pushText

protected void pushText(@Nonnull
 MacrosParser.MacrosStartContext text)

Description copied from class: AbstractContext

Invoked only on uninitialized context (outside the macro). Will be invoked when user has defined a macro which does not exist. May be interpreted as text by default.

Specified by:

pushText in class AbstractContext<SimpleContext>

Parameters:

text - - the part of an arguments text.

pushText

protected void pushText(@Nonnull
 MacrosParser.TextContext text)

Description copied from class: AbstractContext

Invoked only on uninitialized context (outside the macro).

Specified by:

pushText in class AbstractContext<SimpleContext>

Parameters:

text - - the part of an arguments text.

pushText

protected void pushText(@Nonnull
 MacrosParser.QuoteContext text)

Specified by:

pushText in class AbstractContext<SimpleContext>

pushText

protected void pushText(@Nonnull
 MacrosParser.SlashContext text)

Specified by:

pushText in class AbstractContext<SimpleContext>

pushText

protected void pushText(@Nonnull
 MacrosParser.MacroParamsContext text)

Specified by:

pushText in class AbstractContext<SimpleContext>

pushText

protected void pushText(@Nonnull
 MacrosParser.MacrosEndContext text)

Description copied from class: AbstractContext

Invoked only on uninitialized context (outside the macro). Will be invoked when user has defined a macro which does not exist. May be interpreted as text by default.

Specified by:

pushText in class AbstractContext<SimpleContext>

Parameters:

text - - the part of an arguments text.

createChildContext

@Nonnull
protected SimpleContext createChildContext(@Nonnull
 MacrosParser.MacrosStartContext ctx,
 @Nonnull
 Macros macros,
 @Nonnull
 Evaluator evaluator)

Description copied from class: AbstractContext

Invoked when macro denoted by current context contains another macro as argument. So child context will be bound to the nested macro.

Specified by:

createChildContext in class AbstractContext<SimpleContext>

reduce

protected void reduce(@Nonnull
 MacrosParser.MacrosEndContext ctx,
 @Nonnull
 SimpleContext child)

Description copied from class: AbstractContext

Invoked on parent to notify that child (nested macro) is fully processed and should be aggregated with parent.

Specified by:

reduce in class AbstractContext<SimpleContext>

Parameters:

child - - child context which will be dropped by processor.

getResultOnEvaluationEnd

public String getResultOnEvaluationEnd()

Specified by:

getResultOnEvaluationEnd in class AbstractContext<SimpleContext>

resetMacro

protected void resetMacro()

reset

public SimpleContext reset()

Specified by:

reset in class AbstractContext<SimpleContext>