Index (template-machine 1.0.2 API)

A C D E F G H I L M R S T U
All Classes|All Packages

A

add(GenerationInfo) - Method in class templating.util.GenerationInfo: Add information from other information
addLanguages(Collection<String>) - Method in class templating.util.GenerationInfo: Adds the languages.

C

canGenerateDirectory() - Method in class templating.Context: Returns whether the current sub directory is marked for generation.
close() - Method in class templating.util.UnicodeInputStream
closeTemplateSource(Object) - Method in class templating.Generator
context - Variable in class templating.Generator
Context - Class in templating: Holds all information and configuration in a directory.
Context(File, File, File, Properties) - Constructor for class templating.Context: Root Constructor.
Context(Context, File, File) - Constructor for class templating.Context: Constructor for sub directories.

D

defaultConfig - Static variable in class templating.Context: Default configuration values (required in root context only)

E

execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in class templating.util.Rfc1342Directive

F

FileReadUtils - Class in templating.util: Helper methods to correctly read Unicode files if required
FileReadUtils() - Constructor for class templating.util.FileReadUtils
findTemplateSource(String) - Method in class templating.Generator
freemarkerConfig - Variable in class templating.Generator

G

generate() - Method in class templating.TemplateMachine: Generate the project files.
generateFile(File, String, File) - Method in class templating.Generator: Process a single template and generates the file.
generateRecursively(Context) - Method in class templating.TemplateMachine: Generate recursively
GenerationInfo - Class in templating.util: Provides statistical information about the generation process.
GenerationInfo() - Constructor for class templating.util.GenerationInfo: Constructor.
GenerationInfo(Set<String>, int) - Constructor for class templating.util.GenerationInfo: Constructor.
Generator - Class in templating: Generates all files in a directory (not recursively!)
Generator(Context) - Constructor for class templating.Generator: Constructor.
getCommandLineOptions() - Static method in class templating.TemplateMachine: Creates the command line options.
getConfigString(String) - Method in class templating.Context: Returns the configuration value of given key.
getDefaultConfig() - Static method in class templating.Context: Returns the default configuration.
getDefaultEncoding() - Method in class templating.util.UnicodeInputStream
getEncoding() - Method in class templating.util.UnicodeInputStream
getFiles() - Method in class templating.util.GenerationInfo: Returns the files.
getGenerationTime() - Method in class templating.Context: Returns the generation time for this run.
getIgnoredFiles() - Method in class templating.Context: Returns the ignoredFiles.
getInfo() - Method in class templating.Generator: Returns the info.
getLanguageCount() - Method in class templating.util.GenerationInfo: Returns the language count.
getLanguages() - Method in class templating.Context: Returns all languages in this context.
getLanguages() - Method in class templating.util.GenerationInfo: Returns the languages.
getLastModified(Object) - Method in class templating.Generator
getLocalizations(String) - Method in class templating.Context: Returns the localization values for the given key.
getMergedLocalization(String) - Method in class templating.Context: Merge all language keys so all values are available for a specific language.
getOutputDir() - Method in class templating.Context: Returns the outputDir.
getOutputRoot() - Method in class templating.Context: Returns the outputRoot.
getParent() - Method in class templating.Context: Returns the parent.
getReadEncoding() - Method in class templating.Context: Returns the readEncoding.
getReader(File, String) - Static method in class templating.util.FileReadUtils: Returns a reader that is able to handle BOM UTF-8 files.
getReader(File, Charset) - Static method in class templating.util.FileReadUtils: Returns a reader that is able to handle BOM UTF-8 files.
getReader(Object, String) - Method in class templating.Generator
getRelativePath(File) - Method in class templating.Context: Returns the relative path of the file in the project
getSourceDir() - Method in class templating.Context: Returns the sourceDir.
getSourceRoot() - Method in class templating.Context: Returns the sourceRoot.
getSubRoot() - Method in class templating.Context: Returns the subRoot.
getTemplate(String) - Method in class templating.Context: Returns the template with given name.
getTemplates() - Method in class templating.Context: Returns the templates.
getWriteEncoding() - Method in class templating.Context: Returns the writeEncoding.

H

hasLanguage(String) - Method in class templating.Context: Returns whether language exists.

