freemarker.template

Interface TemplateCollectionModel

All Superinterfaces:

TemplateModel

All Known Implementing Classes:

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

public interface TemplateCollectionModel
extends TemplateModel

"collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once). This is very similar to TemplateSequenceModel, but it doesn't support indexed (random) access and its size can't be queried.

They are mostly used in template languages like <#list myCollection as i>...</#list>.

Author:

Attila Szegedi, szegedia at users dot sourceforge dot net

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Method Summary

Methods

Modifier and Type	Method and Description
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