|Home >> All >> freemarker >> [ core Javadoc ]|
freemarker.core: Javadoc index of package freemarker.core.
Environment: Object that represents the runtime environment during template processing. For every invocation of a Template.process() method, a new instance of this object is created, and then discarded when process() returns. This object stores the set of temporary variables created by the template, the value of settings set by the template, the reference to the data model root, etc. Everything that is needed to fulfill the template processing job. Data models that need to access the Environment object that represents the template processing on the current thread can use the getCurrentEnvironment() 55 method. ...
Configurable: This is a common superclass of freemarker.template.Configuration , freemarker.template.Template , and Environment classes. It provides settings that are common to each of them. FreeMarker uses a three-level setting hierarchy - the return value of every setting getter method on Configurable objects inherits its value from its parent Configurable object, unless explicitly overridden by a call to a corresponding setter method on the object itself. The parent of an Environment object is a Template object, the parent of a Template object is a Configuration object.
Interpret: A method that takes a parameter and evaluates it as a scalar, then treats that scalar as template source code and returns a transform model that evaluates the template in place. The template inherits the configuration and environment of the executing template. By default, its name will be equal to executingTemplate.getName() + "$anonymous_interpreted" . You can specify another parameter to the method call in which case the template name suffix is the specified id instead of "anonymous_interpreted".
ParseException: This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. You can modify this class to customize your error reporting mechanisms so long as you retain the public fields.
CustomAttribute: A class that allows one to associate custom data with a configuration, a template, or environment. It works pretty much like java.lang.ThreadLocal , a class that allows one to associate custom data with a thread.
LocalContext: An interface that represents a local context. This is used as the abstraction for the context of a Macro invocation, a loop, or the nested block call from within a macro. Jonathan Revusky
StringArraySequence: Sequence variable implementation that wraps a String with relatively low resource utilization. Warning: it does not copy the wrapped array, so do not modify that after the model was made!
RegexBuiltins: This is a first-pass implementation of regular expression support. It is subject to change based on community feedback. In that sense, use it at your own risk.
AddConcatExpression: An operator for the + operator. Note that this is treated separately from the other 4 arithmetic operators, since + is overloaded to mean string concatenation.
DynamicKeyName: A unary operator that uses the string value of an expression as a hash key. It associates with the Identifier or Dot to its left.
NewBI: A built-in that allows us to instantiate an instance of a java class. Usage is something like: <#assign foobar = "foo.bar.MyClass"?new() />
NonStringException: A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a string or numeric value and it didn't.
TemplateObject: Objects that represent instructions or expressions in the compiled tree representation of the template all descend from this abstract base class.
CompressedBlock: An instruction that reduces all sequences of whitespace to a single space or newline. In addition, leading and trailing whitespace is removed.
NonNumericalException: A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a numerical value and it didn't.
NonBooleanException: A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a boolean value and it didn't.
SimpleCharStream: An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
TemplateElement: Objects that represent elements in the compiled tree representation of the template necessarily descend from this abstract class.
MethodCall: A unary operator that calls a TemplateMethodModel. It associates with the Identifier or Dot to its left.
ArithmeticExpression: An operator for arithmetic operations. Note that the + operator also does string concatenation for backward compatibility.
TransformBlock: A template element that contains a nested block that is transformed according to an instance of T TemplateTransformModel
CommandLine: FreeMarker command-line utility, the Main-Class of freemarker.jar . Currently it just prints the version number.
NumericalRange: A class that represents a Range between two integers. inclusive of the end-points. It can be ascending or descending.