org.antlr.stringtemplate
Class StringTemplateGroup

java.lang.Object
  extended byorg.antlr.stringtemplate.StringTemplateGroup

public class StringTemplateGroup
extends java.lang.Object

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

DEFAULT_ERROR_LISTENER

public static StringTemplateErrorListener DEFAULT_ERROR_LISTENER
Constructor Detail

StringTemplateGroup

public 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

public StringTemplateGroup(java.lang.String name,
                           java.lang.String rootDir,
                           java.lang.Class lexer)

StringTemplateGroup

public StringTemplateGroup(java.lang.String name)
Create a group manager for some templates, all of which are loaded as resources via the classloader.


StringTemplateGroup

public StringTemplateGroup(java.lang.String name,
                           java.lang.Class lexer)

StringTemplateGroup

public StringTemplateGroup(java.io.Reader r)
Create a group from the template group defined by a input stream. The name is pulled from the file. The format is group name; t1(args) : "..." t2 : << >> ...


StringTemplateGroup

public StringTemplateGroup(java.io.Reader r,
                           StringTemplateErrorListener errors)

StringTemplateGroup

public StringTemplateGroup(java.io.Reader r,
                           java.lang.Class lexer)

StringTemplateGroup

public 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. This is usefor changing the delimiter from the default $...$ to <...>, for example.

Method Detail

getTemplateLexerClass

public java.lang.Class getTemplateLexerClass()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setSuperGroup

public void setSuperGroup(StringTemplateGroup superGroup)

setSuperGroup

public void setSuperGroup(java.lang.String groupName)

getSuperGroup

public StringTemplateGroup getSuperGroup()

getRootDir

public java.lang.String getRootDir()

setRootDir

public void setRootDir(java.lang.String rootDir)

createStringTemplate

public StringTemplate createStringTemplate()
StringTemplate object factory; each group can have its own.


getInstanceOf

public StringTemplate getInstanceOf(java.lang.String name)
                             throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException

getEmbeddedInstanceOf

public StringTemplate getEmbeddedInstanceOf(StringTemplate enclosingInstance,
                                            java.lang.String name)
                                     throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException

lookupTemplate

public StringTemplate lookupTemplate(java.lang.String name)
                              throws java.lang.IllegalArgumentException
Get the template called 'name' from the group. If not found, attempt to load. If not found on disk, then try the superGroup if any. If not even there, then record that it's NOT_FOUND so we don't waste time looking again later. If we've gone past refresh interval, flush and look again.

Throws:
java.lang.IllegalArgumentException

getFileNameFromTemplateName

public java.lang.String getFileNameFromTemplateName(java.lang.String templateName)
(public so that people can override behavior; not a general purpose method)


getTemplateNameFromFileName

public java.lang.String getTemplateNameFromFileName(java.lang.String fileName)
Convert a filename relativePath/name.st to relativePath/name. (public so that people can override behavior; not a general purpose method)


getFileCharEncoding

public java.lang.String getFileCharEncoding()

setFileCharEncoding

public void setFileCharEncoding(java.lang.String fileCharEncoding)

defineTemplate

public StringTemplate defineTemplate(java.lang.String name,
                                     java.lang.String template)
Define an examplar template; precompiled and stored with no attributes. Remove any previous definition.


defineTemplateAlias

public StringTemplate defineTemplateAlias(java.lang.String name,
                                          java.lang.String target)
Make name and alias for target. Replace any previous def of name


isDefinedInThisGroup

public boolean isDefinedInThisGroup(java.lang.String name)

getTemplateDefinition

public StringTemplate getTemplateDefinition(java.lang.String name)
Get the ST for 'name' in this group only


isDefined

public boolean isDefined(java.lang.String name)
Is there *any* definition for template 'name' in this template or above it in the group hierarchy?


getRefreshInterval

public int getRefreshInterval()

setRefreshInterval

public void setRefreshInterval(int refreshInterval)
How often to refresh all templates from disk. This is a crude mechanism at the moment--just tosses everything out at this frequency. Set interval to 0 to refresh constantly (no caching). Set interval to a huge number like MAX_INT to have no refreshing at all (DEFAULT); it will cache stuff.


setErrorListener

public void setErrorListener(StringTemplateErrorListener listener)

getErrorListener

public StringTemplateErrorListener getErrorListener()

setStringTemplateWriter

public void setStringTemplateWriter(java.lang.Class c)
Specify a StringTemplateWriter implementing class to use for filtering output


getStringTemplateWriter

public StringTemplateWriter getStringTemplateWriter(java.io.Writer w)
return an instance of a StringTemplateWriter that spits output to w. If a writer is specified, use it instead of the default.


error

public void error(java.lang.String msg)

error

public void error(java.lang.String msg,
                  java.lang.Exception e)

toString

public java.lang.String toString()