source/mir/generator/Generator.java

   1 /*
   2  * Copyright (C) 2005 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License.
  22  * You must obey the GNU General Public License in all respects for all of the code used
  23  * other than the above mentioned libraries.  If you modify this file, you may extend this
  24  * exception to your version of the file, but you are not obligated to do so.
  25  * If you do not wish to do so, delete this exception statement from your version.
  26  */
  27 package mir.generator;
  28
  29 import mir.log.LoggerWrapper;
  30
  31 import java.util.List;
  32 import java.util.Map;
  33
  34 /**
  35  * A "generator" is an abstraction for a template
  36  * If you need a generator, use MirGeneratorLocalizer
  37  */
  38 public interface Generator {
  39   /** This is the method that actually runs the template engine on this template
  40    * @param anOutputWriter a writer to the file we want to generate, use the
  41    * MirGeneratorLocalizer to create a writer.
  42    * @param aValues the key/value pairs which the template engine will use as variables
  43    */
  44   void generate(Object anOutputWriter, Map aValues, LoggerWrapper aLogger) throws GeneratorExc, GeneratorFailure;
  45
  46   interface Library {
  47     Generator makeGenerator(String anIdentifier, Interceptor anInterceptor) throws GeneratorExc, GeneratorFailure;
  48   }
  49
  50   interface LibraryFactory {
  51     Library makeLibrary(String anInitializationString) throws GeneratorExc, GeneratorFailure ;
  52   }
  53
  54   interface Interceptor {
  55     Object intercept(Object anObject);
  56   }
  57
  58   /** interface for a generator implementation independent function */
  59   interface Function {
  60     /** performs the function with the given parameters */
  61     Object perform(List aParameters) throws GeneratorExc, GeneratorFailure;
  62   }
  63 }