freemarker.template

Interface TemplateSequenceModel

All Superinterfaces:

TemplateModel

All Known Implementing Classes:

ArrayModel, CollectionModel, JythonSequenceModel, NodeListModel, NodeListModel, NodeModel, OverloadedMethodsModel, RhinoFunctionModel, RhinoScriptableModel, SimpleList, SimpleMethodModel, SimpleSequence, TemplateModelListSequence

public interface TemplateSequenceModel
extends TemplateModel

"sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.

Used in templates like: mySeq[index], <#list mySeq as i>...</#list>, mySeq?size, etc.

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
TemplateModel	get(int index) Retrieves the i-th template model in this sequence.
int	size()

Method Detail

get

TemplateModel get(int index)
                  throws TemplateModelException

Retrieves the i-th template model in this sequence.

Returns:

the item at the specified index, or null if the index is out of bounds. Note that a null value is interpreted by FreeMarker as "variable does not exist", and accessing a missing variables is usually considered as an error in the FreeMarker Template Language, so the usage of a bad index will not remain hidden.

Throws:

TemplateModelException

size

int size()
         throws TemplateModelException

Returns:

the number of items in the list.

Throws:

TemplateModelException