STGroupFile

java.lang.Object
- org.stringtemplate.v4.STGroup
- - org.stringtemplate.v4.STGroupFile

```
public class STGroupFile
extends STGroup
```
The internal representation of a single group file (which must end in ".stg"). If we fail to find a group file, look for it via the CLASSPATH as a resource. Templates are only looked up in this file or an import.

Field Summary

Fields

Modifier and Type	Field and Description
`protected boolean`	`alreadyLoaded`
`String`	`fileName`
`URL`	`url`

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
`STGroupFile(String fileName)` Load a file relative to current directory or from root or via CLASSPATH.
`STGroupFile(String fileName, char delimiterStartChar, char delimiterStopChar)`
`STGroupFile(String fullyQualifiedFileName, String encoding)`
`STGroupFile(String fullyQualifiedFileName, String encoding, char delimiterStartChar, char delimiterStopChar)`
`STGroupFile(URL url, String encoding, char delimiterStartChar, char delimiterStopChar)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`String`	`getFileName()`
`String`	`getName()`
`URL`	`getRootDirURL()` Return root dir if this is group dir; return dir containing group file if this is group file.
`boolean`	`isDefined(String name)` Is this template defined in this group or from this group below? Names must be absolute, fully-qualified names like `/a/b`.
`boolean`	`isDictionary(String name)`
`void`	`load()` Force a load if it makes sense for the group.
`protected CompiledST`	`load(String name)` Load st from disk if directory or load whole group file if .stg file (then return just one template).
`String`	`show()`
`void`	`unload()` Unload all templates, dictionaries and import relationships, but leave renderers and adaptors.

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, importTemplates, loadAbsoluteTemplateFile, loadGroupFile, loadTemplateFile, lookupImportedTemplate, lookupTemplate, rawDefineTemplate, rawGetDictionary, rawGetTemplate, registerModelAdaptor, registerRenderer, registerRenderer, setListener, toString, undefineTemplate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - fileName
```
public String fileName
```
  - url
```
public URL url
```
  - alreadyLoaded
```
protected boolean alreadyLoaded
```
- Constructor Detail
  - STGroupFile
```
public STGroupFile(String fileName)
```
    Load a file relative to current directory or from root or via CLASSPATH.
  - STGroupFile
```
public STGroupFile(String fileName,
                   char delimiterStartChar,
                   char delimiterStopChar)
```
  - STGroupFile
```
public STGroupFile(String fullyQualifiedFileName,
                   String encoding)
```
  - STGroupFile
```
public STGroupFile(String fullyQualifiedFileName,
                   String encoding,
                   char delimiterStartChar,
                   char delimiterStopChar)
```
  - STGroupFile
```
public STGroupFile(URL url,
                   String encoding,
                   char delimiterStartChar,
                   char delimiterStopChar)
```
- Method Detail
  - isDictionary
```
public boolean isDictionary(String name)
```
  - isDefined
```
public boolean isDefined(String name)
```
    Description copied from class: STGroup
    
    Is this template defined in this group or from this group below? Names must be absolute, fully-qualified names like /a/b.
  - unload
```
public void unload()
```
    Description copied from class: STGroup
    
    Unload all templates, dictionaries and import relationships, but leave renderers and adaptors. This essentially forces the next call to STGroup.getInstanceOf(java.lang.String) to reload templates. Call unload() on each group in the STGroup.imports list, and remove all elements in STGroup.importsToClearOnUnload from STGroup.imports.
  - load
```
protected CompiledST load(String name)
```
    Description copied from class: STGroup
    
    Load st from disk if directory or load whole group file if .stg file (then return just one template). name is fully-qualified.
  - load
```
public void load()
```
    Description copied from class: STGroup
    
    Force a load if it makes sense for the group.
  - show
```
public String show()
```
  - getName
```
public String getName()
```
  - getFileName
```
public String getFileName()
```
  - getRootDirURL
```
public 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.

Class STGroupFile

Field Summary

Fields

Fields inherited from class org.stringtemplate.v4.STGroup

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.stringtemplate.v4.STGroup

Methods inherited from class java.lang.Object

Field Detail

fileName

url

alreadyLoaded

Constructor Detail

STGroupFile

STGroupFile

STGroupFile

STGroupFile

STGroupFile

Method Detail

isDictionary

isDefined

unload

load

load

show

getName

getFileName

getRootDirURL