StringTemplate 4 4.3.4 · org.stringtemplate.v4.Interpreter

Modifier and Type	Class and Description
protected static class	Interpreter.ArgumentsMap
protected static class	Interpreter.ObjectList
public static enum	Interpreter.Option

Modifier and Type	Field and Description
public boolean	debug When `true`, track events inside templates and in `events`.
public static final int	DEFAULT_OPERAND_STACK_SIZE
pack-priv ErrorManager	errMgr
protected List<InterpEvent>	events Track everything happening in interpreter across all templates if `debug`.
protected List<String>	executeTrace If `trace` is `true`, track trace here.
pack-priv STGroup	group Render template with respect to this group.
pack-priv Locale	locale For renderers, we have to pass in the locale.
pack-priv int	nwline The number of characters written on this template line so far.
pack-priv Object[]	operands Operand stack, grows upwards.
public static final Set<String>	predefinedAnonSubtemplateAttributes
pack-priv int	sp Stack pointer register.
public static boolean	trace Dump bytecode instructions as they are executed.

Access	Constructor and Description
public	Interpreter(STGroup group, boolean debug)
public	Interpreter(STGroup group, Locale locale, boolean debug)
public	Interpreter(STGroup group, ErrorManager errMgr, boolean debug)
public	Interpreter(STGroup group, Locale locale, ErrorManager errMgr, boolean debug)

Method Summary

Modifier and Type	Method and Description
protected int	_exec(STWriter out, InstanceScope scope)
protected void	addToList(InstanceScope scope, List<Object> list, Object o)
public Object	convertAnythingIteratableToIterator(InstanceScope scope, Object o)
public Iterator<?>	convertAnythingToIterator(InstanceScope scope, Object o)
public int	Returns: the number of characters written to `out` exec(STWriter out, InstanceScope scope) Execute template `self` and return how many characters it wrote to `out`.
public Object	first(InstanceScope scope, Object v) Return the first attribute if multi-valued, or the attribute itself if single-valued.
public Object	getAttribute(InstanceScope scope, String name) Find an attribute via dynamic scoping up enclosing scope chain.
public Object	getDictionary(STGroup g, String name)
public static List<ST>	getEnclosingInstanceStack(InstanceScope scope, boolean topdown)
public static String	getEnclosingInstanceStackString(InstanceScope scope) If an instance of x is enclosed in a y which is in a z, return a `String` of these instance names in order from topmost to lowest; here that would be `[z y x]`.
public static List<EvalTemplateEvent>	getEvalTemplateEventStack(InstanceScope scope, boolean topdown)
public List<InterpEvent>	getEvents()
public List<String>	getExecutionTrace()
protected int	getExprStartChar(InstanceScope scope)
protected int	getExprStopChar(InstanceScope scope)
protected Object	getObjectProperty(STWriter out, InstanceScope scope, Object o, Object property)
public static List<InstanceScope>	getScopeStack(InstanceScope scope, boolean topdown)
public static int	getShort(byte[] memory, int index)
protected void	indent(STWriter out, InstanceScope scope, int strIndex)
public Object	last(InstanceScope scope, Object v) Return the last attribute if multi-valued, or the attribute itself if single-valued.
public Object	length(Object v) Return the length of a multi-valued attribute or 1 if it is a single attribute.
pack-priv void	load_str(ST self, int ip)
protected void	map(InstanceScope scope, Object attr, final ST st)
pack-priv void	passthru(InstanceScope scope, String templateName, Map<String, Object> attrs)
protected void	printForTrace(StringBuilder tr, InstanceScope scope, Object o)
private <T> String	renderObject(InstanceScope scope, String formatString, Object o, Class<T> attributeType)
public Object	rest(InstanceScope scope, Object v) Return everything but the first attribute if multi-valued, or `null` if single-valued.
public Object	reverse(InstanceScope scope, Object v) Return a list with the same elements as `v` but in reverse order.
protected void	rot_map(InstanceScope scope, Object attr, List<ST> prototypes) Renders expressions of the form `<names:a()>` or `<names:a(),b()>`.
protected List<ST>	rot_map_iterator(InstanceScope scope, Iterator<?> attr, List<ST> prototypes)
public void	setDefaultArguments(STWriter out, InstanceScope scope) Set any default argument values that were not set by the invoking template or by `ST#add` directly.
protected void	setFirstArgument(InstanceScope scope, ST st, Object attr)
pack-priv void	storeArgs(InstanceScope scope, Map<String, Object> attrs, ST st)
pack-priv void	storeArgs(InstanceScope scope, int nargs, ST st)
public Object	strip(InstanceScope scope, Object v) Return a new list without `null` values.
pack-priv void	super_new(InstanceScope scope, String name, int nargs)
pack-priv void	super_new(InstanceScope scope, String name, Map<String, Object> attrs)
protected boolean	testAttributeTrue(Object a)
protected String	toString(STWriter out, InstanceScope scope, Object value)
protected void	trace(InstanceScope scope, int ip)
protected void	trackDebugEvent(InstanceScope scope, InterpEvent e) For every event, we track in overall `events` list and in `self`'s `InstanceScope#events` list so that each template has a list of events used to create it.
public Object	trunc(InstanceScope scope, Object v) Return all but the last element.
protected int	writeIterator(STWriter out, InstanceScope scope, Object o, String[] options)
protected int	writeObject(STWriter out, InstanceScope scope, Object o, String[] options) Generic method to emit text for an object.
protected int	writeObjectNoOptions(STWriter out, InstanceScope scope, Object o) Write out an expression result that doesn't use expression options.
protected int	writeObjectWithOptions(STWriter out, InstanceScope scope, Object o, Object[] options) Write out an expression result that uses expression options.
protected int	writePOJO(STWriter out, InstanceScope scope, Object o, String[] options)
protected ST.AttributeList	zip_map(InstanceScope scope, List<Object> exprs, ST prototype) Renders expressions of the form `<names,phones:{n,p \| ...}>` or `<a,b:t()>`.

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

