generator-translator: Introduce functional interfaces to make transla…

…tor creation more typesafe

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/CodeGenerationComponent.java

@@ -17,13 +17,14 @@
 package com.speedment.generator.translator.component;
 
 import com.speedment.common.codegen.model.ClassOrInterface;
-import com.speedment.common.codegen.model.Enum;
-import com.speedment.common.codegen.model.Interface;
 import com.speedment.common.injector.annotation.InjectKey;
 import com.speedment.generator.translator.Translator;
 import com.speedment.generator.translator.TranslatorConstructor;
 import com.speedment.generator.translator.TranslatorDecorator;
 import com.speedment.generator.translator.TranslatorKey;
+import com.speedment.generator.translator.component.function.GenerateClass;
+import com.speedment.generator.translator.component.function.GenerateEnum;
+import com.speedment.generator.translator.component.function.GenerateInterface;
 import com.speedment.generator.translator.exception.SpeedmentTranslatorException;
 import com.speedment.runtime.config.Dbms;
 import com.speedment.runtime.config.Project;
@@ -32,7 +33,6 @@
 import com.speedment.runtime.config.trait.HasMainInterface;
 import com.speedment.runtime.config.trait.HasName;
 
-import java.util.function.Function;
 import java.util.stream.Stream;
 
 /**
@@ -53,7 +53,7 @@ public interface CodeGenerationComponent {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newClass(Function<Project, com.speedment.common.codegen.model.Class> creator);
+    CodeGenerationComponent newClass(GenerateClass<Project> creator);
 
     /**
      * Creates a new dynamic code translator and adds it to this component. The
@@ -63,7 +63,7 @@ public interface CodeGenerationComponent {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newEnum(Function<Project, Enum> creator);
+    CodeGenerationComponent newEnum(GenerateEnum<Project> creator);
 
     /**
      * Creates a new dynamic code translator and adds it to this component. The
@@ -73,7 +73,7 @@ public interface CodeGenerationComponent {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newInterface(Function<Project, Interface> creator);
+    CodeGenerationComponent newInterface(GenerateInterface<Project> creator);
 
     /**
      * Creates a new dynamic code translator by first creating a

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/TranslatorAppender.java

@@ -1,14 +1,15 @@
 package com.speedment.generator.translator.component;
 
-import com.speedment.common.codegen.model.Class;
-import com.speedment.common.codegen.model.Enum;
-import com.speedment.common.codegen.model.Interface;
+import com.speedment.generator.translator.component.function.GenerateClass;
+import com.speedment.generator.translator.component.function.GenerateEnum;
+import com.speedment.generator.translator.component.function.GenerateInterface;
 import com.speedment.runtime.config.trait.HasMainInterface;
 import com.speedment.runtime.config.trait.HasName;
 
-import java.util.function.Function;
-
 /**
+ * Appender to the {@link CodeGenerationComponent} used to configure new
+ * translators.
+ *
  * @author Emil Forslund
  * @since  3.1.4
  */
@@ -22,7 +23,7 @@ public interface TranslatorAppender<DOC extends HasName & HasMainInterface> {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newClass(Function<DOC, Class> creator);
+    CodeGenerationComponent newClass(GenerateClass<DOC> creator);
 
     /**
      * Creates a new dynamic code translator and adds it to this component. The
@@ -32,7 +33,7 @@ public interface TranslatorAppender<DOC extends HasName & HasMainInterface> {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newEnum(Function<DOC, Enum> creator);
+    CodeGenerationComponent newEnum(GenerateEnum<DOC> creator);
 
     /**
      * Creates a new dynamic code translator and adds it to this component. The
@@ -42,6 +43,6 @@ public interface TranslatorAppender<DOC extends HasName & HasMainInterface> {
      * @return         this component
      * @since  3.1.4
      */
-    CodeGenerationComponent newInterface(Function<DOC, Interface> creator);
+    CodeGenerationComponent newInterface(GenerateInterface<DOC> creator);
 
 }

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/function/GenerateClass.java

@@ -0,0 +1,16 @@
+package com.speedment.generator.translator.component.function;
+
+import com.speedment.common.codegen.model.Class;
+import com.speedment.runtime.config.trait.HasMainInterface;
+import com.speedment.runtime.config.trait.HasName;
+
+/**
+ * Specialization of {@link GeneratorFunction} that produces a CodeGen
+ * {@code Class}.
+ *
+ * @author Emil Forslund
+ * @since  3.1.4
+ */
+@FunctionalInterface
+public interface GenerateClass<DOC extends HasName & HasMainInterface>
+extends GeneratorFunction<DOC, Class> {}

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/function/GenerateEnum.java

@@ -0,0 +1,16 @@
+package com.speedment.generator.translator.component.function;
+
+import com.speedment.common.codegen.model.Enum;
+import com.speedment.runtime.config.trait.HasMainInterface;
+import com.speedment.runtime.config.trait.HasName;
+
+/**
+ * Specialization of {@link GeneratorFunction} that produces a CodeGen
+ * {@code Enum}.
+ *
+ * @author Emil Forslund
+ * @since  3.1.4
+ */
+@FunctionalInterface
+public interface GenerateEnum<DOC extends HasName & HasMainInterface>
+extends GeneratorFunction<DOC, Enum> {}

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/function/GenerateInterface.java

@@ -0,0 +1,16 @@
+package com.speedment.generator.translator.component.function;
+
+import com.speedment.common.codegen.model.Interface;
+import com.speedment.runtime.config.trait.HasMainInterface;
+import com.speedment.runtime.config.trait.HasName;
+
+/**
+ * Specialization of {@link GeneratorFunction} that produces a CodeGen
+ * {@code Interface}.
+ *
+ * @author Emil Forslund
+ * @since  3.1.4
+ */
+@FunctionalInterface
+public interface GenerateInterface<DOC extends HasName & HasMainInterface>
+extends GeneratorFunction<DOC, Interface> {}

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/component/function/GeneratorFunction.java

@@ -0,0 +1,43 @@
+package com.speedment.generator.translator.component.function;
+
+import com.speedment.common.codegen.model.Class;
+import com.speedment.common.codegen.model.ClassOrInterface;
+import com.speedment.common.codegen.model.Enum;
+import com.speedment.common.codegen.model.Interface;
+import com.speedment.runtime.config.Project;
+import com.speedment.runtime.config.Table;
+import com.speedment.runtime.config.trait.HasMainInterface;
+import com.speedment.runtime.config.trait.HasName;
+
+/**
+ * Specialized function that takes a Speedment configuration document (like
+ * {@link Project}, {@link Table}, etc) and returns a CodeGen model (like
+ * {@link Class}, {@link Interface} or {@link Enum}).
+ *
+ * @author Emil Forslund
+ * @since  3.1.4
+ */
+@FunctionalInterface
+public interface GeneratorFunction<DOC extends HasName & HasMainInterface, T extends ClassOrInterface<T>> {
+
+    /**
+     * Generates a CodeGen model from the specified document.
+     *
+     * @param document  the document to generate from
+     * @return          the created codegen model
+     */
+    T generate(DOC document);
+
+    /**
+     * Returns {@code true} if classes created by this generator should be
+     * placed in the {@code .generated}-folder that is regenerated each time
+     * Speedment is invoked.
+     * <p>
+     * The default value of this method is {@code false}.
+     *
+     * @return  {@code true} if results should be put in the generated package
+     */
+    default boolean inGeneratedPackage() {
+        return false;
+    }
+}

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/internal/SimpleTranslator.java

@@ -7,6 +7,7 @@
 import com.speedment.generator.translator.JavaClassTranslator;
 import com.speedment.generator.translator.Translator;
 import com.speedment.generator.translator.TranslatorSupport;
+import com.speedment.generator.translator.component.function.GeneratorFunction;
 import com.speedment.runtime.config.Document;
 import com.speedment.runtime.config.trait.HasMainInterface;
 import com.speedment.runtime.config.trait.HasName;
@@ -30,14 +31,14 @@ public final class SimpleTranslator
 implements JavaClassTranslator<DOC, T> {
 
     private final Injector injector;
-    private final Function<DOC, T> creator;
+    private final GeneratorFunction<DOC, T> creator;
     private final DOC document;
     private final boolean generated;
 
     public SimpleTranslator(
             Injector injector,
             DOC document,
-            Function<DOC, T> creator,
+            GeneratorFunction<DOC, T> creator,
             boolean generated) {
 
         this.creator   = requireNonNull(creator);
@@ -48,7 +49,7 @@ public SimpleTranslator(
 
     @Override
     public File get() {
-        final T generated = creator.apply(document);
+        final T generated = creator.generate(document);
         final File file = File.of(getSupport().baseDirectoryName() + "/"
             + (isInGeneratedPackage() ? "generated/" : "")
             + generated.getName() + ".java"

generator-parent/generator-translator/src/main/java/com/speedment/generator/translator/internal/component/CodeGenerationComponentImpl.java

@@ -30,6 +30,9 @@
 import com.speedment.generator.translator.component.CodeGenerationComponent;
 import com.speedment.generator.translator.component.DecoratorBuilder;
 import com.speedment.generator.translator.component.TranslatorAppender;
+import com.speedment.generator.translator.component.function.GenerateClass;
+import com.speedment.generator.translator.component.function.GenerateEnum;
+import com.speedment.generator.translator.component.function.GenerateInterface;
 import com.speedment.generator.translator.exception.SpeedmentTranslatorException;
 import com.speedment.generator.translator.internal.SimpleTranslator;
 import com.speedment.runtime.config.Dbms;
@@ -44,7 +47,6 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.function.Consumer;
-import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 import java.util.stream.Stream;
@@ -62,7 +64,7 @@ public CodeGenerationComponentImpl() {
     }
 
     @Override
-    public CodeGenerationComponent newClass(Function<Project, com.speedment.common.codegen.model.Class> creator) {
+    public CodeGenerationComponent newClass(GenerateClass<Project> creator) {
         put(Project.class,
             com.speedment.common.codegen.model.Class.class,
             creator.getClass().getName(),
@@ -71,7 +73,7 @@ public CodeGenerationComponent newClass(Function<Project, com.speedment.common.c
     }
 
     @Override
-    public CodeGenerationComponent newEnum(Function<Project, Enum> creator) {
+    public CodeGenerationComponent newEnum(GenerateEnum<Project> creator) {
         put(Project.class,
             Enum.class,
             creator.getClass().getName(),
@@ -80,7 +82,7 @@ public CodeGenerationComponent newEnum(Function<Project, Enum> creator) {
     }
 
     @Override
-    public CodeGenerationComponent newInterface(Function<Project, Interface> creator) {
+    public CodeGenerationComponent newInterface(GenerateInterface<Project> creator) {
         put(Project.class,
             Interface.class,
             creator.getClass().getName(),
@@ -312,7 +314,7 @@ public TranslatorAppenderImpl(Class<DOC> docClass) {
         }
 
         @Override
-        public CodeGenerationComponent newClass(Function<DOC, com.speedment.common.codegen.model.Class> creator) {
+        public CodeGenerationComponent newClass(GenerateClass<DOC> creator) {
             put(docClass,
                 com.speedment.common.codegen.model.Class.class,
                 creator.getClass().getName(),
@@ -321,7 +323,7 @@ public CodeGenerationComponent newClass(Function<DOC, com.speedment.common.codeg
         }
 
         @Override
-        public CodeGenerationComponent newEnum(Function<DOC, Enum> creator) {
+        public CodeGenerationComponent newEnum(GenerateEnum<DOC> creator) {
             put(docClass,
                 Enum.class,
                 creator.getClass().getName(),
@@ -330,7 +332,7 @@ public CodeGenerationComponent newEnum(Function<DOC, Enum> creator) {
         }
 
         @Override
-        public CodeGenerationComponent newInterface(Function<DOC, Interface> creator) {
+        public CodeGenerationComponent newInterface(GenerateInterface<DOC> creator) {
             put(docClass,
                 Interface.class,
                 creator.getClass().getName(),