freemarker.template

Interface TemplateScalarModel

All Superinterfaces:
TemplateModel
Known Implementing Classes:
CollectionModel, JythonHashModel, JythonModel, JythonNumberModel, JythonSequenceModel, LocalizedString, MapModel, NodeListModel, NodeListModel, ResourceBundleLocalizedString, SimpleScalar, StringModel

public interface TemplateScalarModel
extends TemplateModel

String values in a template data model must implement this interface. (Actually, the name of this interface should be TemplateStringModel. The bad name was inherited from the ancient times, when there was only 1 kind of scalars in FreeMarker.)
Version:
$Id: TemplateScalarModel.java,v 1.18 2004/11/28 12:58:33 ddekany Exp $

Field Summary

static TemplateModel
EMPTY_STRING
A constant value to use as the empty string.

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Method Summary

String
getAsString()
Returns the string representation of this model.

Field Details

EMPTY_STRING

public static final TemplateModel EMPTY_STRING
A constant value to use as the empty string.

Method Details

getAsString

public String getAsString()
            throws TemplateModelException
Returns the string representation of this model. In general, avoid returning null. In compatibility mode the engine will convert null into empty string, however in normal mode it will throw an exception if you return null from this method.