KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > template > TemplateSequenceModel


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */
52
53 package freemarker.template;
54
55 /**
56  * List values in a template data model whose elements are accessed by the
57  * index operator should implement this interface. In addition to
58  * accessing elements by index and querying size using the <code>?size</code>
59  * built-in, objects that implement this interface can be iterated in
60  * <code>&lt;#foreach ...></code> and <code>&lt;#list ...></code> directives. The
61  * iteration is implemented by calling the {@link #get(int)} method
62  * repeatedly starting from zero and going to <tt>{@link #size()} - 1</tt>.
63  * @author Attila Szegedi, szegedia at users dot sourceforge dot net
64  * @version $Id: TemplateSequenceModel.java,v 1.10 2004/11/27 14:49:57 ddekany Exp $
65  */
66 public interface TemplateSequenceModel extends TemplateModel {
67
68     /**
69      * Retrieves the i-th template model in this sequence.
70      *
71      * @return the item at the specified index, or <code>null</code> if
72      * the index is out of bounds. Note that a <code>null</code> value is
73      * interpreted by FreeMarker as "variable does not exist", and accessing
74      * a missing variables is usually considered as an error in the FreeMarker
75      * Template Language, so the usage of a bad index will not remain hidden.
76      */
77     TemplateModel get(int index) throws TemplateModelException;
78
79     /**
80      * @return the number of items in the list.
81      */
82     int size() throws TemplateModelException;
83 }
84
Popular Tags