KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > ext > beans > ArrayModel


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.ext.beans;
54
55 import java.lang.reflect.Array JavaDoc;
56
57 import freemarker.ext.util.ModelFactory;
58 import freemarker.template.ObjectWrapper;
59 import freemarker.template.TemplateCollectionModel;
60 import freemarker.template.TemplateModel;
61 import freemarker.template.TemplateModelException;
62 import freemarker.template.TemplateModelIterator;
63 import freemarker.template.TemplateSequenceModel;
64
65 /**
66  * <p>A class that will wrap an arbitrary array into {@link TemplateCollectionModel}
67  * and {@link TemplateSequenceModel} interfaces. It supports element retrieval through the <tt>array[index]</tt>
68  * syntax and can be iterated as a list.
69  * @author Attila Szegedi
70  * @version $Id: ArrayModel.java,v 1.26 2003/06/03 13:21:32 szegedia Exp $
71  */

72 public class ArrayModel
73 extends
74     BeanModel
75 implements
76     TemplateCollectionModel,
77     TemplateSequenceModel
78 {
79     static final ModelFactory FACTORY =
80         new ModelFactory()
81         {
82             public TemplateModel create(Object JavaDoc object, ObjectWrapper wrapper)
83             {
84                 return new ArrayModel(object, (BeansWrapper)wrapper);
85             }
86         };
87         
88     // Cached length of the array
89
private int length;
90
91     /**
92      * Creates a new model that wraps the specified array object.
93      * @param array the array object to wrap into a model.
94      * @param wrapper the {@link BeansWrapper} associated with this model.
95      * Every model has to have an associated {@link BeansWrapper} instance. The
96      * model gains many attributes from its wrapper, including the caching
97      * behavior, method exposure level, method-over-item shadowing policy etc.
98      * @throws IllegalArgumentException if the passed object is not a Java array.
99      */

100     public ArrayModel(Object JavaDoc array, BeansWrapper wrapper)
101     {
102         super(array, wrapper);
103         Class JavaDoc clazz = array.getClass();
104         if(!clazz.isArray())
105             throw new IllegalArgumentException JavaDoc("Object is not an array, it is " + array.getClass().getName());
106         length = Array.getLength(array);
107     }
108
109
110     public TemplateModelIterator iterator()
111     {
112         return new Iterator();
113     }
114
115     public TemplateModel get(int index)
116     throws
117         TemplateModelException
118     {
119         try
120         {
121             return wrap(Array.get(object, index));
122         }
123         catch(IndexOutOfBoundsException JavaDoc e)
124         {
125             throw new TemplateModelException("Index out of bounds: " + index);
126         }
127     }
128
129     private class Iterator
130     implements
131         TemplateSequenceModel,
132         TemplateModelIterator
133     {
134         private int position = 0;
135
136         public boolean hasNext()
137         {
138             return position < length;
139         }
140
141         public TemplateModel get(int index)
142         throws
143             TemplateModelException
144         {
145             return ArrayModel.this.get(index);
146         }
147
148         public TemplateModel next()
149         throws
150             TemplateModelException
151         {
152             return position < length ? get(position++) : null;
153         }
154
155         public int size()
156         {
157             return ArrayModel.this.size();
158         }
159     }
160
161     public int size()
162     {
163         return length;
164     }
165
166     public boolean isEmpty() {
167         return length == 0;
168     }
169 }
170
Popular Tags