simplified interface

Author: hauner

README.md

@@ -6,12 +6,10 @@ openapi-generatr consumer, for example the openapi-generatr [gradle plugin][gene
 A consumer should be able to provide access to any generatr (by the generatr name) that is found on
 the class path.
 
-For example the gradle plugin will provide a gradle task for each generatr that is available
-via this service interface. For the [openapi-generatr-spring][generatr-spring], based on the generatr
-name, this will be a `generateSpring` gradle task to run the generatr and a `generatrSpring` options
-object to configure it.
-
-
+For example the gradle plugin will provide a gradle task for each (configured) generatr. The task
+will find & run the generatr by using this service interface. By using the service interface the plugin
+itself does not need an explicit dependency on any generatr.
+ 
 # implementing the api
 
 To make an openapi-generatr available to a consumer (e.g. the openapi-generatr-gradle plugin) it must

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'com.github.hauner.openapi'
-version '1.0.0.B1'
+version '1.0.0.B2'
 
 sourceCompatibility = 1.8
 

src/main/java/com/github/hauner/openapi/api/OpenApiGeneratr.java

@@ -16,6 +16,8 @@
 
 package com.github.hauner.openapi.api;
 
+import java.util.Map;
+
 /**
  * To make an openapi-generatr available to a consumer (for example the openapi-generatr-gradle plugin)
  * it must implement this interface and have a
@@ -26,41 +28,34 @@
  * A consumer should be able to provide access to any generatr that is found on the class path.
  *
  * <p>
- * For example the gradle plugin will provide a gradle task and options object for each generatr that
- * is available via this service interface. For
- * <a href="https://github.com/hauner/openapi-generatr-spring">openapi-generatr-spring</a> (based
- * on the generatr name) this will be a {@code generateSpring} task to run the generatr and a
- * {@code generatrSpring} options object to configure it.
+ * For example the gradle plugin will provide a gradle task for each (configured) generatr. This task
+ * will find & run a generatr by using this service interface. By using the service interface it does
+ * not need an explicit dependency on a generatr.
  *
  * @author Martin Hauner
  */
-public interface OpenApiGeneratr<T> {
+public interface OpenApiGeneratr {
 
     /**
      * The identifying name of the generatr. *Should* be globally unique so a consumer of this
      * interface can distinguish between different generatrs.
      *
      * <p>
      * It is recommended to return here the last part of the full generatr name. If the generatr
-     * jar name is {@code openapi-generatr-spring} the name should be {@code Spring}.
+     * jar name is {@code openapi-generatr-spring} the name should be {@code spring}.
      * </p>
      *
      * @return the unique name of the generatr
      */
     String getName();
 
     /**
-     * the type of the generatr options given to the run() method.
-     *
-     * @return options class
-     */
-    Class<T> getOptionsType();
-
-    /**
-     * Runs the generatr with the given options.
+     * Runs the generatr with the given options. The options are key value pairs. Keys are of type
+     * {@code String} and values are of any type. A property hierarchy is possible by using
+     * {@code Map}s as value.
      *
      * @param options the generatr configuration
      */
-    void run(T options);
+    void run(Map<String, ?> options);
 
 }