org.stringtemplate.v4

Class STGroupDir

java.lang.Object

org.stringtemplate.v4.STGroup

org.stringtemplate.v4.STGroupDir

Direct Known Subclasses:

STRawGroupDir

public class STGroupDir
extends STGroup

A directory or directory tree full of templates and/or group files. We load files on-demand. Dir search path: current working dir then CLASSPATH (as a resource). Do not look for templates outside of this dir subtree (except via imports).

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	groupDirName
java.net.URL	root

Fields inherited from class org.stringtemplate.v4.STGroup

adaptors, DEFAULT_ERR_MGR, DEFAULT_KEY, defaultGroup, delimiterStartChar, delimiterStopChar, DICT_KEY, dictionaries, encoding, errMgr, GROUP_FILE_EXTENSION, imports, importsToClearOnUnload, iterateAcrossValues, NOT_FOUND_ST, renderers, TEMPLATE_FILE_EXTENSION, templates, trackCreationEvents, verbose

Constructor Summary

Constructors

Constructor and Description
STGroupDir(java.lang.String dirName)
STGroupDir(java.lang.String dirName, char delimiterStartChar, char delimiterStopChar)
STGroupDir(java.lang.String dirName, java.lang.String encoding)
STGroupDir(java.lang.String dirName, java.lang.String encoding, char delimiterStartChar, char delimiterStopChar)
STGroupDir(java.net.URL root, java.lang.String encoding, char delimiterStartChar, char delimiterStopChar)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFileName()
java.lang.String	getName()
java.net.URL	getRootDirURL() Return root dir if this is group dir; return dir containing group file if this is group file.
void	importTemplates(org.antlr.runtime.Token fileNameToken) Import template files, directories, and group files.
protected CompiledST	load(java.lang.String name) Load a template from directory or group file.
CompiledST	loadTemplateFile(java.lang.String prefix, java.lang.String unqualifiedFileName) Load .st as relative file name relative to root by prefix.

Methods inherited from class org.stringtemplate.v4.STGroup

compile, createSingleton, createStringTemplate, createStringTemplateInternally, createStringTemplateInternally, defineDictionary, defineRegion, defineTemplate, defineTemplate, defineTemplate, defineTemplateAlias, defineTemplateOrRegion, getAttributeRenderer, getEmbeddedInstanceOf, getImportedGroups, getInstanceOf, getListener, getMangledRegionName, getModelAdaptor, getTemplateNames, getUnMangledTemplateName, getURL, importTemplates, importTemplates, isDefined, isDictionary, isReservedCharacter, load, loadAbsoluteTemplateFile, loadGroupFile, loadTemplateFile, lookupImportedTemplate, lookupTemplate, rawDefineTemplate, rawGetDictionary, rawGetTemplate, registerModelAdaptor, registerRenderer, registerRenderer, setListener, show, toString, undefineTemplate, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

groupDirName

public java.lang.String groupDirName

root

public java.net.URL root

Constructor Detail

STGroupDir

public STGroupDir(java.lang.String dirName)

STGroupDir

public STGroupDir(java.lang.String dirName,
          char delimiterStartChar,
          char delimiterStopChar)

STGroupDir

public STGroupDir(java.lang.String dirName,
          java.lang.String encoding)

STGroupDir

public STGroupDir(java.lang.String dirName,
          java.lang.String encoding,
          char delimiterStartChar,
          char delimiterStopChar)

STGroupDir

public STGroupDir(java.net.URL root,
          java.lang.String encoding,
          char delimiterStartChar,
          char delimiterStopChar)

Method Detail

importTemplates

public void importTemplates(org.antlr.runtime.Token fileNameToken)

Description copied from class: STGroup

Import template files, directories, and group files. Priority is given to templates defined in the current group; this, in effect, provides inheritance. Polymorphism is in effect so that if an inherited template references template t() then we search for t() in the subgroup first.

Templates are loaded on-demand from import dirs. Imported groups are loaded on-demand when searching for a template.

The listener of this group is passed to the import group so errors found while loading imported element are sent to listener of this group.

On unload imported templates are unloaded and removed from the imports list.

This method is called when processing import statements specified in group files. Use STGroup.importTemplates(STGroup) to import templates 'programmatically'.

Overrides:

importTemplates in class STGroup

load

protected CompiledST load(java.lang.String name)

Load a template from directory or group file. Group file is given precedence over directory with same name. name is always fully-qualified.

Overrides:

load in class STGroup

loadTemplateFile

public CompiledST loadTemplateFile(java.lang.String prefix,
                          java.lang.String unqualifiedFileName)

Load .st as relative file name relative to root by prefix.

getName

public java.lang.String getName()

Overrides:

getName in class STGroup

getFileName

public java.lang.String getFileName()

Overrides:

getFileName in class STGroup

getRootDirURL

public java.net.URL getRootDirURL()

Description copied from class: STGroup

Return root dir if this is group dir; return dir containing group file if this is group file. This is derived from original incoming dir or filename. If it was absolute, this should come back as full absolute path. If only a URL is available, return URL of one dir up.

Overrides:

getRootDirURL in class STGroup