Package jetbrains.mps.generator.impl

Class DefaultTemplateContext

java.lang.Object

jetbrains.mps.generator.impl.DefaultTemplateContext

All Implemented Interfaces:

TemplateContext

public class DefaultTemplateContext
extends Object
implements TemplateContext

Constructor Summary

Constructors

Constructor	Description
DefaultTemplateContext(TemplateExecutionEnvironment env, SNode inputNode, String inputName)

Method Summary

Modifier and Type	Method	Description
TemplateExecutionEnvironment	getEnvironment()
SNode	getInput()
Iterable<SNode>	getInputHistory()
String	getInputName()
SNode	getNamedInput(String name)
DefaultTemplateContext	getParent()
Object	getPatternVariable(String id)
Object	getVariable(String name)
boolean	hasVariable(String name)
TemplateContext	subContext()	Reset input name, unlike TemplateContext.subContext(String) and TemplateContext.subContext(String, org.jetbrains.mps.openapi.model.SNode) that treat null input name as indicator to keep the old one.
TemplateContext	subContext(String inputName)
TemplateContext	subContext(String inputName, SNode inputNode)
TemplateContext	subContext(Map<String,Object> variables)
TemplateContext	subContext(GeneratedMatchingPattern pattern)
TemplateContext	subContext(SNode newInputNode)	Shorthand for ctx.subContext(ctx.getInputName(), newInputNode), to update input node while preserving current input name
TemplateContext	withVariable(String name, Object value)	Alternative to TemplateContext.subContext(Map) as it's rarely required to inject more than 1 variable at once, and to get a new contract, which preserves mapping label.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTemplateContext

public DefaultTemplateContext(@NotNull
                              TemplateExecutionEnvironment env,
                              @Nullable
                              SNode inputNode,
                              @Nullable
                              String inputName)

Method Detail

getEnvironment

@NotNull
public TemplateExecutionEnvironment getEnvironment()

Specified by:

getEnvironment in interface TemplateContext

getParent

public DefaultTemplateContext getParent()

getInput

public SNode getInput()

Specified by:

getInput in interface TemplateContext

getInputName

public String getInputName()

Specified by:

getInputName in interface TemplateContext

getPatternVariable

public Object getPatternVariable(String id)

Specified by:

getPatternVariable in interface TemplateContext

getVariable

public Object getVariable(String name)

Specified by:

getVariable in interface TemplateContext

hasVariable

public boolean hasVariable(String name)

Specified by:

hasVariable in interface TemplateContext

getNamedInput

public SNode getNamedInput(String name)

Specified by:

getNamedInput in interface TemplateContext

getInputHistory

public Iterable<SNode> getInputHistory()

Specified by:

getInputHistory in interface TemplateContext

subContext

public TemplateContext subContext(String inputName,
                                  SNode inputNode)

Specified by:

subContext in interface TemplateContext

Parameters:

inputName - new name for input, or null to keep the old one

inputNode - new input node

Returns:

new context that updates both input and mapping label

subContext

public TemplateContext subContext(String inputName)

Specified by:

subContext in interface TemplateContext

Parameters:

inputName - new name for input, or null to keep the old one

Returns:

new context that preserves input and gives it a new name

subContext

public TemplateContext subContext(Map<String,Object> variables)

Specified by:

subContext in interface TemplateContext

Returns:

new context that preserves input, but discards mapping label

withVariable

public TemplateContext withVariable(String name,
                                    Object value)

Description copied from interface: TemplateContext

Alternative to TemplateContext.subContext(Map) as it's rarely required to inject more than 1 variable at once, and to get a new contract, which preserves mapping label.

Specified by:

withVariable in interface TemplateContext

Parameters:

name - variable name, TemplateContext.getVariable(String), not null

value - varaible value, can be null

Returns:

new context that preserves input and mapping label, with new value for named variable.

subContext

public TemplateContext subContext(GeneratedMatchingPattern pattern)

Specified by:

subContext in interface TemplateContext

Returns:

new context that preserves input, but discards mapping label

subContext

public TemplateContext subContext()

Description copied from interface: TemplateContext

Reset input name, unlike TemplateContext.subContext(String) and TemplateContext.subContext(String, org.jetbrains.mps.openapi.model.SNode) that treat null input name as indicator to keep the old one.

Specified by:

subContext in interface TemplateContext

Returns:

context with un-named input (same as current context), with hierarchy of contexts preserved (i.e. #getInputHistory() would provide one)

subContext

public TemplateContext subContext(SNode newInputNode)

Description copied from interface: TemplateContext

Shorthand for ctx.subContext(ctx.getInputName(), newInputNode), to update input node while preserving current input name

Specified by:

subContext in interface TemplateContext

Parameters:

newInputNode - new input

Returns:

context with desired input and present input name