KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > CollectionAndSequence


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.core;
54
55 import freemarker.template.*;
56 import java.util.*;
57 import java.io.Serializable JavaDoc;
58
59 /**
60  * Add sequence capabilities to an existing collection, or
61  * vice versa. Used by ?keys and ?values built-ins.
62  */

63 final public class CollectionAndSequence
64 implements TemplateCollectionModel, TemplateSequenceModel, Serializable JavaDoc
65 {
66     private TemplateCollectionModel collection;
67     private TemplateSequenceModel sequence;
68     private ArrayList data;
69
70     public CollectionAndSequence(TemplateCollectionModel collection) {
71         this.collection = collection;
72     }
73
74     public CollectionAndSequence(TemplateSequenceModel sequence) {
75         this.sequence = sequence;
76     }
77
78     public TemplateModelIterator iterator() throws TemplateModelException {
79         if (collection != null) {
80             return collection.iterator();
81         } else {
82             return new SequenceIterator(sequence);
83         }
84     }
85
86     public TemplateModel get(int i) throws TemplateModelException {
87         if (sequence != null) {
88             return sequence.get(i);
89         } else {
90             initSequence();
91             return (TemplateModel)data.get(i);
92         }
93     }
94
95     public int size() throws TemplateModelException {
96         if (sequence != null) {
97             return sequence.size();
98         } else {
99             initSequence();
100             return data.size();
101         }
102     }
103
104     private void initSequence() throws TemplateModelException {
105         if (data == null) {
106             data = new ArrayList();
107             TemplateModelIterator it = collection.iterator();
108             while (it.hasNext()) {
109                 data.add(it.next());
110             }
111         }
112     }
113
114     private static class SequenceIterator
115     implements TemplateModelIterator
116     {
117         private final TemplateSequenceModel sequence;
118         private final int size;
119         private int index = 0;
120
121         SequenceIterator(TemplateSequenceModel sequence) throws TemplateModelException {
122             this.sequence = sequence;
123             this.size = sequence.size();
124             
125         }
126         public TemplateModel next() throws TemplateModelException {
127             return sequence.get(index++);
128         }
129
130         public boolean hasNext() {
131             return index < size;
132         }
133     }
134 }
135
Popular Tags