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 java.lang.Object
implements TemplateHashModelEx, TemplateSequenceModel, AdapterTemplateModel, TemplateScalarModel, TemplateBooleanModel, TemplateNumberModel

Experimental: no backward compatibility guarantees; any feedback is highly welcome!

Version:

$Id: RhinoScriptableModel.java,v 1.4 2005/06/22 10:52:52 ddekany Exp $

Author:

Attila Szegedi

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Fields inherited from interface freemarker.template.TemplateScalarModel

EMPTY_STRING

Fields inherited from interface freemarker.template.TemplateBooleanModel

FALSE, TRUE

Constructor Summary

RhinoScriptableModel(org.mozilla.javascript.Scriptable scriptable, BeansWrapper wrapper)

Method Summary

TemplateModel	get(int index) Retrieves the i-th template model in this sequence.
TemplateModel	get(java.lang.String key) Gets a TemplateModel from the hash.
java.lang.Object	getAdaptedObject(java.lang.Class hint) Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
boolean	getAsBoolean()
java.lang.Number	getAsNumber() Returns the numeric value.
java.lang.String	getAsString() Returns the string representation of this model.
boolean	isEmpty()
TemplateCollectionModel	keys()
int	size()
TemplateCollectionModel	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RhinoScriptableModel

public RhinoScriptableModel(org.mozilla.javascript.Scriptable scriptable,
                            BeansWrapper wrapper)

Method Detail

get

public TemplateModel get(java.lang.String key)
                  throws TemplateModelException

Description copied from interface: TemplateHashModel

Gets a TemplateModel from the hash.

Specified by:

get in interface TemplateHashModel

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 interface TemplateSequenceModel

Returns:

the item at the specified index, or null if the index is out of bounds. Note that a null 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.

Throws:

TemplateModelException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface TemplateHashModel

keys

public TemplateCollectionModel keys()
                             throws TemplateModelException

Specified by:

keys in interface TemplateHashModelEx

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 interface TemplateHashModelEx

Specified by:

size in interface TemplateSequenceModel

Returns:

the number of key/value mappings in the hash.

values

public TemplateCollectionModel values()
                               throws TemplateModelException

Specified by:

values in interface TemplateHashModelEx

Returns:

a collection containing the values in the hash.

Throws:

TemplateModelException

getAsBoolean

public boolean getAsBoolean()

Specified by:

getAsBoolean in interface TemplateBooleanModel

Returns:

whether to interpret this object as true or false in a boolean context

getAsNumber

public java.lang.Number getAsNumber()

Description copied from interface: TemplateNumberModel

Returns the numeric value. The return value must not be null.

Specified by:

getAsNumber in interface TemplateNumberModel

Returns:

the Number instance associated with this number model.

getAsString

public java.lang.String getAsString()

Description copied from interface: TemplateScalarModel

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

getAdaptedObject

public java.lang.Object getAdaptedObject(java.lang.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 interface AdapterTemplateModel

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) == true holds. When called with java.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting lanugage 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.