Package freemarker.template
Class LocalizedString
- java.lang.Object
-
- freemarker.template.LocalizedString
-
- All Implemented Interfaces:
TemplateModel
,TemplateScalarModel
- Direct Known Subclasses:
ResourceBundleLocalizedString
public abstract class LocalizedString extends 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 "ja"; else return "yes"; } };
-
-
Field Summary
-
Fields inherited from interface freemarker.template.TemplateModel
NOTHING
-
Fields inherited from interface freemarker.template.TemplateScalarModel
EMPTY_STRING
-
-
Constructor Summary
Constructors Constructor Description LocalizedString()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description String
getAsString()
Returns the string representation of this model.abstract String
getLocalizedString(Locale locale)
-
-
-
Method Detail
-
getAsString
public String getAsString() throws TemplateModelException
Description copied from interface:TemplateScalarModel
Returns the string representation of this model. Don't returnnull
, as that will cause exception. (In classic-compatible mode the engine will convertnull
into empty string, though.)- Specified by:
getAsString
in interfaceTemplateScalarModel
- Throws:
TemplateModelException
-
getLocalizedString
public abstract String getLocalizedString(Locale locale) throws TemplateModelException
- Throws:
TemplateModelException
-
-