|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.antlr.stringtemplate.StringTemplateGroup
Manages a group of named mutually-referential StringTemplate objects. Currently the templates must all live under a directory so that you can reference them as foo.st or gutter/header.st. To refresh a group of templates, just create a new StringTemplateGroup and start pulling templates from there. Or, set the refresh interval. Use getInstanceOf(template-name) to get a string template to fill in. The name of a template is the file name minus ".st" ending if present unless you name it as you load it.
Field Summary | |
static StringTemplateErrorListener |
DEFAULT_ERROR_LISTENER
|
Constructor Summary | |
StringTemplateGroup(java.io.Reader r)
Create a group from the template group defined by a input stream. |
|
StringTemplateGroup(java.io.Reader r,
java.lang.Class lexer)
|
|
StringTemplateGroup(java.io.Reader r,
java.lang.Class lexer,
StringTemplateErrorListener errors)
Create a group from the input stream, but use a nondefault lexer to break the templates up into chunks. |
|
StringTemplateGroup(java.io.Reader r,
StringTemplateErrorListener errors)
|
|
StringTemplateGroup(java.lang.String name)
Create a group manager for some templates, all of which are loaded as resources via the classloader. |
|
StringTemplateGroup(java.lang.String name,
java.lang.Class lexer)
|
|
StringTemplateGroup(java.lang.String name,
java.lang.String rootDir)
Create a group manager for some templates, all of which are at or below the indicated directory. |
|
StringTemplateGroup(java.lang.String name,
java.lang.String rootDir,
java.lang.Class lexer)
|
Method Summary | |
StringTemplate |
createStringTemplate()
StringTemplate object factory; each group can have its own. |
StringTemplate |
defineTemplate(java.lang.String name,
java.lang.String template)
Define an examplar template; precompiled and stored with no attributes. |
StringTemplate |
defineTemplateAlias(java.lang.String name,
java.lang.String target)
Make name and alias for target. |
void |
error(java.lang.String msg)
|
void |
error(java.lang.String msg,
java.lang.Exception e)
|
StringTemplate |
getEmbeddedInstanceOf(StringTemplate enclosingInstance,
java.lang.String name)
|
StringTemplateErrorListener |
getErrorListener()
|
java.lang.String |
getFileCharEncoding()
|
java.lang.String |
getFileNameFromTemplateName(java.lang.String templateName)
(public so that people can override behavior; not a general purpose method) |
StringTemplate |
getInstanceOf(java.lang.String name)
|
java.lang.String |
getName()
|
int |
getRefreshInterval()
|
java.lang.String |
getRootDir()
|
StringTemplateWriter |
getStringTemplateWriter(java.io.Writer w)
return an instance of a StringTemplateWriter that spits output to w. |
StringTemplateGroup |
getSuperGroup()
|
StringTemplate |
getTemplateDefinition(java.lang.String name)
Get the ST for 'name' in this group only |
java.lang.Class |
getTemplateLexerClass()
|
java.lang.String |
getTemplateNameFromFileName(java.lang.String fileName)
Convert a filename relativePath/name.st to relativePath/name. |
boolean |
isDefined(java.lang.String name)
Is there *any* definition for template 'name' in this template or above it in the group hierarchy? |
boolean |
isDefinedInThisGroup(java.lang.String name)
|
StringTemplate |
lookupTemplate(java.lang.String name)
Get the template called 'name' from the group. |
void |
setErrorListener(StringTemplateErrorListener listener)
|
void |
setFileCharEncoding(java.lang.String fileCharEncoding)
|
void |
setName(java.lang.String name)
|
void |
setRefreshInterval(int refreshInterval)
How often to refresh all templates from disk. |
void |
setRootDir(java.lang.String rootDir)
|
void |
setStringTemplateWriter(java.lang.Class c)
Specify a StringTemplateWriter implementing class to use for filtering output |
void |
setSuperGroup(java.lang.String groupName)
|
void |
setSuperGroup(StringTemplateGroup superGroup)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static StringTemplateErrorListener DEFAULT_ERROR_LISTENER
Constructor Detail |
public StringTemplateGroup(java.lang.String name, java.lang.String rootDir)
public StringTemplateGroup(java.lang.String name, java.lang.String rootDir, java.lang.Class lexer)
public StringTemplateGroup(java.lang.String name)
public StringTemplateGroup(java.lang.String name, java.lang.Class lexer)
public StringTemplateGroup(java.io.Reader r)
public StringTemplateGroup(java.io.Reader r, StringTemplateErrorListener errors)
public StringTemplateGroup(java.io.Reader r, java.lang.Class lexer)
public StringTemplateGroup(java.io.Reader r, java.lang.Class lexer, StringTemplateErrorListener errors)
Method Detail |
public java.lang.Class getTemplateLexerClass()
public java.lang.String getName()
public void setName(java.lang.String name)
public void setSuperGroup(StringTemplateGroup superGroup)
public void setSuperGroup(java.lang.String groupName)
public StringTemplateGroup getSuperGroup()
public java.lang.String getRootDir()
public void setRootDir(java.lang.String rootDir)
public StringTemplate createStringTemplate()
public StringTemplate getInstanceOf(java.lang.String name) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public StringTemplate getEmbeddedInstanceOf(StringTemplate enclosingInstance, java.lang.String name) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public StringTemplate lookupTemplate(java.lang.String name) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.lang.String getFileNameFromTemplateName(java.lang.String templateName)
public java.lang.String getTemplateNameFromFileName(java.lang.String fileName)
public java.lang.String getFileCharEncoding()
public void setFileCharEncoding(java.lang.String fileCharEncoding)
public StringTemplate defineTemplate(java.lang.String name, java.lang.String template)
public StringTemplate defineTemplateAlias(java.lang.String name, java.lang.String target)
public boolean isDefinedInThisGroup(java.lang.String name)
public StringTemplate getTemplateDefinition(java.lang.String name)
public boolean isDefined(java.lang.String name)
public int getRefreshInterval()
public void setRefreshInterval(int refreshInterval)
public void setErrorListener(StringTemplateErrorListener listener)
public StringTemplateErrorListener getErrorListener()
public void setStringTemplateWriter(java.lang.Class c)
public StringTemplateWriter getStringTemplateWriter(java.io.Writer w)
public void error(java.lang.String msg)
public void error(java.lang.String msg, java.lang.Exception e)
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |