Save This Page
Home » freemarker-2.3.13 » freemarker.template » [javadoc | source]
    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   /**
   56    * A base class for containers that wrap arbitrary Java objects into 
   57    * {@link TemplateModel} instances.
   58    *
   59    * @version $Id: WrappingTemplateModel.java,v 1.18.2.1 2005/12/07 00:41:23 revusky Exp $
   60    */
   61   abstract public class WrappingTemplateModel {
   62   
   63       private static ObjectWrapper defaultObjectWrapper = 
   64           DefaultObjectWrapper.instance;
   65       private ObjectWrapper objectWrapper;
   66       
   67       /**
   68        * Sets the default object wrapper that is used when a wrapping template
   69        * model is constructed without being passed an explicit object wrapper.
   70        * The default value is {@link ObjectWrapper#SIMPLE_WRAPPER}.
   71        * Note that {@link Configuration#setSharedVariable(String, Object)} and
   72        * {@link Template#process(Object, java.io.Writer)} don't use this setting,
   73        * they rather use whatever object wrapper their 
   74        * {@link Configuration#getObjectWrapper()} method returns.
   75        */
   76       public static void setDefaultObjectWrapper(ObjectWrapper objectWrapper) {
   77           defaultObjectWrapper = objectWrapper;
   78       }
   79   
   80       /**
   81        * Returns the default object wrapper that is used when a wrapping template
   82        * model is constructed without being passed an explicit object wrapper.
   83        * Note that {@link Configuration#setSharedVariable(String, Object)} and
   84        * {@link Template#process(Object, java.io.Writer)} don't use this setting,
   85        * they rather use whatever object wrapper their 
   86        * {@link Configuration#getObjectWrapper()} method returns.
   87        */
   88       public static ObjectWrapper getDefaultObjectWrapper() {
   89           return defaultObjectWrapper;
   90       }
   91       
   92       /**
   93        * Protected constructor that creates a new wrapping template model using
   94        * the default object wrapper.
   95        */
   96       protected WrappingTemplateModel() {
   97           this(defaultObjectWrapper);
   98       }
   99   
  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 = 
  108               objectWrapper != null ? objectWrapper : 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) throws TemplateModelException {
  134           return objectWrapper.wrap(obj);
  135       }
  136   }

Save This Page
Home » freemarker-2.3.13 » freemarker.template » [javadoc | source]