An instance of the StringTemplate. It consists primarily of a reference to its implementation (shared among all instances) and a hash table of attributes. Because of dynamic scoping, we also need a reference to any enclosing instance. For example, in a deeply nested template for an HTML page body, we could still reference the title attribute defined in the outermost page template.

To use templates, you create one (usually via STGroup) and then inject attributes using add. To render its attacks, use ST#render().

Todo

ST#locals is not actually a hash table like the documentation says.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ST.AttributeList Just an alias for `ArrayList`, but this way I can track whether a list is something ST created or it's an incoming list.
public static class	ST.DebugState Events during template hierarchy construction (not evaluation)
public static enum	ST.RegionType `<@r()>`, `<@r>...`

Field Summary

Modifier and Type	Field and Description
public ST.DebugState	debugState If `STGroup#trackCreationEvents`, track creation and add attribute events for each object.
public static final Object	EMPTY_ATTR
public STGroup	groupThatCreatedThisInstance Created as instance of which group?
public CompiledST	impl The implementation for this template among all instances of same template .
public static final String	IMPLICIT_ARG_NAME When there are no formal args for template t and you map t across some values, t implicitly gets arg "it".
protected Object[]	locals Safe to simultaneously write via `add`, which is synchronized.
public static final String	UNKNOWN_NAME
public static final String	VERSION

Constructor Summary

Access	Constructor and Description
protected	ST() Used by group creation routine, not by users
public	ST(String template) Used to make templates inline in code for simple things like SQL or log records.
public	ST(String template, char delimiterStartChar, char delimiterStopChar) Create ST using non-default delimiters; each one of these will live in it's own group since you're overriding a default; don't want to alter `STGroup#defaultGroup`.
public	ST(STGroup group, String template)
public	ST(ST proto) Clone a prototype template.

Method Summary

