org.stringtemplate.v4
Class STGroupDir

java.lang.Object
  org.stringtemplate.v4.STGroup
      org.stringtemplate.v4.STGroupDir

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

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, imports, iterateAcrossValues, NOT_FOUND_ST, renderers, templates, trackCreationEvents, typeToAdaptorCache, typeToRendererCache, verbose

Constructor Summary

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

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.
protected CompiledST	load(java.lang.String name) Load a template from dir or group file.
CompiledST	loadTemplateFile(java.lang.String prefix, java.lang.String fileName) 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, getInstanceOf, getListener, getMangledRegionName, getModelAdaptor, getUnMangledTemplateName, getURL, importTemplates, importTemplates, invalidateModelAdaptorCache, isDefined, isDictionary, load, loadAbsoluteTemplateFile, loadGroupFile, loadTemplateFile, lookupImportedTemplate, lookupTemplate, rawDefineTemplate, rawGetDictionary, rawGetTemplate, registerModelAdaptor, 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

load

protected CompiledST load(java.lang.String name)

Load a template from dir or group file. Group file is given precedence over dir with same name.

Overrides:

load in class STGroup

loadTemplateFile

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

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