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, TRUE
-
Fields inherited from interface freemarker.template.TemplateModel
NOTHING
-
Fields inherited from interface freemarker.template.TemplateScalarModel
EMPTY_STRING
-
-
Constructor Summary
Constructors Constructor Description RhinoScriptableModel(Scriptable scriptable, BeansWrapper wrapper)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TemplateModel
get(int index)
Retrieves the i-th template model in this sequence.TemplateModel
get(String key)
Gets a TemplateModel from the hash.Object
getAdaptedObject(Class hint)
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.boolean
getAsBoolean()
Number
getAsNumber()
Returns the numeric value.String
getAsString()
Returns the string representation of this model.boolean
isEmpty()
TemplateCollectionModel
keys()
int
size()
TemplateCollectionModel
values()
-
-
-
Constructor Detail
-
RhinoScriptableModel
public RhinoScriptableModel(Scriptable scriptable, BeansWrapper wrapper)
-
-
Method Detail
-
get
public TemplateModel get(String key) throws TemplateModelException
Description copied from interface:TemplateHashModel
Gets a TemplateModel from the hash.- Specified by:
get
in interfaceTemplateHashModel
- Parameters:
key
- the name by which the TemplateModel is identified in the template.- Returns:
- the TemplateModel referred to by the key, or null if not found.
- Throws:
TemplateModelException
-
get
public TemplateModel get(int index) throws TemplateModelException
Description copied from interface:TemplateSequenceModel
Retrieves the i-th template model in this sequence.- Specified by:
get
in interfaceTemplateSequenceModel
- Returns:
- the item at the specified index, or
null
if the index is out of bounds. Note that anull
value 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:
isEmpty
in interfaceTemplateHashModel
-
keys
public TemplateCollectionModel keys() throws TemplateModelException
- Specified by:
keys
in 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:
size
in interfaceTemplateHashModelEx
- Specified by:
size
in interfaceTemplateSequenceModel
- Returns:
- the number of key/value mappings in the hash.
-
values
public TemplateCollectionModel values() throws TemplateModelException
- Specified by:
values
in 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:
getAsBoolean
in interfaceTemplateBooleanModel
- Returns:
- whether to interpret this object as true or false in a boolean context
-
getAsNumber
public Number getAsNumber()
Description copied from interface:TemplateNumberModel
Returns the numeric value. The return value must not be null.- Specified by:
getAsNumber
in interfaceTemplateNumberModel
- Returns:
- the
Number
instance associated with this number model.
-
getAsString
public String getAsString()
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
-
getAdaptedObject
public Object getAdaptedObject(Class hint)
Description copied from interface:AdapterTemplateModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObject
in 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 when hint.isInstance(underlyingObject) holds. When called with java.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.
-
-