Index

A B C D E F G I J L M N O P R S T U V W X Z
All Classes All Packages

A

addFlagOption(char, String, String) - Method in class io.github.erdos.stencil.standalone.ArgsParser
addParam(char, String, String, Function<String, T>) - Method in class io.github.erdos.stencil.standalone.ArgsParser
API - Class in io.github.erdos.stencil
ArgsParser - Class in io.github.erdos.stencil.standalone
ArgsParser() - Constructor for class io.github.erdos.stencil.standalone.ArgsParser
ArgsParser.ParamMarker<T> - Class in io.github.erdos.stencil.standalone
ArgsParser.ParseResult - Class in io.github.erdos.stencil.standalone
ASCTIME - Static variable in enum io.github.erdos.stencil.functions.DateFunctions

B

BasicFunctions - Enum in io.github.erdos.stencil.functions: Common general purpose functions.

C

CachingTemplateFactory - Class in io.github.erdos.stencil.impl: Wraps a TemplateFactory instance and proxies calls only iff template file has not been changed since last call.
CachingTemplateFactory(TemplateFactory) - Constructor for class io.github.erdos.stencil.impl.CachingTemplateFactory: Constructs a new wrapping instance.
call(Object...) - Method in interface io.github.erdos.stencil.functions.Function: A simple function call.
call(String, Object...) - Method in class io.github.erdos.stencil.functions.FunctionEvaluator: Calls a function by name.
CEIL - io.github.erdos.stencil.functions.NumberFunctions: Rounds a number to the closest bigger integer value.
ClojureHelper - Class in io.github.erdos.stencil.impl: Clojure utilities.
close() - Method in class io.github.erdos.stencil.impl.InputStreamExceptionPropagation
close() - Method in class io.github.erdos.stencil.impl.LifecycleLock
close() - Method in interface io.github.erdos.stencil.PreparedFragment: Makes the template clean up resources allocated for it.
close() - Method in interface io.github.erdos.stencil.PreparedTemplate: Makes the template clean up any resources allocated for it.
COALESCE - io.github.erdos.stencil.functions.BasicFunctions: Returns the first non-null a non-empty value.
createNonexistentTempFile(File, String, String) - Static method in class io.github.erdos.stencil.impl.FileHelper
createNonexistentTempFile(String, String) - Static method in class io.github.erdos.stencil.impl.FileHelper: Creates a temporary file that is guaranteed not to exist on file system.
creationDateTime() - Method in interface io.github.erdos.stencil.PreparedTemplate: Time when the template was processed.
CURRENCY - io.github.erdos.stencil.functions.LocaleFunctions: Formats number as a localized monetary amount with currency.

D

DATE - io.github.erdos.stencil.functions.DateFunctions: Formats a date object.
DATE_DOTTED - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
DATE_TOSTRING - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
DateFunctions - Enum in io.github.erdos.stencil.functions: Date handling functions
DATETIME1 - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
DirWatcherTemplateFactory - Class in io.github.erdos.stencil.impl: Watches file system and automatically loads template files on file changes.
DirWatcherTemplateFactory(File, TemplateFactory) - Constructor for class io.github.erdos.stencil.impl.DirWatcherTemplateFactory: Default ctor.
DOCX - io.github.erdos.stencil.TemplateDocumentFormats: Microsoft Word Open XML Format Document file.

E

EDN - io.github.erdos.stencil.standalone.Parser.DataFileFormat
empty() - Static method in class io.github.erdos.stencil.TemplateData: Construct a new empty template data object.
EMPTY - io.github.erdos.stencil.functions.BasicFunctions: Returns true iff input is null, empty string or empty collection.
EvalException - Exception in io.github.erdos.stencil.exceptions: Indicates that an error happened during the evaluation of a stencil expression in a template.
EvalException(String, Exception) - Constructor for exception io.github.erdos.stencil.exceptions.EvalException
EvaluatedDocument - Interface in io.github.erdos.stencil: An evaluated document ready to be converted to the final output format.
execute(List<LifecycleLock>, Callable<T>) - Static method in class io.github.erdos.stencil.impl.LifecycleLock
extension(File) - Static method in class io.github.erdos.stencil.impl.FileHelper
extension(String) - Static method in class io.github.erdos.stencil.impl.FileHelper

F

