Package freemarker.template

Class SimpleScalar

java.lang.Object

freemarker.template.SimpleScalar

All Implemented Interfaces:

TemplateModel, TemplateScalarModel, Serializable

public final class SimpleScalar
extends Object
implements TemplateScalarModel, Serializable

A simple implementation of the TemplateScalarModel interface, using a String. As of version 2.0 this object is immutable.

This class is thread-safe.

See Also:

SimpleSequence, SimpleHash, Serialized Form

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Fields inherited from interface freemarker.template.TemplateScalarModel

EMPTY_STRING

Constructor Summary

Constructors

Constructor	Description
SimpleScalar(String value)	Constructs a SimpleScalar containing a string value.

Method Summary

Modifier and Type	Method	Description
String	getAsString()	Returns the String representation of this model.
static SimpleScalar	newInstanceOrNull(String s)	Same as calling the constructor, except that for a null parameter it returns null.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleScalar

public SimpleScalar(String value)

Constructs a SimpleScalar containing a string value.

Parameters:

value - the string value. If this is null, its value in FTL will be "".

Method Details

getAsString

public String getAsString()

Description copied from interface: TemplateScalarModel

Returns the String representation of this model. Returning null is illegal, and may cause exception in the calling code. (Except, in classic-compatible mode the engine will convert null into empty string.)

Specified by:

getAsString in interface TemplateScalarModel

toString

public String toString()

Overrides:

toString in class Object

newInstanceOrNull

public static SimpleScalar newInstanceOrNull(String s)

Same as calling the constructor, except that for a null parameter it returns null.

Since:

2.3.23