freemarker.template
Interface TemplateCollectionModel

All Superinterfaces:
TemplateModel
All Known Implementing Classes:
CollectionModel, ArrayModel, NodeListModel

public interface TemplateCollectionModel
extends TemplateModel

This interface can be implemented to make a variable "foreach-able", i.e. the model can be used as the list in a <foreach...> or a <list...> directive. Use this model when your collection does not support index-based access and possibly, the size cannot be known in advance. If you need index-based access, you need a TemplateSequenceModel

Version:
$Id: TemplateCollectionModel.java,v 1.2 2002/04/17 11:03:41 revusky Exp $
Author:
Attila Szegedi, szegedia at users dot sourceforge dot net
See Also:
SimpleSequence

Method Summary
 TemplateModelIterator iterator()
          Retrieves a template model iterator that is used to iterate over the elements in this collection.
 
Methods inherited from interface freemarker.template.TemplateModel
isEmpty
 

Method Detail

iterator

public TemplateModelIterator iterator()
                               throws TemplateModelException
Retrieves a template model iterator that is used to iterate over the elements in this collection.