freemarker.template
Interface TemplateHashModel

All Superinterfaces:
TemplateModel
All Known Subinterfaces:
TemplateModelRoot, TemplateWriteableHashModel
All Known Implementing Classes:
ArrayModel, ArrayWrapper, BeanWrapper, CollectionModel, CollectionWrapper, ContentEntry, EnumerationModel, EnumerationWrapper, EnumWrapper, ExtendedHash, ExtendedIterator, ExtendedList, FastHash, FastIndexedIterator, FastIndexedWriteableIterator, FastListIterator, HttpRequestHashModel, HttpRequestParametersHashModel, HttpSessionHashModel, IndexedPropertyWrapper, IterableWrapper, IteratorModel, IteratorWrapper, JspContextModel, ListIteratorWrapper, ListModel, ListWrapper, LocalModelWrapper, MapModel, MapWrapper, Methods, NodeListModel, ObjectModel, PropertiesWrapper, ResourceBundleModel, ResourceBundleWrapper, RootMapModel, RootModelWrapper, ServletContextHashModel, SimpleHash, StaticClassWrapper, StaticEnumWrapper, StaticModel, StaticModels, TabItem, Transforms

public interface TemplateHashModel
extends TemplateModel

Hashes in a template data model must implement this interface.

The detail messages of any TemplateModelExceptions thrown will be included as HTML comments in the output.

Version:
$Id: TemplateHashModel.java 1101 2013-04-01 04:17:32Z run2000 $
See Also:
TemplateWriteableHashModel

Method Summary
 TemplateModel get(java.lang.String key)
          Gets a TemplateModel from the hash.
 
Methods inherited from interface freemarker.template.TemplateModel
isEmpty
 

Method Detail

get

TemplateModel get(java.lang.String key)
                  throws TemplateModelException
Gets a TemplateModel from the hash.

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 - there was a problem getting the value for the given key