fail(Throwable) - Method in class io.github.erdos.stencil.impl.InputStreamExceptionPropagation
FileHelper - Class in io.github.erdos.stencil.impl: File handling utilities.
findFunction(String) - Static method in class io.github.erdos.stencil.impl.ClojureHelper: Finds a function in stencil.process namespace and returns it.
finish() - Method in class io.github.erdos.stencil.impl.InputStreamExceptionPropagation
FLOOR - io.github.erdos.stencil.functions.NumberFunctions: Rounds a number to the closest smaller integer value.
forceDelete(File) - Static method in class io.github.erdos.stencil.impl.FileHelper: Recursively deletes a directory or a file.
forceMkdir(File) - Static method in class io.github.erdos.stencil.impl.FileHelper: Creates a directory.
fragment(File) - Static method in class io.github.erdos.stencil.API
fragment(File, PrepareOptions) - Static method in class io.github.erdos.stencil.API: Prepares a document fragment from the file system.
fromMap(Map<String, Object>) - Static method in class io.github.erdos.stencil.TemplateData: Constructs a template data instance holding a map data structure.
fromMessage(String, String) - Static method in exception io.github.erdos.stencil.exceptions.ParsingException
fromPaths(Collection<String>, Collection<String>) - Static method in class io.github.erdos.stencil.TemplateVariables
Function - Interface in io.github.erdos.stencil.functions: A function object can be called from inside a template file.
FunctionEvaluator - Class in io.github.erdos.stencil.functions
FunctionEvaluator() - Constructor for class io.github.erdos.stencil.functions.FunctionEvaluator

G

getAllFragmentNames() - Method in class io.github.erdos.stencil.TemplateVariables
getAllVariables() - Method in class io.github.erdos.stencil.TemplateVariables: Returns all variable paths as an immutable set.
getData() - Method in class io.github.erdos.stencil.TemplateData: Returns contained data as a possibly nested map.
getDescription() - Method in class io.github.erdos.stencil.standalone.ArgsParser.ParamMarker
getExpression() - Method in exception io.github.erdos.stencil.exceptions.ParsingException
getFunctionEvaluator() - Method in class io.github.erdos.stencil.impl.NativeEvaluator: It can be used to externally add function definitions.
getLongName() - Method in class io.github.erdos.stencil.standalone.ArgsParser.ParamMarker
getName() - Method in enum io.github.erdos.stencil.functions.BasicFunctions
getName() - Method in enum io.github.erdos.stencil.functions.DateFunctions
getName() - Method in interface io.github.erdos.stencil.functions.Function: Name of the function used as function identifier.
getName() - Method in enum io.github.erdos.stencil.functions.LocaleFunctions
getName() - Method in enum io.github.erdos.stencil.functions.NumberFunctions
getName() - Method in enum io.github.erdos.stencil.functions.StringFunctions
getOnlyIncludes(ArgsParser.ParseResult) - Static method in class io.github.erdos.stencil.standalone.StencilArgsParser: If specified, only inlclude directives will be evaluated in template.
getOutputDirectory(ArgsParser.ParseResult) - Static method in class io.github.erdos.stencil.standalone.StencilArgsParser: Finds output directory in parsed parameters or returns current working directory.
getOutputOverwritten(ArgsParser.ParseResult) - Static method in class io.github.erdos.stencil.standalone.StencilArgsParser: Finds output directory in parsed parameters or returns current working directory.
getParamValue(ArgsParser.ParamMarker<T>) - Method in class io.github.erdos.stencil.standalone.ArgsParser.ParseResult
getRestArgs() - Method in class io.github.erdos.stencil.standalone.ArgsParser.ParseResult
getTemplateFile() - Method in interface io.github.erdos.stencil.PreparedTemplate: Original template file that was preprocessed.
getTemplateFormat() - Method in interface io.github.erdos.stencil.PreparedTemplate: Format of template file.
getTemplatesDirectory() - Method in class io.github.erdos.stencil.impl.DirWatcherTemplateFactory
getTemporaryDirectoryOverride() - Method in class io.github.erdos.stencil.PrepareOptions: Used to override the default temporary directory that is used to store prepared templates.
getVariables() - Method in interface io.github.erdos.stencil.PreparedTemplate: Set of template variables found in file.

I

InputStreamExceptionPropagation - Class in io.github.erdos.stencil.impl
InputStreamExceptionPropagation(InputStream) - Constructor for class io.github.erdos.stencil.impl.InputStreamExceptionPropagation
io.github.erdos.stencil - package io.github.erdos.stencil
io.github.erdos.stencil.exceptions - package io.github.erdos.stencil.exceptions
io.github.erdos.stencil.functions - package io.github.erdos.stencil.functions: Custom Functions
io.github.erdos.stencil.impl - package io.github.erdos.stencil.impl
io.github.erdos.stencil.standalone - package io.github.erdos.stencil.standalone
isFlag() - Method in class io.github.erdos.stencil.standalone.ArgsParser.ParamMarker
ISO8601 - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
isOnlyIncludes() - Method in class io.github.erdos.stencil.PrepareOptions

J

JOBS_FILE - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: A file that contains job data.
JOBS_FROM_STDIN - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser
JOIN - io.github.erdos.stencil.functions.StringFunctions
JSON - io.github.erdos.stencil.standalone.Parser.DataFileFormat
JsonParser - Class in io.github.erdos.stencil.standalone: A naive implementation based on recursive descent parsing.
JsonParser() - Constructor for class io.github.erdos.stencil.standalone.JsonParser

