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.template;
054:
055: /**
056: * A base class for containers that wrap arbitrary Java objects into
057: * {@link TemplateModel} instances.
058: *
059: * @version $Id: WrappingTemplateModel.java,v 1.18.2.1 2005/12/07 00:41:23 revusky Exp $
060: */
061: abstract public class WrappingTemplateModel {
062:
063: private static ObjectWrapper defaultObjectWrapper = DefaultObjectWrapper.instance;
064: private ObjectWrapper objectWrapper;
065:
066: /**
067: * Sets the default object wrapper that is used when a wrapping template
068: * model is constructed without being passed an explicit object wrapper.
069: * The default value is {@link ObjectWrapper#SIMPLE_WRAPPER}.
070: * Note that {@link Configuration#setSharedVariable(String, Object)} and
071: * {@link Template#process(Object, java.io.Writer)} don't use this setting,
072: * they rather use whatever object wrapper their
073: * {@link Configuration#getObjectWrapper()} method returns.
074: */
075: public static void setDefaultObjectWrapper(
076: ObjectWrapper objectWrapper) {
077: defaultObjectWrapper = objectWrapper;
078: }
079:
080: /**
081: * Returns the default object wrapper that is used when a wrapping template
082: * model is constructed without being passed an explicit object wrapper.
083: * Note that {@link Configuration#setSharedVariable(String, Object)} and
084: * {@link Template#process(Object, java.io.Writer)} don't use this setting,
085: * they rather use whatever object wrapper their
086: * {@link Configuration#getObjectWrapper()} method returns.
087: */
088: public static ObjectWrapper getDefaultObjectWrapper() {
089: return defaultObjectWrapper;
090: }
091:
092: /**
093: * Protected constructor that creates a new wrapping template model using
094: * the default object wrapper.
095: */
096: protected WrappingTemplateModel() {
097: this (defaultObjectWrapper);
098: }
099:
100: /**
101: * Protected constructor that creates a new wrapping template model using
102: * the specified object wrapper.
103: * @param objectWrapper the wrapper to use. If null is passed, the default
104: * object wrapper is used.
105: */
106: protected WrappingTemplateModel(ObjectWrapper objectWrapper) {
107: this .objectWrapper = objectWrapper != null ? objectWrapper
108: : defaultObjectWrapper;
109: if (this .objectWrapper == null) {
110: this .objectWrapper = defaultObjectWrapper = new DefaultObjectWrapper();
111: }
112: }
113:
114: /**
115: * Returns the object wrapper instance used by this wrapping template model.
116: */
117: public ObjectWrapper getObjectWrapper() {
118: return objectWrapper;
119: }
120:
121: public void setObjectWrapper(ObjectWrapper objectWrapper) {
122: this .objectWrapper = objectWrapper;
123: }
124:
125: /**
126: * Wraps the passed object into a template model using this object's object
127: * wrapper.
128: * @param obj the object to wrap
129: * @return the template model that wraps the object
130: * @throws TemplateModelException if the wrapper does not know how to
131: * wrap the passed object.
132: */
133: protected final TemplateModel wrap(Object obj)
134: throws TemplateModelException {
135: return objectWrapper.wrap(obj);
136: }
137: }
|