001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.ext.beans;
054:
055: import java.lang.reflect.Array;
056:
057: import freemarker.ext.util.ModelFactory;
058: import freemarker.template.ObjectWrapper;
059: import freemarker.template.TemplateCollectionModel;
060: import freemarker.template.TemplateModel;
061: import freemarker.template.TemplateModelException;
062: import freemarker.template.TemplateModelIterator;
063: import freemarker.template.TemplateSequenceModel;
064:
065: /**
066: * <p>A class that will wrap an arbitrary array into {@link TemplateCollectionModel}
067: * and {@link TemplateSequenceModel} interfaces. It supports element retrieval through the <tt>array[index]</tt>
068: * syntax and can be iterated as a list.
069: * @author Attila Szegedi
070: * @version $Id: ArrayModel.java,v 1.26 2003/06/03 13:21:32 szegedia Exp $
071: */
072: public class ArrayModel extends BeanModel implements
073: TemplateCollectionModel, TemplateSequenceModel {
074: static final ModelFactory FACTORY = new ModelFactory() {
075: public TemplateModel create(Object object, ObjectWrapper wrapper) {
076: return new ArrayModel(object, (BeansWrapper) wrapper);
077: }
078: };
079:
080: // Cached length of the array
081: private int length;
082:
083: /**
084: * Creates a new model that wraps the specified array object.
085: * @param array the array object to wrap into a model.
086: * @param wrapper the {@link BeansWrapper} associated with this model.
087: * Every model has to have an associated {@link BeansWrapper} instance. The
088: * model gains many attributes from its wrapper, including the caching
089: * behavior, method exposure level, method-over-item shadowing policy etc.
090: * @throws IllegalArgumentException if the passed object is not a Java array.
091: */
092: public ArrayModel(Object array, BeansWrapper wrapper) {
093: super (array, wrapper);
094: Class clazz = array.getClass();
095: if (!clazz.isArray())
096: throw new IllegalArgumentException(
097: "Object is not an array, it is "
098: + array.getClass().getName());
099: length = Array.getLength(array);
100: }
101:
102: public TemplateModelIterator iterator() {
103: return new Iterator();
104: }
105:
106: public TemplateModel get(int index) throws TemplateModelException {
107: try {
108: return wrap(Array.get(object, index));
109: } catch (IndexOutOfBoundsException e) {
110: throw new TemplateModelException("Index out of bounds: "
111: + index);
112: }
113: }
114:
115: private class Iterator implements TemplateSequenceModel,
116: TemplateModelIterator {
117: private int position = 0;
118:
119: public boolean hasNext() {
120: return position < length;
121: }
122:
123: public TemplateModel get(int index)
124: throws TemplateModelException {
125: return ArrayModel.this .get(index);
126: }
127:
128: public TemplateModel next() throws TemplateModelException {
129: return position < length ? get(position++) : null;
130: }
131:
132: public int size() {
133: return ArrayModel.this .size();
134: }
135: }
136:
137: public int size() {
138: return length;
139: }
140:
141: public boolean isEmpty() {
142: return length == 0;
143: }
144: }
|