cvs commit: jakarta-velocity/src/java/org/apache/velocity/runtime FileTemplateLoader.java

[da...@locus.apache.org]

daveb       00/08/26 13:16:14

  Added:       src/java/org/apache/velocity/runtime FileTemplateLoader.java
  Log:
  Initial add.
  
  Revision  Changes    Path
  1.1                  jakarta-velocity/src/java/org/apache/velocity/runtime/FileTemplateLoader.java
  
  Index: FileTemplateLoader.java
  ===================================================================
  package org.apache.velocity.runtime;
  
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2000 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import java.util.*;
  import java.io.*;
  
  import org.apache.velocity.*;
  
  /**
   * This is a simple template file loader.
   * Currently it only supports a  single path to templates.
   * That'll change once we decide how we want to do configuration
   * 
   * @author Dave Bryson
   * $Revision#
   */
  public class FileTemplateLoader extends TemplateLoader
  {
      private Hashtable cache;
      private String templatepath;
      private boolean useCache;
      
      /**
       * Get the properties needed.
       */
      public void init()
      {
          templatepath = Configuration.getString( Configuration.TEMPLATE_PATH, "." );
          useCache = Configuration.getBoolean( Configuration.TEMPLATE_CACHE );
          
          if ( useCache )
          {
              cache = new Hashtable();
          }
      }
      
      /**
       * Fetch the template
       * @return Template
       */
      public Template getTemplate( String name )
      {
          if ( useCache )
          {
              if ( cache != null && cache.containsKey( name ) )
              {
                  return (Template)cache.get( name );
              }
          }
          
          File file = new File( templatepath, name );
          if ( file.canRead() )
          {
              Template template = new Template( name );
              if ( useCache )
              {
                  cache.put( name, template );
              }
              return template;
          }
          
          return null;
      }
  }