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 "sí"; else return "yes"; } };
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface freemarker.template.TemplateModel
TemplateModel.InvalidExpressionModel, TemplateModel.JavaNull
-
-
Field Summary
-
Fields inherited from interface freemarker.template.TemplateModel
INVALID_EXPRESSION, JAVA_NULL, 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 StringgetAsString()Returns the string representation of this model.abstract StringgetLocalizedString(Locale locale)
-
-
-
Method Detail
-
getAsString
public String getAsString() throws TemplateModelException
Description copied from interface:TemplateScalarModelReturns 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:
getAsStringin interfaceTemplateScalarModel- Throws:
TemplateModelException
-
getLocalizedString
public abstract String getLocalizedString(Locale locale) throws TemplateModelException
- Throws:
TemplateModelException
-
-