I

ignoreFile(File) - Method in class templating.Context: Adds file to list of ignore files.
incFiles() - Method in class templating.util.GenerationInfo: Increased the file counter.
info - Variable in class templating.Generator
init() - Method in class templating.util.UnicodeInputStream: Read-ahead four bytes and check for BOM marks.
initContext() - Method in class templating.Context: Initializes the context by reading directory specific configuration and localization information.
isSpecialFile(File) - Method in class templating.Context: Tests whether the file is any of the special files or directories in the config
isValidFile(File) - Method in class templating.Context: Returns true when a file (template or localization) can be used for templating.

L

lastModified - Variable in class templating.Generator
load(File) - Static method in class templating.TemplateMachine
loadAutoLanguages() - Method in class templating.Context: Loads all languages available.
loadLanguage(String, String) - Method in class templating.Context: Loads a specific language
loadLocalConfig() - Method in class templating.Context: Loads the local configuration and parent configuration as well as local .config files in current directory Context.sourceDir.
loadLocalizations() - Method in class templating.Context: Computes the required local languages and loads them.
loadLocalSubTemplates(String, File) - Method in class templating.Context: Load recursively templates in sub folders.
loadLocalTemplates() - Method in class templating.Context: Override parent definitions of templates.
log - Static variable in class templating.Generator: The logger
log - Static variable in class templating.TemplateMachine: The logger

M

main(String[]) - Static method in class templating.TemplateMachine: Main method.

R

read() - Method in class templating.util.UnicodeInputStream
readFile(File, Charset) - Static method in class templating.util.FileReadUtils: Reads a file into a string handling UTF-8-BOM correctly.
Rfc1342Directive - Class in templating.util: Implements the quoted-printable conversion as described by RFC1342 (UTF-8 for email subjects).
Rfc1342Directive() - Constructor for class templating.util.Rfc1342Directive: Constructor for strict encoding.
Rfc1342Directive(boolean) - Constructor for class templating.util.Rfc1342Directive: Constructor.
rootContext - Variable in class templating.TemplateMachine
run() - Method in class templating.Generator

S

setFiles(int) - Method in class templating.util.GenerationInfo: Sets the files.
setGenerationTime(Date) - Method in class templating.Context: Sets the generation time for this run.
setIgnoredFiles(Set<File>) - Method in class templating.Context: Sets the ignoredFiles.
setLanguages(Set<String>) - Method in class templating.util.GenerationInfo: Sets the languages.
setOutputDir(File) - Method in class templating.Context: Sets the outputDir.
setOutputRoot(File) - Method in class templating.Context: Sets the outputRoot.
setParent(Context) - Method in class templating.Context: Sets the parent.
setReadEncoding(Charset) - Method in class templating.Context: Sets the readEncoding.
setSourceDir(File) - Method in class templating.Context: Sets the sourceDir.
setSourceRoot(File) - Method in class templating.Context: Sets the sourceRoot.
setSubRoot(File) - Method in class templating.Context: Sets the subRoot.
setWriteEncoding(Charset) - Method in class templating.Context: Sets the writeEncoding.

T

TemplateMachine - Class in templating: The main class for templating.
TemplateMachine(Context) - Constructor for class templating.TemplateMachine: Constructor.
templating - package templating: Main templating folder
templating.util - package templating.util: Required for templating.
TemplatingException - Exception in templating: A runtime exception.
TemplatingException() - Constructor for exception templating.TemplatingException: Constructor.
TemplatingException(String) - Constructor for exception templating.TemplatingException: Constructor.
TemplatingException(String, Throwable) - Constructor for exception templating.TemplatingException: Constructor.
TemplatingException(String, Throwable, boolean, boolean) - Constructor for exception templating.TemplatingException: Constructor.
TemplatingException(Throwable) - Constructor for exception templating.TemplatingException: Constructor.

U

UnicodeInputStream - Class in templating.util: This inputstream will recognize unicode BOM marks and will skip bytes if getEncoding() method is called before any of the read(...) methods.
UnicodeInputStream(InputStream, String) - Constructor for class templating.util.UnicodeInputStream

A C D E F G H I L M R S T U
All Classes|All Packages