KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > template > ObjectWrapper


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 import freemarker.ext.beans.BeansWrapper;
56
57 /**
58  * <p>An object that knows how to "wrap" a java object
59  * as a TemplateModel instance.
60  *
61  * @version $Id: ObjectWrapper.java,v 1.15 2003/06/22 17:50:28 ddekany Exp $
62  */
63 public interface ObjectWrapper {
64     /**
65      * An ObjectWrapper that works similarly to {@link #SIMPLE_WRAPPER}, but
66      * exposes the objects methods and JavaBeans properties as hash elements
67      * and custom handling for Java Maps, ResourceBundles, etc.
68      */
69     ObjectWrapper BEANS_WRAPPER = BeansWrapper.getDefaultInstance();
70
71     /**
72      * The default object wrapper implementation.
73      * Wraps Maps as SimpleHash and Lists as SimpleSequences, Strings and
74      * Numbers as SimpleScalar and SimpleNumber respectively.
75      * Other objects are beans-wrapped, thus exposing reflection-based information.
76      */
77     ObjectWrapper DEFAULT_WRAPPER = DefaultObjectWrapper.instance;
78
79     /**
80      * Object wrapper that uses SimpleXXX wrappers only.
81      * This wrapper has far more restrictive semantics. It
82      * behaves like the DEFAULT_WRAPPER, but for objects
83      * that it does not know how to wrap as a SimpleXXX, it
84      * throws an exception. It makes no use of reflection-based
85      * exposure of methods.
86      */
87     ObjectWrapper SIMPLE_WRAPPER = SimpleObjectWrapper.instance;
88     
89     /**
90      * @return a TemplateModel wrapper of the object passed in.
91      */
92     TemplateModel wrap(Object JavaDoc obj) throws TemplateModelException;
93 }
94
Popular Tags