Package freemarker.ext.rhino
Class RhinoScriptableModel
java.lang.Object
freemarker.ext.rhino.RhinoScriptableModel
- All Implemented Interfaces:
AdapterTemplateModel,TemplateBooleanModel,TemplateHashModel,TemplateHashModelEx,TemplateModel,TemplateNumberModel,TemplateScalarModel,TemplateSequenceModel
- Direct Known Subclasses:
RhinoFunctionModel
public class RhinoScriptableModel
extends Object
implements TemplateHashModelEx, TemplateSequenceModel, AdapterTemplateModel, TemplateScalarModel, TemplateBooleanModel, TemplateNumberModel
-
Field Summary
Fields inherited from interface freemarker.template.TemplateBooleanModel
FALSE, TRUEFields inherited from interface freemarker.template.TemplateModel
NOTHINGFields inherited from interface freemarker.template.TemplateScalarModel
EMPTY_STRING -
Constructor Summary
ConstructorsConstructorDescriptionRhinoScriptableModel(org.mozilla.javascript.Scriptable scriptable, BeansWrapper wrapper) -
Method Summary
Modifier and TypeMethodDescriptionget(int index)Retrieves the i-th template model in this sequence.Gets aTemplateModelfrom the hash.getAdaptedObject(Class hint)Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.booleanReturns the numeric value.Returns theStringrepresentation of this model.booleanisEmpty()keys()intsize()values()
-
Constructor Details
-
RhinoScriptableModel
-
-
Method Details
-
get
Description copied from interface:TemplateHashModelGets aTemplateModelfrom the hash.- Specified by:
getin interfaceTemplateHashModel- Parameters:
key- The name by which theTemplateModelis identified in the template.- Returns:
- The
TemplateModelreferred to by the key, ornullif not found. - Throws:
TemplateModelException
-
get
Description copied from interface:TemplateSequenceModelRetrieves the i-th template model in this sequence.- Specified by:
getin interfaceTemplateSequenceModel- Returns:
- the item at the specified index, or
nullif the index is out of bounds. Note that anullvalue is interpreted by FreeMarker as "variable does not exist", and accessing a missing variables is usually considered as an error in the FreeMarker Template Language, so the usage of a bad index will not remain hidden, unless the default value for that case was also specified in the template. - Throws:
TemplateModelException
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfaceTemplateHashModel
-
keys
- Specified by:
keysin interfaceTemplateHashModelEx- Returns:
- a collection containing the keys in the hash. Every element of
the returned collection must implement the
TemplateScalarModel(as the keys of hashes are always strings). - Throws:
TemplateModelException
-
size
public int size()- Specified by:
sizein interfaceTemplateHashModelEx- Specified by:
sizein interfaceTemplateSequenceModel- Returns:
- the number of key/value mappings in the hash.
-
values
- Specified by:
valuesin interfaceTemplateHashModelEx- Returns:
- a collection containing the values in the hash. The elements of the
returned collection can be any kind of
TemplateModel-s. - Throws:
TemplateModelException
-
getAsBoolean
public boolean getAsBoolean()- Specified by:
getAsBooleanin interfaceTemplateBooleanModel- Returns:
- whether to interpret this object as true or false in a boolean context
-
getAsNumber
Description copied from interface:TemplateNumberModelReturns the numeric value. The return value must not benull.- Specified by:
getAsNumberin interfaceTemplateNumberModel- Returns:
- the
Numberinstance associated with this number model.
-
getAsString
Description copied from interface:TemplateScalarModelReturns theStringrepresentation of this model. Returningnullis illegal, and may cause exception in the calling code. (Except, in classic-compatible mode the engine will convertnullinto empty string.)- Specified by:
getAsStringin interfaceTemplateScalarModel
-
getAdaptedObject
Description copied from interface:AdapterTemplateModelRetrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObjectin interfaceAdapterTemplateModel- Parameters:
hint- the desired class of the returned value. An implementation should make reasonable effort to retrieve an object of the requested class, but if that is impossible, it must at least return the underlying object as-is. As a minimal requirement, an implementation must always return the exact underlying object whenhint.isInstance(underlyingObject)holds. When called withjava.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting language object that is further wrapping a Java object, the deepest underlying Java object should be returned).- Returns:
- the underlying object, or its value accommodated for the hint class.
-