freemarker.template
Interface TemplateWriteableHashModel

All Superinterfaces:
TemplateHashModel, TemplateModel
All Known Subinterfaces:
TemplateModelRoot
All Known Implementing Classes:
BeanWrapper, CollectionWrapper, EnumerationWrapper, EnumWrapper, ExtendedHash, FastHash, IterableWrapper, IteratorWrapper, ListIteratorWrapper, ListWrapper, LocalModelWrapper, MapWrapper, PropertiesWrapper, RootMapModel, RootModelWrapper, SimpleHash, StaticClassWrapper, StaticEnumWrapper

public interface TemplateWriteableHashModel
extends TemplateHashModel

Writeable hashes in a template data model must implement this interface. In addition, the root node of a template data model must implement this interface.

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

Since:
1.9
Version:
$Id: TemplateWriteableHashModel.java 1067 2011-06-06 10:55:28Z run2000 $
See Also:
TemplateHashModel, TemplateModelRoot

Method Summary
 void put(java.lang.String key, TemplateModel model)
          Sets a value in the hash model.
 
Methods inherited from interface freemarker.template.TemplateHashModel
get
 
Methods inherited from interface freemarker.template.TemplateModel
isEmpty
 

Method Detail

put

void put(java.lang.String key,
         TemplateModel model)
         throws TemplateModelException
Sets a value in the hash model.

Parameters:
key - the name by which the TemplateModel is identified in the template
model - the value to be set with the given key for this hash model
Throws:
TemplateModelException - there was a problem setting the value for the given key