L

LifecycleLock - Class in io.github.erdos.stencil.impl
LifecycleLock(Runnable) - Constructor for class io.github.erdos.stencil.impl.LifecycleLock
listFunctions() - Method in class io.github.erdos.stencil.functions.FunctionEvaluator: Returns a thread-safe sequence of all registered functions.
LocaleFunctions - Enum in io.github.erdos.stencil.functions
LOWERCASE - io.github.erdos.stencil.functions.StringFunctions: Returns lowercase string of input.

M

main(String...) - Static method in class io.github.erdos.stencil.Main
Main - Class in io.github.erdos.stencil
Main() - Constructor for class io.github.erdos.stencil.Main
maybeDataFileFormat(File) - Static method in class io.github.erdos.stencil.standalone.Parser

N

NativeEvaluator - Class in io.github.erdos.stencil.impl: Default implementation that calls the engine written in Clojure.
NativeEvaluator() - Constructor for class io.github.erdos.stencil.impl.NativeEvaluator
NativeTemplateFactory - Class in io.github.erdos.stencil.impl
NativeTemplateFactory() - Constructor for class io.github.erdos.stencil.impl.NativeTemplateFactory
NumberFunctions - Enum in io.github.erdos.stencil.functions: Common numeric functions.

O

ODP - io.github.erdos.stencil.TemplateDocumentFormats: OpenDocument presentation files for LibreOffice.
ODT - io.github.erdos.stencil.TemplateDocumentFormats: OpenDocument Text Document for LibreOffice.
ofExtension(String) - Static method in enum io.github.erdos.stencil.TemplateDocumentFormats
ONLY_INLCUDES - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: Only evaluate fragment include directives.
options() - Static method in class io.github.erdos.stencil.PrepareOptions
OUTPUT_DIR - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: Result files are placed in this directory.
OVERWRITE - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: Result files will be overwritten when already exist in target directory.

P

parse(File) - Method in enum io.github.erdos.stencil.standalone.Parser.DataFileFormat
parse(String) - Static method in class io.github.erdos.stencil.standalone.JsonParser: Parses string and returns read object if any.
parse(String...) - Method in class io.github.erdos.stencil.standalone.ArgsParser
parse(String...) - Static method in class io.github.erdos.stencil.standalone.StencilArgsParser
Parser - Class in io.github.erdos.stencil.standalone
Parser() - Constructor for class io.github.erdos.stencil.standalone.Parser
PARSER - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser
Parser.DataFileFormat - Enum in io.github.erdos.stencil.standalone
ParsingException - Exception in io.github.erdos.stencil.exceptions: This class indicates an error while reading and parsing a stencil expression.
PATTERNS - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
PERCENT - io.github.erdos.stencil.functions.LocaleFunctions: Formats number as a localized percentage value.
PPTX - io.github.erdos.stencil.TemplateDocumentFormats: Microsoft PowerPoint Open XML Presentation file.
prepare(File) - Static method in class io.github.erdos.stencil.API: Prepares a document template file from the file system.
prepare(File, PrepareOptions) - Static method in class io.github.erdos.stencil.API: Prepares a document template file from the file system.
PreparedFragment - Interface in io.github.erdos.stencil
PreparedTemplate - Interface in io.github.erdos.stencil: Represents an already preprocessed template file.
prepareFragmentFile(File, PrepareOptions) - Method in class io.github.erdos.stencil.impl.NativeTemplateFactory
PrepareOptions - Class in io.github.erdos.stencil
prepareTemplateFile(File) - Method in interface io.github.erdos.stencil.TemplateFactory
prepareTemplateFile(File, PrepareOptions) - Method in class io.github.erdos.stencil.impl.CachingTemplateFactory
prepareTemplateFile(File, PrepareOptions) - Method in class io.github.erdos.stencil.impl.DirWatcherTemplateFactory
prepareTemplateFile(File, PrepareOptions) - Method in class io.github.erdos.stencil.impl.NativeTemplateFactory
prepareTemplateFile(File, PrepareOptions) - Method in interface io.github.erdos.stencil.TemplateFactory: Preprocesses a raw template file.

R

