StringTemplate 4 4.3.4 · org.stringtemplate.v4.compiler.CompiledST

Field Summary

Modifier and Type	Field and Description
public CommonTree	ast How do we interpret syntax of template?
public int	codeSize
public Map<String, FormalArgument>	formalArguments
public boolean	hasFormalArgs
public List<CompiledST>	implicitlyDefinedTemplates A list of all regions and subtemplates.
public byte[]	instrs
public boolean	isAnonSubtemplate
public boolean	isRegion Does this template come from a `<@region>...`
public String	name
public STGroup	nativeGroup The group that physically defines this `ST` definition.
public int	numberOfArgsWithDefaultValues
public String	prefix Every template knows where it is relative to the group that loaded it.
public ST.RegionType	regionDefType If someone refs `<@r()>` in template t, an implicit `@t.r() ::= ""` is defined, but you can overwrite this def by defining your own.
public Interval[]	sourceMap
public String[]	strings
public String	template The original, immutable pattern (not really used again after initial "compilation").
public Token	templateDefStartToken The token that begins template definition; could be `<@r>` of region.
public TokenStream	tokens Overall token stream for template (debug only).

Constructor Summary

Access	Constructor and Description
public	CompiledST()

Method Summary

Modifier and Type	Method and Description
public void	addArg(FormalArgument a) Used by `ST#add` to add args one by one without turning on full formal args definition signal.
public void	addImplicitlyDefinedTemplate(CompiledST sub)
public CompiledST	Returns: A copy of the current `CompiledST` instance. The copy is a shallow copy, with the exception of the `formalArguments` field which is also cloned. clone() Overrides java.lang.Object.clone. Cloning the `CompiledST` for an `ST` instance allows `ST#add` to be called safely during interpretation for templates that do not contain formal arguments.
public void	defineArgDefaultValueTemplates(STGroup group)
public void	defineFormalArgs(List<FormalArgument> args)
public void	defineImplicitlyDefinedTemplates(STGroup group)
public String	disasm()
public void	dump()
public Interval	getTemplateRange()
public String	getTemplateSource()
public String	instrs()

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ast	back to summary
public CommonTree ast How do we interpret syntax of template? (debug only)

codeSize	back to summary
public int codeSize

formalArguments	back to summary
public Map<String, FormalArgument> formalArguments

hasFormalArgs	back to summary
public boolean hasFormalArgs

implicitlyDefinedTemplates	back to summary
public List<CompiledST> implicitlyDefinedTemplates A list of all regions and subtemplates.

instrs	back to summary
public byte[] instrs

isAnonSubtemplate	back to summary
public boolean isAnonSubtemplate

isRegion	back to summary
public boolean isRegion Does this template come from a `<@region>...<@end>` embedded in another template?

name	back to summary
public String name

nativeGroup	back to summary
public STGroup nativeGroup The group that physically defines this `ST` definition. We use it to initiate interpretation via `ST#toString`. From there, it becomes field `Interpreter#group` and is fixed until rendering completes.

numberOfArgsWithDefaultValues	back to summary
public int numberOfArgsWithDefaultValues

prefix back to summary

prefix	back to summary
public String prefix Every template knows where it is relative to the group that loaded it. The prefix is the relative path from the root. `"/prefix/name"` is the fully qualified name of this template. All calls to `STGroup#getInstanceOf` calls must use fully qualified names. A `"/"` is added to the front if you don't specify one. Template references within template code, however, uses relative names, unless of course the name starts with `"/"`. This has nothing to do with the outer filesystem path to the group dir or group file. We set this as we load/compile the template. Always ends with `"/"`.

public String prefix

Every template knows where it is relative to the group that loaded it. The prefix is the relative path from the root. "/prefix/name" is the fully qualified name of this template. All calls to STGroup#getInstanceOf calls must use fully qualified names. A "/" is added to the front if you don't specify one. Template references within template code, however, uses relative names, unless of course the name starts with "/".

This has nothing to do with the outer filesystem path to the group dir or group file.

We set this as we load/compile the template.

Always ends with "/".

regionDefType back to summary

regionDefType	back to summary
public ST.RegionType regionDefType If someone refs `<@r()>` in template t, an implicit `@t.r() ::= ""` is defined, but you can overwrite this def by defining your own. We need to prevent more than one manual def though. Between this var and `isRegion` we can determine these cases.

public ST.RegionType regionDefType

If someone refs <@r()> in template t, an implicit

@t.r() ::= ""

is defined, but you can overwrite this def by defining your own. We need to prevent more than one manual def though. Between this var and isRegion we can determine these cases.

sourceMap	back to summary
public Interval[] sourceMap

strings	back to summary
public String[] strings

template	back to summary
public String template The original, immutable pattern (not really used again after initial "compilation"). Useful for debugging. Even for subtemplates, this is entire overall template.

templateDefStartToken	back to summary
public Token templateDefStartToken The token that begins template definition; could be `<@r>` of region.

tokens	back to summary
public TokenStream tokens Overall token stream for template (debug only).

Constructor Detail

CompiledST	back to summary
public CompiledST()

Method Detail

addArg	back to summary
public void addArg(FormalArgument a) Used by `ST#add` to add args one by one without turning on full formal args definition signal.

addImplicitlyDefinedTemplate	back to summary
public void addImplicitlyDefinedTemplate(CompiledST sub)

clone back to summary

clone	back to summary
public CompiledST clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Cloning the `CompiledST` for an `ST` instance allows `ST#add` to be called safely during interpretation for templates that do not contain formal arguments. Returns:CompiledST A copy of the current `CompiledST` instance. The copy is a shallow copy, with the exception of the `formalArguments` field which is also cloned. Annotations @Override Exceptions CloneNotSupportedException: If the current instance cannot be cloned.

public CompiledST clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Cloning the CompiledST for an ST instance allows ST#add to be called safely during interpretation for templates that do not contain formal arguments.

Returns:CompiledST

A copy of the current CompiledST instance. The copy is a shallow copy, with the exception of the formalArguments field which is also cloned.

Annotations

@Override

Exceptions

CloneNotSupportedException:: If the current instance cannot be cloned.

defineArgDefaultValueTemplates	back to summary
public void defineArgDefaultValueTemplates(STGroup group)

defineFormalArgs	back to summary
public void defineFormalArgs(List<FormalArgument> args)

defineImplicitlyDefinedTemplates	back to summary
public void defineImplicitlyDefinedTemplates(STGroup group)

disasm	back to summary
public String disasm()

dump	back to summary
public void dump()

getTemplateRange	back to summary
public Interval getTemplateRange()

getTemplateSource	back to summary
public String getTemplateSource()