Field Detail

debug	back to summary
public boolean debug When `true`, track events inside templates and in `events`.

DEFAULT_OPERAND_STACK_SIZE	back to summary
public static final int DEFAULT_OPERAND_STACK_SIZE

errMgr	back to summary
pack-priv ErrorManager errMgr

events	back to summary
protected List<InterpEvent> events Track everything happening in interpreter across all templates if `debug`. The last event in this field is the `EvalTemplateEvent` for the root template.

executeTrace	back to summary
protected List<String> executeTrace If `trace` is `true`, track trace here.

group back to summary

group	back to summary
pack-priv STGroup group Render template with respect to this group. See Also `ST#groupThatCreatedThisInstance`, `CompiledST#nativeGroup`

pack-priv STGroup group

Render template with respect to this group.

See Also: ST#groupThatCreatedThisInstance, CompiledST#nativeGroup

locale	back to summary
pack-priv Locale locale For renderers, we have to pass in the locale.

nwline	back to summary
pack-priv int nwline The number of characters written on this template line so far.

operands	back to summary
pack-priv Object[] operands Operand stack, grows upwards.

predefinedAnonSubtemplateAttributes	back to summary
public static final Set<String> predefinedAnonSubtemplateAttributes

sp	back to summary
pack-priv int sp Stack pointer register.

trace	back to summary
public static boolean trace Dump bytecode instructions as they are executed. This field is mostly for StringTemplate development.

Constructor Detail

Interpreter	back to summary
public Interpreter(STGroup group, boolean debug)

Interpreter	back to summary
public Interpreter(STGroup group, Locale locale, boolean debug)

Interpreter	back to summary
public Interpreter(STGroup group, ErrorManager errMgr, boolean debug)

Interpreter	back to summary
public Interpreter(STGroup group, Locale locale, ErrorManager errMgr, boolean debug)

Method Detail

_exec	back to summary
protected int _exec(STWriter out, InstanceScope scope)

addToList	back to summary
protected void addToList(InstanceScope scope, List<Object> list, Object o)

convertAnythingIteratableToIterator	back to summary
public Object convertAnythingIteratableToIterator(InstanceScope scope, Object o)

convertAnythingToIterator	back to summary
public Iterator<?> convertAnythingToIterator(InstanceScope scope, Object o)

