Save This Page
Home » freemarker-2.3.13 » freemarker.ext.beans » [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.ext.beans;
   54   
   55   import freemarker.ext.util.ModelFactory;
   56   import freemarker.template.ObjectWrapper;
   57   import freemarker.template.TemplateModel;
   58   import freemarker.template.TemplateScalarModel;
   59   
   60   /**
   61    * Subclass of {@link BeanModel} that exposes the return value of the {@link
   62    * java.lang.Object#toString()} method through the {@link TemplateScalarModel}
   63    * interface.
   64    * @author Attila Szegedi
   65    * @version $Id: StringModel.java,v 1.9 2003/06/03 13:21:33 szegedia Exp $
   66    */
   67   public class StringModel extends BeanModel
   68   implements TemplateScalarModel
   69   {
   70       static final ModelFactory FACTORY =
   71           new ModelFactory()
   72           {
   73               public TemplateModel create(Object object, ObjectWrapper wrapper)
   74               {
   75                   return new StringModel(object, (BeansWrapper)wrapper);
   76               }
   77           };
   78   
   79       /**
   80        * Creates a new model that wraps the specified object with BeanModel + scalar
   81        * functionality.
   82        * @param object the object to wrap into a model.
   83        * @param wrapper the {@link BeansWrapper} associated with this model.
   84        * Every model has to have an associated {@link BeansWrapper} instance. The
   85        * model gains many attributes from its wrapper, including the caching 
   86        * behavior, method exposure level, method-over-item shadowing policy etc.
   87        */
   88       public StringModel(Object object, BeansWrapper wrapper)
   89       {
   90           super(object, wrapper);
   91       }
   92   
   93       /**
   94        * Returns the result of calling {@link Object#toString()} on the wrapped
   95        * object.
   96        */
   97       public String getAsString()
   98       {
   99           return object.toString();
  100       }
  101   }

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