source/mir/generator/Generator.java

   1 /*
   2  * Copyright (C) 2001, 2002 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  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30
  31 package mir.generator;
  32
  33 import java.io.PrintWriter;
  34 import java.io.Reader;
  35 import java.util.List;
  36 import java.util.Map;
  37
  38 import mir.log.LoggerWrapper;
  39
  40 /**
  41  * Interface representing a "generator", typically a template engine/
  42  */
  43 public interface Generator {
  44   public void generate(Object anOutputWriter, Map aValues, LoggerWrapper aLogger) throws GeneratorExc, GeneratorFailure;
  45
  46   public static interface Library {
  47     public Generator makeGenerator(String anIdentifier) throws GeneratorExc, GeneratorFailure;
  48   }
  49
  50   public static interface LibraryFactory {
  51     public Library makeLibrary(String anInitializationString) throws GeneratorExc, GeneratorFailure ;
  52   }
  53
  54   /** interface for a generator implementation independent function */
  55   public static interface Function {
  56     /** performs the function with the given parameters */
  57     public Object perform(List aParameters) throws GeneratorExc, GeneratorFailure;
  58   }
  59
  60   public static interface Transformer {
  61     public void perform(Reader aSource, PrintWriter anOutput) throws GeneratorExc, GeneratorFailure;
  62   }
  63 }