exec back to summary

exec	back to summary
public int exec(STWriter out, InstanceScope scope) Execute template `self` and return how many characters it wrote to `out`. Returns:int the number of characters written to `out`

public int exec(STWriter out, InstanceScope scope)

Execute template self and return how many characters it wrote to out.

Returns:int: the number of characters written to out

first back to summary

first	back to summary
public Object first(InstanceScope scope, Object v) Return the first attribute if multi-valued, or the attribute itself if single-valued. This method is used for rendering expressions of the form `<names:first()>`.

public Object first(InstanceScope scope, Object v)

Return the first attribute if multi-valued, or the attribute itself if single-valued.

This method is used for rendering expressions of the form <names:first()>.

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(InstanceScope scope, String name) Find an attribute via dynamic scoping up enclosing scope chain. Only look for a dictionary definition if the attribute is not found, so attributes sent in to a template override dictionary names. Return `ST#EMPTY_ATTR` if found definition but no value.

public Object getAttribute(InstanceScope scope, String name)

Find an attribute via dynamic scoping up enclosing scope chain. Only look for a dictionary definition if the attribute is not found, so attributes sent in to a template override dictionary names.

Return ST#EMPTY_ATTR if found definition but no value.

getDictionary	back to summary
public Object getDictionary(STGroup g, String name)

getEnclosingInstanceStack	back to summary
public static List<ST> getEnclosingInstanceStack(InstanceScope scope, boolean topdown)

getEnclosingInstanceStackString	back to summary
public static String getEnclosingInstanceStackString(InstanceScope scope) If an instance of x is enclosed in a y which is in a z, return a `String` of these instance names in order from topmost to lowest; here that would be `[z y x]`.

getEvalTemplateEventStack	back to summary
public static List<EvalTemplateEvent> getEvalTemplateEventStack(InstanceScope scope, boolean topdown)

getEvents	back to summary
public List<InterpEvent> getEvents()

getExecutionTrace	back to summary
public List<String> getExecutionTrace()

getExprStartChar	back to summary
protected int getExprStartChar(InstanceScope scope)

getExprStopChar	back to summary
protected int getExprStopChar(InstanceScope scope)

getObjectProperty	back to summary
protected Object getObjectProperty(STWriter out, InstanceScope scope, Object o, Object property)

getScopeStack	back to summary
public static List<InstanceScope> getScopeStack(InstanceScope scope, boolean topdown)

getShort	back to summary
public static int getShort(byte[] memory, int index)

indent	back to summary
protected void indent(STWriter out, InstanceScope scope, int strIndex)

last back to summary

last	back to summary
public Object last(InstanceScope scope, Object v) Return the last attribute if multi-valued, or the attribute itself if single-valued. Unless it's a `List` or array, this is pretty slow as it iterates until the last element. This method is used for rendering expressions of the form `<names:last()>`.

public Object last(InstanceScope scope, Object v)

Return the last attribute if multi-valued, or the attribute itself if single-valued. Unless it's a List or array, this is pretty slow as it iterates until the last element.

This method is used for rendering expressions of the form <names:last()>.

length back to summary

length	back to summary
public Object length(Object v) Return the length of a multi-valued attribute or 1 if it is a single attribute. If `v` is `null` return 0. The implementation treats several common collections and arrays as special cases for speed.

public Object length(Object v)

Return the length of a multi-valued attribute or 1 if it is a single attribute. If v is null return 0.

The implementation treats several common collections and arrays as special cases for speed.

load_str	back to summary
pack-priv void load_str(ST self, int ip)

map	back to summary
protected void map(InstanceScope scope, Object attr, final ST st)

passthru	back to summary
pack-priv void passthru(InstanceScope scope, String templateName, Map<String, Object> attrs)

printForTrace	back to summary
protected void printForTrace(StringBuilder tr, InstanceScope scope, Object o)

renderObject	back to summary
private <T> String renderObject(InstanceScope scope, String formatString, Object o, Class<T> attributeType)

rest	back to summary
public Object rest(InstanceScope scope, Object v) Return everything but the first attribute if multi-valued, or `null` if single-valued.

