factored out AbstractRamlerJavaGenerator

Author: hwellmann

ramler-gradle-plugin/src/main/java/org/ops4j/ramler/gradle/AbstractRamlerJavaGenerator.java

@@ -0,0 +1,346 @@
+/*
+ * Copyright 2019 OPS4J Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.ops4j.ramler.gradle;
+
+import java.io.File;
+
+import org.gradle.api.DefaultTask;
+import org.gradle.api.GradleException;
+import org.gradle.api.plugins.JavaPluginConvention;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.Optional;
+import org.gradle.api.tasks.OutputDirectory;
+import org.gradle.api.tasks.TaskAction;
+import org.ops4j.ramler.common.exc.RamlerException;
+import org.ops4j.ramler.java.JavaConfiguration;
+import org.ops4j.ramler.java.JavaGenerator;
+
+public abstract class AbstractRamlerJavaGenerator extends DefaultTask {
+
+    /** RAML specification file, relative to <code>${project.basedir}</code>. */
+    private String model;
+
+    /**
+     * Output directory for generated sources.
+     */
+    private String outputDir;
+
+    /**
+     * Fully qualified package name for generated Java sources. The generated classes will be
+     * located in subpackages {@code model} and {@code api}.
+     */
+    private String packageName;
+
+    /**
+     * Should discriminator properties be mutable?
+     */
+    private boolean discriminatorMutable;
+
+    /**
+     * Suffix for interface names. This suffix is appended to the code name of a resource. The code
+     * name is either specified explicitly by the {@code (codeName)} annotation, or implicitly by
+     * the resource name, converted to camel case.
+     */
+    private String interfaceNameSuffix;
+
+    /**
+     * Should Java classes include type information annotations for type hierarchies?
+     */
+    private boolean jacksonTypeInfo;
+
+    /**
+     * Should Java classes include {@code JsonProperty} annotations for properties with illegal Java
+     * names?
+     */
+    private boolean jacksonPropertyName;
+
+    /**
+     * Should Jackson annotations {@code @JsonSerializer} etc. be used for union types?
+     */
+    private boolean jacksonUnion;
+
+    private boolean delegators;
+
+    private String delegatorSuffix;
+
+    private String delegateFieldName;
+
+    /**
+     * Gets the model.
+     *
+     * @return the model
+     */
+    @Input
+    public String getModel() {
+        return model;
+    }
+
+    /**
+     * Sets the model.
+     *
+     * @param model
+     *            the model to set
+     */
+    public void setModel(String model) {
+        this.model = model;
+    }
+
+    /**
+     * Gets the outputDir.
+     *
+     * @return the outputDir
+     */
+    @Input
+    @OutputDirectory
+    @Optional
+    public String getOutputDir() {
+        return outputDir;
+    }
+
+    /**
+     * Sets the outputDir.
+     *
+     * @param outputDir
+     *            the outputDir to set
+     */
+    public void setOutputDir(String outputDir) {
+        this.outputDir = outputDir;
+    }
+
+    /**
+     * Gets the packageName.
+     *
+     * @return the packageName
+     */
+    @Input
+    public String getPackageName() {
+        return packageName;
+    }
+
+    /**
+     * Sets the packageName.
+     *
+     * @param packageName
+     *            the packageName to set
+     */
+    public void setPackageName(String packageName) {
+        this.packageName = packageName;
+    }
+
+    /**
+     * Gets the discriminatorMutable.
+     *
+     * @return the discriminatorMutable
+     */
+    @Input
+    public boolean isDiscriminatorMutable() {
+        return discriminatorMutable;
+    }
+
+    /**
+     * Sets the discriminatorMutable.
+     *
+     * @param discriminatorMutable
+     *            the discriminatorMutable to set
+     */
+    public void setDiscriminatorMutable(boolean discriminatorMutable) {
+        this.discriminatorMutable = discriminatorMutable;
+    }
+
+    /**
+     * Gets the interfaceNameSuffix.
+     *
+     * @return the interfaceNameSuffix
+     */
+    @Input
+    @Optional
+    public String getInterfaceNameSuffix() {
+        return interfaceNameSuffix;
+    }
+
+    /**
+     * Sets the interfaceNameSuffix.
+     *
+     * @param interfaceNameSuffix
+     *            the interfaceNameSuffix to set
+     */
+    public void setInterfaceNameSuffix(String interfaceNameSuffix) {
+        this.interfaceNameSuffix = interfaceNameSuffix;
+    }
+
+    /**
+     * Gets the jacksonTypeInfo.
+     *
+     * @return the jacksonTypeInfo
+     */
+    @Input
+    public boolean isJacksonTypeInfo() {
+        return jacksonTypeInfo;
+    }
+
+    /**
+     * Sets the jacksonTypeInfo.
+     *
+     * @param jacksonTypeInfo
+     *            the jacksonTypeInfo to set
+     */
+    public void setJacksonTypeInfo(boolean jacksonTypeInfo) {
+        this.jacksonTypeInfo = jacksonTypeInfo;
+    }
+
+    /**
+     * Gets the jacksonPropertyName.
+     *
+     * @return the jacksonPropertyName
+     */
+    @Input
+    public boolean isJacksonPropertyName() {
+        return jacksonPropertyName;
+    }
+
+    /**
+     * Sets the jacksonPropertyName.
+     *
+     * @param jacksonPropertyName
+     *            the jacksonPropertyName to set
+     */
+    public void setJacksonPropertyName(boolean jacksonPropertyName) {
+        this.jacksonPropertyName = jacksonPropertyName;
+    }
+
+    /**
+     * Gets the jacksonUnion.
+     *
+     * @return the jacksonUnion
+     */
+    @Input
+    public boolean isJacksonUnion() {
+        return jacksonUnion;
+    }
+
+    /**
+     * Sets the jacksonUnion.
+     *
+     * @param jacksonUnion
+     *            the jacksonUnion to set
+     */
+    public void setJacksonUnion(boolean jacksonUnion) {
+        this.jacksonUnion = jacksonUnion;
+    }
+
+    /**
+     * Gets the delegators.
+     *
+     * @return the delegators
+     */
+    @Input
+    public boolean isDelegators() {
+        return delegators;
+    }
+
+    /**
+     * Sets the delegators.
+     *
+     * @param delegators
+     *            the delegators to set
+     */
+    public void setDelegators(boolean delegators) {
+        this.delegators = delegators;
+    }
+
+    /**
+     * Gets the delegatorSuffix.
+     *
+     * @return the delegatorSuffix
+     */
+    @Input
+    @Optional
+    public String getDelegatorSuffix() {
+        return delegatorSuffix;
+    }
+
+    /**
+     * Sets the delegatorSuffix.
+     *
+     * @param delegatorSuffix
+     *            the delegatorSuffix to set
+     */
+    public void setDelegatorSuffix(String delegatorSuffix) {
+        this.delegatorSuffix = delegatorSuffix;
+    }
+
+    /**
+     * Gets the delegateFieldName.
+     *
+     * @return the delegateFieldName
+     */
+    @Input
+    @Optional
+    public String getDelegateFieldName() {
+        return delegateFieldName;
+    }
+
+    /**
+     * Sets the delegateFieldName.
+     *
+     * @param delegateFieldName
+     *            the delegateFieldName to set
+     */
+    public void setDelegateFieldName(String delegateFieldName) {
+        this.delegateFieldName = delegateFieldName;
+    }
+
+    protected abstract String getDefaultOutputSubdir();
+
+    protected abstract String getSourceSet();
+
+    @TaskAction
+    public void generate() {
+        getLogger().info("Generating Java model from {}", model);
+        String sourceFile = new File(getProject().getProjectDir(), model).getPath();
+        String outputDir = java.util.Optional.ofNullable(getOutputDir())
+            .orElse(new File(getProject().getBuildDir(), getDefaultOutputSubdir()).getPath());
+        JavaConfiguration config = new JavaConfiguration();
+        config.setSourceFile(sourceFile);
+        config.setBasePackage(packageName);
+        config.setTargetDir(new File(outputDir));
+        config.setDiscriminatorMutable(discriminatorMutable);
+        config.setInterfaceNameSuffix(interfaceNameSuffix);
+        config.setJacksonTypeInfo(jacksonTypeInfo);
+        config.setJacksonPropertyName(jacksonPropertyName);
+        config.setJacksonUnion(jacksonUnion);
+        config.setDelegators(delegators);
+        config.setDelegateFieldName(delegateFieldName);
+        config.setDelegatorSuffix(delegatorSuffix);
+
+        JavaPluginConvention javaPluginConvention = getProject().getConvention()
+            .getPlugin(JavaPluginConvention.class);
+        javaPluginConvention.getSourceSets()
+            .getByName(getSourceSet())
+            .getJava()
+            .srcDir(outputDir);
+
+        try {
+            JavaGenerator generator = new JavaGenerator(config);
+            generator.generate();
+        }
+        catch (RamlerException exc) {
+            throw new GradleException("Code generation failed", exc);
+        }
+    }
+}