freemarker.template
Interface TemplateCollectionModel

All Superinterfaces:

TemplateModel

All Known Implementing Classes:

ArrayModel, CollectionAndSequence, CollectionModel, EnumerationModel, IteratorModel, JythonSequenceModel, NodeListModel, SimpleCollection

public interface TemplateCollectionModel
extends TemplateModel

This interface can be implemented by a class 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, use a TemplateSequenceModel instead.

Version:

$Id: TemplateCollectionModel.java,v 1.10 2003/01/12 23:40:21 revusky Exp $

Author:

Attila Szegedi, szegedia at users dot sourceforge dot net

See Also:

SimpleSequence, SimpleCollection

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Method Summary

TemplateModelIterator

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

Method Detail

iterator

TemplateModelIterator iterator()
                               throws TemplateModelException

Retrieves a template model iterator that is used to iterate over the elements in this collection.

Throws:

TemplateModelException