freemarker.ext.beans2
Class ConvertToString

java.lang.Object
  freemarker.ext.beans2.ConvertToString

All Implemented Interfaces:

Converter

public class ConvertToString
extends java.lang.Object
implements Converter

Returns a String value for a given scalar model.

Since:

1.9

Version:

$Id: ConvertToString.java 1067 2011-06-06 10:55:28Z run2000 $

Author:

Nicholas Cull

Method Summary

java.lang.Object	convert(TemplateModel model) Convert the given template model into the target object type represented by this converter.
boolean	converts(TemplateModel model, java.lang.Class<?> target) Determines whether this converter can convert from the given template model into an instance of the given class target.
static ConvertToString	getInstance() Returns the singleton instance of this converter.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ConvertToString getInstance()

Returns the singleton instance of this converter.

Returns:

the singleton instance of this converter

convert

public java.lang.Object convert(TemplateModel model)
                         throws java.lang.IllegalArgumentException,
                                java.lang.NullPointerException,
                                TemplateModelException

Description copied from interface: Converter

Convert the given template model into the target object type represented by this converter. Callers of this method should first call Converter.converts(freemarker.template.TemplateModel, java.lang.Class) to determine whether this converter can perform the requested conversion.

Specified by:

convert in interface Converter

Parameters:

model - the template model to be converted

Returns:

the converted template model to the target object type represented by this converter

Throws:

java.lang.IllegalArgumentException - the template model was of the wrong type for this converter

java.lang.NullPointerException - the template model is null

TemplateModelException - there was an error while retrieving a value from the template model

converts

public boolean converts(TemplateModel model,
                        java.lang.Class<?> target)

Description copied from interface: Converter

Determines whether this converter can convert from the given template model into an instance of the given class target. The specified target may be a superclass or superinterface of the object ultimately returned.

Specified by:

converts in interface Converter

Parameters:

model - the template model to be converted

target - the target class for the conversion

Returns:

true if this converter can convert the given template model to an instance of the target class, otherwise false