freemarker.template
Interface TemplateWriteableIteratorModel

All Superinterfaces:
TemplateIteratorModel, TemplateModel
All Known Implementing Classes:
FastIndexedWriteableIterator, FastListIterator, ListIteratorWrapper

public interface TemplateWriteableIteratorModel
extends TemplateIteratorModel

Writeable template iterator models that that iterate over a TemplateListModel2 must implement this interface. The interface is similar to the java.util.ListIterator interface, so that such iterators can be transparently wrapped in a TemplateWriteableIteratorModel implementation.

Since:
1.9
Version:
$Id: TemplateWriteableIteratorModel.java 1067 2011-06-06 10:55:28Z run2000 $

Method Summary
 void set(TemplateModel model)
          Inserts the specified element into the list.
 
Methods inherited from interface freemarker.template.TemplateIteratorModel
hasNext, next
 
Methods inherited from interface freemarker.template.TemplateModel
isEmpty
 

Method Detail

set

void set(TemplateModel model)
         throws TemplateModelException
Inserts the specified element into the list. The element is inserted immediately before the element that would be returned by next(), if any.

Parameters:
model - the model to insert into the list
Throws:
TemplateModelException - the model could not be assigned to the current item of the list, or next() has not be called yet