freemarker.template
Interface AdapterTemplateModel

All Superinterfaces:

TemplateModel

All Known Implementing Classes:

ArrayModel, BeanModel, BooleanModel, CollectionModel, DateModel, EnumerationModel, IteratorModel, JythonHashModel, JythonModel, JythonNumberModel, JythonSequenceModel, MapModel, NodeModel, NumberModel, ResourceBundleModel, RhinoFunctionModel, RhinoScriptableModel, SimpleMapModel, StringModel

public interface AdapterTemplateModel
extends TemplateModel

Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces. A class implementing this interface usually serves as an adapter that provides bridging between a different object model and FreeMarker template models. It provides a capability to retrieve the underlying object. This interface is rarely implemented by applications. It is tipically implemented by adapter classes used for wrapping in various object wrapper implementation.

Version:

$Id: AdapterTemplateModel.java,v 1.1 2005/06/12 19:03:07 szegedia Exp $

Author:

Attila Szegedi

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Method Summary

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.

Method Detail

getAdaptedObject

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.

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.