reverse back to summary

reverse	back to summary
public Object reverse(InstanceScope scope, Object v) Return a list with the same elements as `v` but in reverse order. Note that `null` values are not stripped out; use `reverse(strip(v))` to do that.

public Object reverse(InstanceScope scope, Object v)

Return a list with the same elements as v but in reverse order.

Note that null values are not stripped out; use reverse(strip(v)) to do that.

rot_map	back to summary
protected void rot_map(InstanceScope scope, Object attr, List<ST> prototypes) Renders expressions of the form `<names:a()>` or `<names:a(),b()>`.

rot_map_iterator	back to summary
protected List<ST> rot_map_iterator(InstanceScope scope, Iterator<?> attr, List<ST> prototypes)

setDefaultArguments back to summary

public void setDefaultArguments(STWriter out, InstanceScope scope)

Set any default argument values that were not set by the invoking template or by ST#add directly. Note that the default values may be templates.

The evaluation context is the invokedST template itself so template default arguments can see other arguments.

setFirstArgument	back to summary
protected void setFirstArgument(InstanceScope scope, ST st, Object attr)

storeArgs	back to summary
pack-priv void storeArgs(InstanceScope scope, Map<String, Object> attrs, ST st)

storeArgs	back to summary
pack-priv void storeArgs(InstanceScope scope, int nargs, ST st)

strip	back to summary
public Object strip(InstanceScope scope, Object v) Return a new list without `null` values.

super_new	back to summary
pack-priv void super_new(InstanceScope scope, String name, int nargs)

super_new	back to summary
pack-priv void super_new(InstanceScope scope, String name, Map<String, Object> attrs)

testAttributeTrue	back to summary
protected boolean testAttributeTrue(Object a)

toString	back to summary
protected String toString(STWriter out, InstanceScope scope, Object value)

trace	back to summary
protected void trace(InstanceScope scope, int ip)

trackDebugEvent	back to summary
protected void trackDebugEvent(InstanceScope scope, InterpEvent e) For every event, we track in overall `events` list and in `self`'s `InstanceScope#events` list so that each template has a list of events used to create it. If `e` is an `EvalTemplateEvent`, store in parent's `InstanceScope#childEvalTemplateEvents` list for `STViz` tree view.

trunc	back to summary
public Object trunc(InstanceScope scope, Object v) Return all but the last element. `trunc(x)==null` if `x` is single-valued.

writeIterator	back to summary
protected int writeIterator(STWriter out, InstanceScope scope, Object o, String[] options) throws IOException

writeObject	back to summary
protected int writeObject(STWriter out, InstanceScope scope, Object o, String[] options) Generic method to emit text for an object. It differentiates between templates, iterable objects, and plain old Java objects (POJOs)

writeObjectNoOptions	back to summary
protected int writeObjectNoOptions(STWriter out, InstanceScope scope, Object o) Write out an expression result that doesn't use expression options. E.g., `<name>`

writeObjectWithOptions	back to summary
protected int writeObjectWithOptions(STWriter out, InstanceScope scope, Object o, Object[] options) Write out an expression result that uses expression options. E.g., `<names; separator=", ">`

writePOJO	back to summary
protected int writePOJO(STWriter out, InstanceScope scope, Object o, String[] options) throws IOException

zip_map	back to summary
protected ST.AttributeList zip_map(InstanceScope scope, List<Object> exprs, ST prototype) Renders expressions of the form `<names,phones:{n,p \| ...}>` or `<a,b:t()>`.

Modifier and Type	Field and Description
public static final Interpreter.Option	ANCHOR
public static final Interpreter.Option	FORMAT
public static final Interpreter.Option	NULL
public static final Interpreter.Option	SEPARATOR
public static final Interpreter.Option	WRAP

Modifier and Type	Method and Description
public static Interpreter.Option	valueOf(String name)
public static Interpreter.Option[]	values()

public Class Interpreter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Interpreter.ArgumentsMap

Constructor Summary

Method Summary

Constructor Detail

protected Class Interpreter.ObjectList

Constructor Summary

Method Summary

Constructor Detail

public final Enum Interpreter.Option

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail