rebuilding head

[mir.git] / source / mir / generator / Generator.java

diff --git a/source/mir/generator/Generator.java b/source/mir/generator/Generator.java
index 3f10ca7..805d0cc 100755 (executable)
--- a/source/mir/generator/Generator.java
+++ b/source/mir/generator/Generator.java
@@ -30,28 +30,34 @@
 
 package mir.generator;
 
-import java.io.*;
+import java.io.PrintWriter;
+import java.io.Reader;
 import java.util.List;
 import java.util.Map;
 
 import mir.log.LoggerWrapper;
 
+/**
+ * Interface representing a "generator", typically a template engine/
+ */
 public interface Generator {
   public void generate(Object anOutputWriter, Map aValues, LoggerWrapper aLogger) throws GeneratorExc, GeneratorFailure;
 
-  public static interface GeneratorLibrary {
+  public static interface Library {
     public Generator makeGenerator(String anIdentifier) throws GeneratorExc, GeneratorFailure;
   }
 
-  public static interface GeneratorLibraryFactory {
-    public GeneratorLibrary makeLibrary(String anInitializationString);
+  public static interface LibraryFactory {
+    public Library makeLibrary(String anInitializationString) throws GeneratorExc, GeneratorFailure ;
   }
 
-  public static interface GeneratorFunction {
+  /** interface for a generator implementation independent function */
+  public static interface Function {
+    /** performs the function with the given parameters */
     public Object perform(List aParameters) throws GeneratorExc, GeneratorFailure;
   }
 
-  public static interface GeneratorTransformer {
+  public static interface Transformer {
     public void perform(Reader aSource, PrintWriter anOutput) throws GeneratorExc, GeneratorFailure;
   }
 }