freemarker.template

Class LocalizedString

Implemented Interfaces:
TemplateModel, TemplateScalarModel
Known Direct Subclasses:
ResourceBundleLocalizedString

public abstract class LocalizedString
extends java.lang.Object
implements TemplateScalarModel

An abstract base class for scalars that vary by locale. Here is a silly usage example. TemplateScalarModel localizedYes = new LocalizedString() { public String getLocalizedString(java.util.Locale locale) { String lang = locale.getLanguage(); if "fr".equals(lang) return "oui"; else if "de".equals(lang) return "s?"; else return "yes"; } };
Author:
Jonathan Revusky

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Fields inherited from interface freemarker.template.TemplateScalarModel

EMPTY_STRING

Method Summary

String
getAsString()
Returns the string representation of this model.
abstract String
getLocalizedString(Locale locale)

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.
Specified by:
getAsString in interface TemplateScalarModel

getLocalizedString

public abstract String getLocalizedString(Locale locale)
            throws TemplateModelException