<p>Javadocs from
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">
http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html</a><br>
2009-05-24. StringTemplateGroup presumably version 3.2 and current, but no date or version number shown<br>
See annotations by GW in <font color="#CC0000">red</font>, or search for [GW] to find them.</p>
<hr>
<h2><font size="-1">org.antlr.stringtemplate</font> <br>
Class StringTemplateGroup</h2>
<pre>java.lang.Object
<img src="http://www.stringtemplate.org/api/resources/inherit.gif" alt="extended by"><b>org.antlr.stringtemplate.StringTemplateGroup</b></pre>
<hr>
<dl>
<h2>Overview of StringTemplateGroup</h2>
<p><font color="#CC0000">Note: There are really two separate sets of constructors for this class,
corresponding to two somewhat different modes of operation. The overview blurb has been expanded
over the time these features were added, and some of it applies to one mode but not the other,
hence some confusion.</font></p>
<table border="1" cellpadding="4" style="border-collapse: collapse" width="100%" cellspacing="0"
bordercolor="#C0C0C0" id="table6">
<tr>
<td valign="top" bgcolor="#DDDDDD"><b>Java doc says...</b></td>
<td valign="top" bgcolor="#DDDDDD"><font color="#CC0000"><b>[GW] Comments</b></font></td>
</tr>
<tr>
<td valign="top">Manages a group of named mutually-referential StringTemplate objects. </td>
<td valign="top"><font color="#CC0000">Ie: a group of StringTemplate objects having a name field. These
StringTemplates can refer to each other using these names (but are not required to refer to each
other of course).</font></td>
</tr>
<tr>
<td valign="top"> Currently the templates must all live under a directory so that you can
reference them as foo.st or gutter/header.st. </td>
<td valign="top"><font color="#CC0000">That's one way. Since that was written, this class has
been revised to support StringTemplateGroup files (xxx.stg) which work differently.</font></td>
</tr>
<tr>
<td valign="top">To refresh a group of templates, just create a new StringTemplateGroup and start
pulling templates from there.</td>
<td valign="top"><font color="#CC0000">"Refresh" means to deal with the situation where templates
have been loaded from individual *.st files, and those files have been independently changed, and now we want
our StringTemplate objects to reflect the changed template texts. The comment here says to
refresh the existing StringTemplate objects by creating a new StringTemplateGroup etc
from scratch. (A parallel approach would work with an stg file too).</font></td>
</tr>
<tr>
<td valign="top">Or, set the refresh interval.</td>
<td valign="top"><font color="#CC0000">...so that the refreshing happens automatically. (Not
applicable to stg files.)</font></td>
</tr>
<tr>
<td valign="top">Use getInstanceOf(template-name) to get a string template to fill in. </td>
<td valign="top"><font color="#CC0000">Not sure if these means the caller is not supposed to
directly apply
the StringTemplate objects that are in the STG, but maybe the point is that the STG can act as a
longer-term holder of StringTemplates that your program wants to use multiple times with
different attribute values... and hence should work with copies. (Also if refresh is enabled,
the templates in the STG might get disrupted?) "Fill in" meaning "supply
attributes/values to.".</font></td>
</tr>
<tr>
<td valign="top">The name of a template is the file name minus ".st" ending if present unless you
name it as you load it. </td>
<td valign="top"><font color="#CC0000">"name it as you load it": using what method(s)? Also this
is not applicable to the
xxx.stg mode of operation.</font></td>
</tr>
<tr>
<td valign="top">You can use the group file format also to define a group of templates (this
works better for code gen than for html page gen). </td>
<td valign="top"><font color="#CC0000">stg format is now getting mentioned here, which makes this
intro blurb a bit muddled, since other parts don't apply to stg but aren't clear about that.</font></td>
</tr>
<tr>
<td valign="top">You must give a Reader to the ctor for it to load the group; this is general and
distinguishes it from the ctors for the old-style "load template files from the disk".</td>
<td valign="top"><font color="#CC0000">Ie: What distinguishes the stg-suitable constructors is
that they require a Reader argument. The constructors suited to retrieving template texts from
*.st files don't have that pattern.</font></td>
</tr>
<tr>
<td valign="top">10/2005 I am adding a StringTemplateGroupLoader concept so people can define
supergroups within a group and have it load that group automatically.</td>
<td valign="top"><font color="#CC0000">Hmmm. This might mean as follows: Within a group <i>
file</i> (xxx.stg) use the syntax<br>
group mygroup: mysupergroup;<br>
... to specify a supergroup to inherit from. In this case the StringTemplate library should find
and load the supergroup file automatically, if your application implements a
StringTemplateGroupLoader object.</font></td>
</tr>
<tr>
<td valign="top"> </td>
<td valign="top"> </td>
</tr>
</table>
<hr>
<h2>Constructors</h2>
<dt>public class <b>StringTemplateGroup</b></dt>
<dt>extends java.lang.Object</dt>
</dl>
<table width="100%" border="1" cellpadding="3" cellspacing="0" id="table7"
style="border-collapse: collapse" bordercolor="#C0C0C0">
<tr class="TableHeadingColor" bgcolor="#ccccff">
<td valign="top"><b>Scheme</b></td>
<td valign="top"><b>Constructor Summary</b></td>
<td valign="top"> </td>
<td valign="top"><font color="#CC0000"><b>[GW] Comments</b></font></td>
</tr>
<tr>
<td valign="top" bgcolor="#DDDDDD"><b>xxx.stg file</b></td>
<td valign="top" bgcolor="#DDDDDD" colspan="3"><font color="#CC0000">The constructors in this
section load the contents of a StringTemplateGroup file (from a Reader), which contains one or
more template texts etc. (It's the presence of an initial Reader argument which selects a
constructor from this set of overloaded constructors.) (Or a template can be added from String
using StringTemplate constructors or defineTemplate).</font></td>
</tr>
<tr>
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.io.Reader,%20java.lang.Class,%20org.antlr.stringtemplate.StringTemplateErrorListener,%20org.antlr.stringtemplate.StringTemplateGroup%29">
StringTemplateGroup</a></b>(java.io.Reader r, java.lang.Class lexer,
<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">
StringTemplateErrorListener</a> errors, <a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">
StringTemplateGroup</a> superGroup)</code> <br>
Create a group from the input stream, but use a nondefault lexer to break the
templates up into chunks.</td>
<td valign="top">1</td>
<td valign="top"><font color="#CC0000">If lexer is null, uses AngleBracetTemplateLexer.<br>
Gets group name from "group" statement in template-group text from Reader.</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.io.Reader%29">
StringTemplateGroup</a></b>(java.io.Reader r)</code> <br>
Create a group from the template group defined by a input stream.</td>
<td valign="top">2</td>
<td valign="top"><font color="#CC0000">Calls 1 with subset of args</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.io.Reader,%20java.lang.Class%29">
StringTemplateGroup</a></b>(java.io.Reader r, java.lang.Class lexer)</code> <br>
</td>
<td valign="top">3</td>
<td valign="top"><font color="#CC0000">Calls 1 with subset of args</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.io.Reader,%20java.lang.Class,%20org.antlr.stringtemplate.StringTemplateErrorListener%29">
StringTemplateGroup</a></b>(java.io.Reader r, java.lang.Class lexer,
<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">
StringTemplateErrorListener</a> errors)</code> <br>
</td>
<td valign="top">4</td>
<td valign="top"><font color="#CC0000">Calls 1 with subset of args</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.io.Reader,%20org.antlr.stringtemplate.StringTemplateErrorListener%29">
StringTemplateGroup</a></b>(java.io.Reader r, <a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">
StringTemplateErrorListener</a> errors)</code> <br>
</td>
<td valign="top">5</td>
<td valign="top"><font color="#CC0000">Calls 1 with subset of args</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" bgcolor="#DDDDDD"><b>STGdir/*.st</b></td>
<td valign="top" bgcolor="#DDDDDD" colspan="3"><font color="#CC0000">The constructors in this
section prepare a StringTemplateGroup to load one or more individual StringTemplate files (xxx.st)
from a directory or CLASSPATH (Or a template can be added from a String using
StringTemplate constructors or defineTemplate).</font></td>
</tr>
<tr>
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.lang.String,%20java.lang.String,%20java.lang.Class%29">
StringTemplateGroup</a></b>(java.lang.String name, java.lang.String rootDir, java.lang.Class lexer)</code>
<br>
</td>
<td valign="top">6</td>
<td valign="top"><font color="#CC0000">If lexer is null, uses DefaultTemplateLexer (which
recognizes $...$).</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.lang.String,%20java.lang.Class%29">
StringTemplateGroup</a></b>(java.lang.String name, java.lang.Class lexer)</code> <br>
</td>
<td valign="top">7</td>
<td valign="top"><font color="#CC0000">Calls 6 with subset of args<br>
Also, this is the STG constructor called by StringTemplate(tmplname, lexer);</font></td>
</tr>
<tr>
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.lang.String,%20java.lang.String%29">
StringTemplateGroup</a></b>(java.lang.String name, java.lang.String rootDir)</code> <br>
Create a group manager for some templates, all of which are at or below the indicated
directory.</td>
<td valign="top">8</td>
<td valign="top"><font color="#CC0000">Calls 6 with subset of args</font><p> </td>
</tr>
<tr>
<td valign="top"> </td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#StringTemplateGroup%28java.lang.String%29">
StringTemplateGroup</a></b>(java.lang.String name)</code> <br>
Create a group manager for some templates, all of which are loaded as resources via
the classloader.</td>
<td valign="top">9</td>
<td valign="top"><font color="#CC0000">Calls 6 with subset of args. No group dir is
specified. I think "classloader" means the xxx.st files are found via java CLASSPATH. </font>
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top"> </td>
<td valign="top"> </td>
<td valign="top"> </td>
<td valign="top"> </td>
</tr>
</table>
<hr>
<h2>Methods</h2>
<table width="100%" border="1" cellpadding="3" cellspacing="0" id="table8"
style="border-collapse: collapse" bordercolor="#C0C0C0">
<tr class="TableHeadingColor" bgcolor="#ccccff">
<td valign="top" align="left"><font color="#CC0000"><b>Funcional area</b></font></td>
<td valign="top"><b>Method Summary</b></td>
<td valign="top"> </td>
<td valign="top"><font color="#CC0000"><b>[GW] Comments</b></font></td>
</tr>
<tr>
<td valign="top" align="left" colspan="4" bgcolor="#DDDDDD"><font color="#CC0000"><b>Normal
preparation</b></font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineTemplate%28java.lang.String,%20java.lang.String%29">
defineTemplate</a></b>(java.lang.String name, java.lang.String template)</code> <br>
Define an examplar template; precompiled and stored with no attributes.</td>
<td valign="top"><font color="#CC0000">Adds a named StringTemplate object to this STG, using the
template text provided, and no attributes. "Exemplar" probably means to NOT use this template
per se, but to use copies from getInstanceOf(tmpname)</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineMap%28java.lang.String,%20java.util.Map%29">
defineMap</a></b>(java.lang.String name, java.util.Map mapping)</code> <br>
Define a map for this group; not thread safe...do not keep adding these while you
reference them.</td>
<td valign="top"><font color="#CC0000">Add a map to this group. (Compare this with passing a
Map-implementing object to a template as an attribute.)</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getInstanceOf%28java.lang.String%29">
getInstanceOf</a></b>(java.lang.String name)</code> <br>
The primary means of getting an instance of a template from this group.</td>
<td valign="top"><font color="#CC0000">Get an instance of an ST for
actual invocation with particular attributes. Use with StringTemplate.setAttribute</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getInstanceOf%28java.lang.String,%20java.util.Map%29">
getInstanceOf</a></b>(java.lang.String name, java.util.Map attributes)</code> <br>
The primary means of getting an instance of a template from this group when you have a
predefined set of attributes you want to use.</td>
<td valign="top">Similar to getInstanceOf(name), but supply attributes at the same time.</td>
</tr>
<tr>
<td valign="top" align="left" colspan="4" bgcolor="#DDDDDD"><font color="#CC0000"><b>Renderers</b></font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#registerRenderer%28java.lang.Class,%20java.lang.Object%29">
registerRenderer</a></b>(java.lang.Class attributeClassType, java.lang.Object renderer)</code>
<br>
Register a renderer for all objects of a particular type for all templates in this
group.</td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setAttributeRenderers%28java.util.Map%29">
setAttributeRenderers</a></b>(java.util.Map renderers)</code> <br>
Specify a complete map of what object classes should map to which renderer objects for
every template in this group (that doesn't override it per template).</td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top" align="left" bgcolor="#DDDDDD" colspan="4"><font color="#CC0000"><b>Output filters</b></font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setStringTemplateWriter%28java.lang.Class%29">
setStringTemplateWriter</a></b>(java.lang.Class c)</code> <br>
Specify a StringTemplateWriter implementing class to use for filtering output</td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top" align="left" bgcolor="#DDDDDD" colspan="4"><font color="#CC0000"><b>Settings</b></font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setErrorListener%28org.antlr.stringtemplate.StringTemplateErrorListener%29">
setErrorListener</a></b>(<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">StringTemplateErrorListener</a> listener)</code>
<br>
</td>
<td valign="top"><font color="#CC0000">If not set, errors go to standard error, warnings to
standard out (and normally that will be the java console).</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setFileCharEncoding%28java.lang.String%29">
setFileCharEncoding</a></b>(java.lang.String fileCharEncoding)</code> </td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> void</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setRefreshInterval%28int%29">
setRefreshInterval</a></b>(int refreshInterval)</code> <br>
How often to refresh all templates from disk.</td>
<td valign="top"><font color="#CC0000">Only for *.st files, not for group files xxx.stg.</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#registerDefaultLexer%28java.lang.Class%29">
registerDefaultLexer</a></b>(java.lang.Class lexerClass)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Can be set once for all
StringTemplateGroups. (Note singleton)</font></td>
</tr>
<tr>
<td valign="top" align="left" bgcolor="#DDDDDD" colspan="4"><font color="#CC0000"><b>Diagnostic output</b></font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#toString%28%29">
toString</a></b>()</code> <br>
</td>
<td valign="top"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#toString%28boolean%29">
toString</a></b>(boolean showTemplatePatterns)</code> <br>
</td>
<td valign="top"><font color="#CC0000">Diagnostic? Patterns = template texts</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#doNotEmitDebugStringsForTemplate%28java.lang.String%29">
doNotEmitDebugStringsForTemplate</a></b>(java.lang.String templateName)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#emitDebugStartStopStrings%28boolean%29">
emitDebugStartStopStrings</a></b>(boolean emit)</code> <br>
Indicate whether ST should emit <templatename>...</templatename>
strings for debugging around output for templates from this group.</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#emitTemplateStartDebugString%28org.antlr.stringtemplate.StringTemplate,%20org.antlr.stringtemplate.StringTemplateWriter%29">
emitTemplateStartDebugString</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> st,
<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateWriter.html">
StringTemplateWriter</a> out)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr>
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#emitTemplateStopDebugString%28org.antlr.stringtemplate.StringTemplate,%20org.antlr.stringtemplate.StringTemplateWriter%29">
emitTemplateStopDebugString</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> st,
<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateWriter.html">
StringTemplateWriter</a> out)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" align="left" colspan="4" bgcolor="#DDDDDD"><font color="#CC0000"><b>Internal</b></font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#checkRefreshInterval%28%29">
checkRefreshInterval</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Does nothing for templates from stg
file.</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#createStringTemplate%28%29">
createStringTemplate</a></b>()</code> <br>
StringTemplate object factory; each group can have its own.</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Not intended to be part of API?</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineImplicitRegionTemplate%28org.antlr.stringtemplate.StringTemplate,%20java.lang.String%29">
defineImplicitRegionTemplate</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> enclosingTemplate,
java.lang.String name)</code> <br>
Track all references to regions <@foo()>.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineRegionTemplate%28java.lang.String,%20java.lang.String,%20java.lang.String,%20int%29">
defineRegionTemplate</a></b>(java.lang.String enclosingTemplateName, java.lang.String regionName,
java.lang.String template, int type)</code> <br>
Track all references to regions <@foo>...<@end> or <@foo()>.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineRegionTemplate%28org.antlr.stringtemplate.StringTemplate,%20java.lang.String,%20java.lang.String,%20int%29">
defineRegionTemplate</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> enclosingTemplate,
java.lang.String regionName, java.lang.String template, int type)</code> <br>
Track all references to regions <@foo>...<@end> or <@foo()>.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defineTemplateAlias%28java.lang.String,%20java.lang.String%29">
defineTemplateAlias</a></b>(java.lang.String name, java.lang.String target)</code> <br>
Make name and alias for target.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#error%28java.lang.String%29">
error</a></b>(java.lang.String msg)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#error%28java.lang.String,%20java.lang.Exception%29">
error</a></b>(java.lang.String msg, java.lang.Exception e)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/AttributeRenderer.html">AttributeRenderer</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getAttributeRenderer%28java.lang.Class%29">
getAttributeRenderer</a></b>(java.lang.Class attributeClassType)</code> <br>
What renderer is registered for this attributeClassType for this group? If not found,
as superGroup if it has one.</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">as = ask</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getEmbeddedInstanceOf%28org.antlr.stringtemplate.StringTemplate,%20java.lang.String%29">
getEmbeddedInstanceOf</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> enclosingInstance,
java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">StringTemplateErrorListener</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getErrorListener%28%29">
getErrorListener</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getFileCharEncoding%28%29">
getFileCharEncoding</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getFileNameFromTemplateName%28java.lang.String%29">
getFileNameFromTemplateName</a></b>(java.lang.String templateName)</code> <br>
(public so that people can override behavior; not a general purpose method)</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getGroupHierarchyStackString%28%29">
getGroupHierarchyStackString</a></b>()</code> <br>
Walk up group hierarchy and show top down to this group</td>
<td valign="top" bgcolor="#EEEEFF"><font color="#CC0000">Diagnostic?</font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected java.io.InputStreamReader</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getInputStreamReader%28java.io.InputStream%29">
getInputStreamReader</a></b>(java.io.InputStream in)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getInstanceOf%28org.antlr.stringtemplate.StringTemplate,%20java.lang.String%29">
getInstanceOf</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> enclosingInstance,
java.lang.String name)</code> <br>
A support routine that gets an instance of name knowing which ST encloses it for error
messages.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getMangledRegionName%28java.lang.String,%20java.lang.String%29">
getMangledRegionName</a></b>(java.lang.String enclosingTemplateName, java.lang.String name)</code>
<br>
The "foo" of t() ::= "<@foo()>" is mangled to "region#t#foo"</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.util.Map</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getMap%28java.lang.String%29">
getMap</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getName%28%29">
getName</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> int</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getRefreshInterval%28%29">
getRefreshInterval</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getRootDir%28%29">
getRootDir</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateWriter.html">StringTemplateWriter</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getStringTemplateWriter%28java.io.Writer%29">
getStringTemplateWriter</a></b>(java.io.Writer w)</code> <br>
return an instance of a StringTemplateWriter that spits output to w.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getSuperGroup%28%29">
getSuperGroup</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getTemplateDefinition%28java.lang.String%29">
getTemplateDefinition</a></b>(java.lang.String name)</code> <br>
Get the ST for 'name' in this group only</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.Class</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getTemplateLexerClass%28%29">
getTemplateLexerClass</a></b>()</code> <br>
What lexer class to use to break up templates.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getTemplateNameFromFileName%28java.lang.String%29">
getTemplateNameFromFileName</a></b>(java.lang.String fileName)</code> <br>
Convert a filename relativePath/name.st to relativePath/name.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.util.Set</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getTemplateNames%28%29">
getTemplateNames</a></b>()</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> java.lang.String</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#getUnMangledTemplateName%28java.lang.String%29">
getUnMangledTemplateName</a></b>(java.lang.String mangledName)</code> <br>
Return "t" from "region__t__foo"</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#implementInterface%28java.lang.String%29">
implementInterface</a></b>(java.lang.String interfaceName)</code> <br>
Indicate that this group implements this interface; load if necessary if not in the
nameToInterfaceMap.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#implementInterface%28org.antlr.stringtemplate.StringTemplateGroupInterface%29">
implementInterface</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroupInterface.html">StringTemplateGroupInterface</a> I)</code>
<br>
Just track the new interface; check later.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> boolean</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#isDefined%28java.lang.String%29">
isDefined</a></b>(java.lang.String name)</code> <br>
Is there *any* definition for template 'name' in this template or above it in the
group hierarchy?</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> boolean</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#isDefinedInThisGroup%28java.lang.String%29">
isDefinedInThisGroup</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadGroup%28java.lang.String%29">
loadGroup</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadGroup%28java.lang.String,%20java.lang.Class,%20org.antlr.stringtemplate.StringTemplateGroup%29">
loadGroup</a></b>(java.lang.String name, java.lang.Class lexer,
<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">
StringTemplateGroup</a> superGroup)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadGroup%28java.lang.String,%20org.antlr.stringtemplate.StringTemplateGroup%29">
loadGroup</a></b>(java.lang.String name, <a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">
StringTemplateGroup</a> superGroup)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static <br>
<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroupInterface.html">
StringTemplateGroupInterface</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadInterface%28java.lang.String%29">
loadInterface</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadTemplate%28java.lang.String,%20java.io.BufferedReader%29">
loadTemplate</a></b>(java.lang.String name, java.io.BufferedReader r)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadTemplate%28java.lang.String,%20java.lang.String%29">
loadTemplate</a></b>(java.lang.String name, java.lang.String fileName)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#loadTemplateFromBeneathRootDirOrCLASSPATH%28java.lang.String%29">
loadTemplateFromBeneathRootDirOrCLASSPATH</a></b>(java.lang.String fileName)</code> <br>
Load a template whose name is derived from the template filename.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#lookupTemplate%28java.lang.String%29">
lookupTemplate</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#lookupTemplate%28org.antlr.stringtemplate.StringTemplate,%20java.lang.String%29">
lookupTemplate</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a> enclosingInstance,
java.lang.String name)</code> <br>
Get the template called 'name' from the group.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#parseGroup%28java.io.Reader%29">
parseGroup</a></b>(java.io.Reader r)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#registerGroupLoader%28org.antlr.stringtemplate.StringTemplateGroupLoader%29">
registerGroupLoader</a></b>(<a title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroupLoader.html">StringTemplateGroupLoader</a> loader)</code>
<br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setName%28java.lang.String%29">
setName</a></b>(java.lang.String name)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setRootDir%28java.lang.String%29">
setRootDir</a></b>(java.lang.String rootDir)</code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setSuperGroup%28java.lang.String%29">
setSuperGroup</a></b>(java.lang.String superGroupName)</code> <br>
Called by group parser when ": supergroupname" is found.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code> void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#setSuperGroup%28org.antlr.stringtemplate.StringTemplateGroup%29">
setSuperGroup</a></b>(<a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a> superGroup)</code>
<br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="left"> </td>
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected void</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#verifyInterfaceImplementations%28%29">
verifyInterfaceImplementations</a></b>()</code> <br>
verify that this group satisfies its interfaces</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
</table>
<hr>
<h2>Fields</h2>
<table width="100%" border="1" cellpadding="3" cellspacing="0" id="table3"
style="border-collapse: collapse" bordercolor="#C0C0C0">
<tr class="TableHeadingColor" bgcolor="#ccccff">
<td valign="top"><b>Field Summary</b></td>
<td valign="top"> </td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.util.Map</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#attributeRenderers">
attributeRenderers</a></b></code> <br>
A Map<class,object> that allows people to register a renderer for a particular kind of
object to be displayed for any template in this group.</class,object></td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected boolean</code></font></td>
<td bgcolor="#EEEEFF" valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#debugTemplateOutput">
debugTemplateOutput</a></b></code> <br>
</td>
<td bgcolor="#EEEEFF" valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>static <a
title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">StringTemplateErrorListener</a></code></font></td>
<td bgcolor="#EEEEFF" valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#DEFAULT_ERROR_LISTENER">
DEFAULT_ERROR_LISTENER</a></b></code> <br>
</td>
<td bgcolor="#EEEEFF" valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected static java.lang.Class</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#defaultTemplateLexerClass">
defaultTemplateLexerClass</a></b></code> <br>
You can set the lexer once if you know all of your groups use the same separator.</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>(package private) java.lang.String</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#fileCharEncoding">
fileCharEncoding</a></b></code> <br>
How are the files encoded (ascii, UTF8, ...)? You might want to read UTF8 for example
on an ascii machine.</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.util.List</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#interfaces">
interfaces</a></b></code> <br>
Keep track of all interfaces implemented by this group.</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected long</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#lastCheckedDisk">
lastCheckedDisk</a></b></code> <br>
</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected <a
title="interface in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateErrorListener.html">StringTemplateErrorListener</a></code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#listener">
listener</a></b></code> <br>
Where to report errors.</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.util.Map</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#maps">
maps</a></b></code> <br>
Maps map names to HashMap objects.</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.lang.String</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#name">
name</a></b></code> <br>
What is the group name</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected
static java.util.Map</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#nameToGroupMap">
nameToGroupMap</a></b></code> <br>
Track all groups by name; maps name to StringTemplateGroup</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected
static java.util.Map</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#nameToInterfaceMap">
nameToInterfaceMap</a></b></code> <br>
Track all interfaces by name; maps name to StringTemplateGroupInterface</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected java.util.Set</code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#noDebugStartStopStrings">
noDebugStartStopStrings</a></b></code> <br>
The set of templates to ignore when dumping start/stop debug strings</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right" bgcolor="#EEEEFF"><font size="-1"><code>protected
static <a title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplate.html">StringTemplate</a></code></font></td>
<td valign="top" bgcolor="#EEEEFF"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#NOT_FOUND_ST">
NOT_FOUND_ST</a></b></code> <br>
Used to indicate that the template doesn't exist.</td>
<td valign="top" bgcolor="#EEEEFF"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected int</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#refreshIntervalInSeconds">
refreshIntervalInSeconds</a></b></code> <br>
How long before tossing out all templates in seconds.</td>
<td valign="top">This must assume that we're not directly using the templates in the group, but
have instanced them.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.lang.String</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#rootDir">
rootDir</a></b></code> <br>
Under what directory should I look for templates? If null, to look into the CLASSPATH
for templates as resources.</td>
<td valign="top">I = This StringTemplateGroup</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected <a
title="class in org.antlr.stringtemplate"
href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html">StringTemplateGroup</a></code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#superGroup">
superGroup</a></b></code> <br>
Are we derived from another group? Templates not found in this group will be searched
for in the superGroup recursively.</td>
<td valign="top">We = This StringTemplateGroup</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.lang.Class</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#templateLexerClass">
templateLexerClass</a></b></code> <br>
How to pull apart a template into chunks?</td>
<td valign="top">Ie: Point to a lexer to use for lexing a template. This is of interest in order
to choose which delimiter to use for template expressions. Ie: $...$ or <...>.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.util.Map</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#templates">
templates</a></b></code> <br>
Maps template name to StringTemplate object</td>
<td valign="top"> </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected boolean</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#templatesDefinedInGroupFile">
templatesDefinedInGroupFile</a></b></code> <br>
When templates are files on the disk, the refresh interval is used to know when to
reload.</td>
<td valign="top">Also impacts where templates are sought. See source.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td valign="top" width="1%" align="right"><font size="-1"><code>protected java.lang.Class</code></font></td>
<td valign="top"><code><b>
<a href="http://www.stringtemplate.org/api/org/antlr/stringtemplate/StringTemplateGroup.html#userSpecifiedWriter">
userSpecifiedWriter</a></b></code> <br>
Normally AutoIndentWriter is used to filter output, but user can specify a new one.</td>
<td valign="top"> </td>
</tr>
</table>
|