Modifier and Type	Method and Description
public synchronized ST	add(String name, Object value) Inject an attribute (name/value pair).
public synchronized ST	addAggr(String aggrSpec, Object... values) Split `aggrName.{propName1,propName2}` into list `[propName1, propName2]` and the `aggrName`.
protected static ST.AttributeList	convertToAttributeList(Object curvalue)
public static String	format(String template, Object... attributes) ST.format("<%1>:<%2>", n, p);
public static String	format(int lineWidth, String template, Object... attributes)
public Object	getAttribute(String name) Find an attribute in this template only.
public Map<String, Object>	getAttributes()
public List<InterpEvent>	getEvents()
public List<InterpEvent>	getEvents(int lineWidth)
public List<InterpEvent>	getEvents(Locale locale)
public List<InterpEvent>	getEvents(Locale locale, int lineWidth)
public String	getName()
public STViz	inspect()
public STViz	inspect(int lineWidth)
public STViz	inspect(Locale locale)
public STViz	inspect(ErrorManager errMgr, Locale locale, int lineWidth)
public boolean	isAnonSubtemplate()
protected void	rawSetAttribute(String name, Object value) Set `locals` attribute value when you only know the name, not the index.
public void	remove(String name) Remove an attribute value entirely (can't remove attribute definitions).
public String	render()
public String	render(int lineWidth)
public String	render(Locale locale)
public String	render(Locale locale, int lineWidth)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public int	write(STWriter out)
public int	write(STWriter out, Locale locale)
public int	write(STWriter out, STErrorListener listener)
public int	write(STWriter out, Locale locale, STErrorListener listener)
public int	write(File outputFile, STErrorListener listener)
public int	write(File outputFile, STErrorListener listener, String encoding)
public int	write(File outputFile, STErrorListener listener, String encoding, int lineWidth)
public int	write(File outputFile, STErrorListener listener, String encoding, Locale locale, int lineWidth)

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

Field Detail

debugState	back to summary
public ST.DebugState debugState If `STGroup#trackCreationEvents`, track creation and add attribute events for each object. Create this object on first use.

EMPTY_ATTR	back to summary
public static final Object EMPTY_ATTR

groupThatCreatedThisInstance back to summary

groupThatCreatedThisInstance	back to summary
public STGroup groupThatCreatedThisInstance Created as instance of which group? We need this to initialize interpreter via render. So, we create st and then it needs to know which group created it for sake of polymorphism: st = skin1.getInstanceOf("searchbox"); result = st.render(); // knows skin1 created it Say we have a group `g1` with template `t` that imports templates `t` and `u` from another group `g2`. `g1.getInstanceOf("u")` finds `u` in `g2` but remembers that `g1` created it. If `u` includes `t`, it should create `g1.t` not `g2.t`. g1 = {t(), u()} \| v g2 = {t()}

public STGroup groupThatCreatedThisInstance

Created as instance of which group? We need this to initialize interpreter via render. So, we create st and then it needs to know which group created it for sake of polymorphism:

st = skin1.getInstanceOf("searchbox");
result = st.render(); // knows skin1 created it

Say we have a group g1 with template t that imports templates t and u from another group g2. g1.getInstanceOf("u") finds u in g2 but remembers that g1 created it. If u includes t, it should create g1.t not g2.t.

 g1 = {t(), u()}
 |
 v
 g2 = {t()}

impl	back to summary
public CompiledST impl The implementation for this template among all instances of same template .

IMPLICIT_ARG_NAME	back to summary
public static final String IMPLICIT_ARG_NAME When there are no formal args for template t and you map t across some values, t implicitly gets arg "it". E.g., "$it$"

locals	back to summary
protected Object[] locals Safe to simultaneously write via `add`, which is synchronized. Reading during exec is, however, NOT synchronized. So, not thread safe to add attributes while it is being evaluated. Initialized to `EMPTY_ATTR` to distinguish `null` from empty.

UNKNOWN_NAME	back to summary
public static final String UNKNOWN_NAME

VERSION	back to summary
public static final String VERSION

Constructor Detail

ST	back to summary
protected ST() Used by group creation routine, not by users

ST	back to summary
public ST(String template) Used to make templates inline in code for simple things like SQL or log records. No formal arguments are set and there is no enclosing instance.

ST	back to summary
public ST(String template, char delimiterStartChar, char delimiterStopChar) Create ST using non-default delimiters; each one of these will live in it's own group since you're overriding a default; don't want to alter `STGroup#defaultGroup`.

ST	back to summary
public ST(STGroup group, String template)

ST	back to summary
public ST(ST proto) Clone a prototype template. Copy all fields minus `debugState`; don't delegate to `ST()`, which creates `ConstructionEvent`.

Method Detail

add back to summary

add	back to summary
public synchronized ST add(String name, Object value) Inject an attribute (name/value pair). If there is already an attribute with that name, this method turns the attribute into an `AttributeList` with both the previous and the new attribute as elements. This method will never alter a `List` that you inject. If you send in a `List` and then inject a single value element, `add` copies original list and adds the new value. The attribute name cannot be null or contain '.'. Return `this` so we can chain: `t.add("x", 1).add("y", "hi")`

public synchronized ST add(String name, Object value)

Inject an attribute (name/value pair). If there is already an attribute with that name, this method turns the attribute into an AttributeList with both the previous and the new attribute as elements. This method will never alter a List that you inject. If you send in a List and then inject a single value element, add copies original list and adds the new value. The attribute name cannot be null or contain '.'.

Return this so we can chain:

t.add("x", 1).add("y", "hi")

addAggr	back to summary
public synchronized ST addAggr(String aggrSpec, Object... values) Split `aggrName.{propName1,propName2}` into list `[propName1, propName2]` and the `aggrName`. Spaces are allowed around `','`.

convertToAttributeList	back to summary
protected static ST.AttributeList convertToAttributeList(Object curvalue)

format	back to summary
public static String format(String template, Object... attributes) ST.format("<%1>:<%2>", n, p);

format	back to summary
public static String format(int lineWidth, String template, Object... attributes)

getAttribute	back to summary
public Object getAttribute(String name) Find an attribute in this template only.

getAttributes	back to summary
public Map<String, Object> getAttributes()

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

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

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

getEvents	back to summary
public List<InterpEvent> getEvents(Locale locale, int lineWidth)

getName	back to summary
public String getName()

inspect	back to summary
public STViz inspect()

inspect	back to summary
public STViz inspect(int lineWidth)

inspect	back to summary
public STViz inspect(Locale locale)

inspect	back to summary
public STViz inspect(ErrorManager errMgr, Locale locale, int lineWidth)

isAnonSubtemplate	back to summary
public boolean isAnonSubtemplate()

rawSetAttribute	back to summary
protected void rawSetAttribute(String name, Object value) Set `locals` attribute value when you only know the name, not the index. This is ultimately invoked by calling `ST#add` from outside so toss an exception to notify them.

remove	back to summary
public void remove(String name) Remove an attribute value entirely (can't remove attribute definitions).

render	back to summary
public String render()

render	back to summary
public String render(int lineWidth)

render	back to summary
public String render(Locale locale)

render	back to summary
public String render(Locale locale, int lineWidth)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

write	back to summary
public int write(STWriter out) throws IOException

write	back to summary
public int write(STWriter out, Locale locale)

write	back to summary
public int write(STWriter out, STErrorListener listener)

write	back to summary
public int write(STWriter out, Locale locale, STErrorListener listener)

write	back to summary
public int write(File outputFile, STErrorListener listener) throws IOException

write	back to summary
public int write(File outputFile, STErrorListener listener, String encoding) throws IOException

write	back to summary
public int write(File outputFile, STErrorListener listener, String encoding, int lineWidth) throws IOException

write	back to summary
public int write(File outputFile, STErrorListener listener, String encoding, Locale locale, int lineWidth) throws IOException

org.stringtemplate.v4 back to summary

public final Class ST.AttributeList

Class Inheritance

extends ArrayList<Object>

Just an alias for ArrayList, but this way I can track whether a list is something ST created or it's an incoming list.

Constructor Summary

Access	Constructor and Description
public	AttributeList(int size)
public	AttributeList()

Method Summary

Constructor Detail

AttributeList	back to summary
public AttributeList(int size)

AttributeList	back to summary
public AttributeList()

org.stringtemplate.v4 back to summary

public Class ST.DebugState

Class Inheritance

extends Object

java.lang.Object
org.stringtemplate.v4.ST.DebugState

Events during template hierarchy construction (not evaluation)

Field Summary

Modifier and Type	Field and Description
public MultiMap<String, AddAttributeEvent>	addAttrEvents Track construction-time add attribute "events"; used for ST user-level debugging
public ConstructionEvent	newSTEvent Record who made us?

Constructor Summary

Access	Constructor and Description
public	DebugState()

Method Summary

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

Field Detail

addAttrEvents	back to summary
public MultiMap<String, AddAttributeEvent> addAttrEvents Track construction-time add attribute "events"; used for ST user-level debugging

newSTEvent	back to summary
public ConstructionEvent newSTEvent Record who made us? `ConstructionEvent` creates `Exception` to grab stack

Constructor Detail

DebugState	back to summary
public DebugState()

org.stringtemplate.v4 back to summary

public final Enum ST.RegionType

Class Inheritance

extends Enum<ST.RegionType>

java.lang.Object
java.lang.Enum
org.stringtemplate.v4.ST.RegionType

<@r()>, <@r>...<@end>, and @t.r() ::= "..." defined manually by coder

Field Summary

Modifier and Type	Field and Description
public static final ST.RegionType	EMBEDDED `<@r>...`
public static final ST.RegionType	EXPLICIT `@t.r() ::= "..."`
public static final ST.RegionType	IMPLICIT `<@r()>`

Constructor Summary

Access	Constructor and Description
private	RegionType()

Method Summary

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

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EMBEDDED	back to summary
public static final ST.RegionType EMBEDDED `<@r>...<@end>`

EXPLICIT	back to summary
public static final ST.RegionType EXPLICIT `@t.r() ::= "..."`

IMPLICIT	back to summary
public static final ST.RegionType IMPLICIT `<@r()>`

Constructor Detail

RegionType	back to summary
private RegionType()

Method Detail

valueOf	back to summary
public static ST.RegionType valueOf(String name)

values	back to summary
public static ST.RegionType[] values()