Package freemarker.template
Interface TemplateScalarModel
- All Superinterfaces:
TemplateModel
- All Known Implementing Classes:
CollectionModel,GenericObjectModel,JythonHashModel,JythonModel,JythonNumberModel,JythonSequenceModel,LocalizedString,MapModel,NodeListModel,NodeListModel,ResourceBundleLocalizedString,RhinoFunctionModel,RhinoScriptableModel,SimpleScalar,StringModel
"string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.
(The name of this interface should be
TemplateStringModel. The misnomer is inherited from the
old times, when this was the only single-value type in FreeMarker.)
When a template has to print a value of this class, it will assume that it stores plain text (not HTML, XML, etc.),
and thus it will be possibly auto-escaped. To avoid that, use the appropriate TemplateMarkupOutputModel
instead.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic TemplateModelA constant value to use as the empty string.Fields inherited from interface freemarker.template.TemplateModel
NOTHING -
Method Summary
-
Field Details
-
EMPTY_STRING
A constant value to use as the empty string.
-
-
Method Details
-
getAsString
Returns theStringrepresentation of this model. Returningnullis illegal, and may cause exception in the calling code. (Except, in classic-compatible mode the engine will convertnullinto empty string.)- Throws:
TemplateModelException
-