read(Reader) - Static method in class io.github.erdos.stencil.standalone.JsonParser
registerFunctions(Function...) - Method in class io.github.erdos.stencil.functions.FunctionEvaluator: Registers a function to this evaluator engine.
removeExtension(File) - Static method in class io.github.erdos.stencil.impl.FileHelper: Returns file name without extension part.
render(PreparedTemplate, TemplateData) - Static method in class io.github.erdos.stencil.API
render(PreparedTemplate, Map<String, PreparedFragment>, TemplateData) - Static method in class io.github.erdos.stencil.API
render(PreparedTemplate, Map<String, PreparedFragment>, TemplateData) - Method in class io.github.erdos.stencil.impl.NativeEvaluator: Evaluates a preprocessed template using the given data.
render(PreparedTemplate, Map<String, PreparedFragment>, TemplateData, Collection<Function>) - Static method in class io.github.erdos.stencil.API
render(Map<String, PreparedFragment>, FunctionEvaluator, TemplateData) - Method in interface io.github.erdos.stencil.PreparedTemplate: Renders the current prepared template file with the given template data.
RFC1036 - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
RFC1123 - Static variable in enum io.github.erdos.stencil.functions.DateFunctions
ROUND - io.github.erdos.stencil.functions.NumberFunctions: Rounds a number to the nearest integer.
run() - Method in class io.github.erdos.stencil.standalone.StandaloneApplication

S

SHOW_HELP - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: Should display help message.
SHOW_VERSION - Static variable in class io.github.erdos.stencil.standalone.StencilArgsParser: Should display version info.
StandaloneApplication - Class in io.github.erdos.stencil.standalone
StandaloneApplication(ArgsParser.ParseResult) - Constructor for class io.github.erdos.stencil.standalone.StandaloneApplication
start() - Method in class io.github.erdos.stencil.impl.DirWatcherTemplateFactory: Starts directory watcher and tries to load all files.
StencilArgsParser - Class in io.github.erdos.stencil.standalone
stop() - Method in class io.github.erdos.stencil.impl.DirWatcherTemplateFactory
STR - io.github.erdos.stencil.functions.StringFunctions: Converts parameters to strings and concatenates the result.
StringFunctions - Enum in io.github.erdos.stencil.functions: Common string functions.
SWITCH - io.github.erdos.stencil.functions.BasicFunctions: Selects value based on first argument.

T

TemplateData - Class in io.github.erdos.stencil: Contains data to fill template documents.
TemplateDocumentFormats - Enum in io.github.erdos.stencil: These types are used when preprocessing a template document.
TemplateFactory - Interface in io.github.erdos.stencil
TemplateVariables - Class in io.github.erdos.stencil: Holds information about variables found in template file.
throwWhenInvalid(TemplateData) - Method in class io.github.erdos.stencil.TemplateVariables: Throws IllegalArgumentException exception when template data is missing values for schema.
TITLECASE - io.github.erdos.stencil.functions.StringFunctions: Converts Every First Letter Of Every Word To Upper Case.
toInputStream(ExecutorService) - Method in interface io.github.erdos.stencil.EvaluatedDocument: Creates a blocking input stream that can be used to render generated document.
toUnixSeparatedString(Path) - Static method in class io.github.erdos.stencil.impl.FileHelper: Returns a string representation of path with unix separators ("/") instead of the system-dependent separators (which is backslash on Windows).
TXT - io.github.erdos.stencil.TemplateDocumentFormats: Simple text file without formatting.

U

unzipStreamIntoDirectory(InputStream, File) - Static method in class io.github.erdos.stencil.impl.ZipHelper: Unzips contents of a zip file under the target directory.
UPPERCASE - io.github.erdos.stencil.functions.StringFunctions: Returns UPPERCASE string of input.

V

valueOf(String) - Static method in enum io.github.erdos.stencil.functions.BasicFunctions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.functions.DateFunctions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.functions.LocaleFunctions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.functions.NumberFunctions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.functions.StringFunctions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.standalone.Parser.DataFileFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.erdos.stencil.TemplateDocumentFormats: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.erdos.stencil.functions.BasicFunctions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.functions.DateFunctions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.functions.LocaleFunctions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.functions.NumberFunctions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.functions.StringFunctions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.standalone.Parser.DataFileFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.erdos.stencil.TemplateDocumentFormats: Returns an array containing the constants of this enum type, in the order they are declared.

W

withOnlyIncludes() - Method in class io.github.erdos.stencil.PrepareOptions: When marked withOnlyIncludes, then the prepared template will evaluate only fragment include directives and not other expressions.
withTemporaryDirectoryOverride(File) - Method in class io.github.erdos.stencil.PrepareOptions
wrapping(String, Exception) - Static method in exception io.github.erdos.stencil.exceptions.ParsingException
write(OutputStream) - Method in interface io.github.erdos.stencil.EvaluatedDocument
writeToFile(File) - Method in interface io.github.erdos.stencil.EvaluatedDocument: Writes output of this document to a file

X

XML - io.github.erdos.stencil.TemplateDocumentFormats: Raw XML file.

Z

ZipHelper - Class in io.github.erdos.stencil.impl: Various helpers for handling ZIP files.

A B C D E F G I J L M N O P R S T U V W X Z
All Classes All Packages