io.freefair.gradle.plugins.maven.javadoc.JavadocLinksPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-plugin Show documentation
Collection of Maven related Gradle plugins
There is a newer version: 8.11
package io.freefair.gradle.plugins.maven.javadoc;

import io.freefair.gradle.plugins.okhttp.OkHttpPlugin;
import lombok.Getter;
import org.gradle.api.JavaVersion;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginExtension;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.javadoc.Javadoc;
import org.gradle.external.javadoc.MinimalJavadocOptions;
import org.gradle.external.javadoc.StandardJavadocDocletOptions;

@Getter
public class JavadocLinksPlugin implements Plugin {

    private Project project;

    @Override
    public void apply(Project project) {
        this.project = project;

        project.getPlugins().apply(OkHttpPlugin.class);

        project.getPlugins().withType(AggregateJavadocPlugin.class, ajp -> {

            project.afterEvaluate(p -> {
                this.addJavaSeLink(ajp.getJavadocTask());
                this.addLinks(ajp.getJavadocTask(), ajp.getJavadocClasspath());
            });
        });

        project.getPlugins().withType(JavaPlugin.class, javaPlugin -> {
            TaskProvider javadoc = project.getTasks().named(JavaPlugin.JAVADOC_TASK_NAME, Javadoc.class);

            SourceSet main = project.getExtensions().getByType(JavaPluginExtension.class).getSourceSets().getByName("main");
            Configuration compileClasspath = project.getConfigurations().getByName(main.getCompileClasspathConfigurationName());

            project.afterEvaluate(p -> {
                this.addJavaSeLink(javadoc);
                this.addLinks(javadoc, compileClasspath);
            });
        });
    }

    public void addLinks(TaskProvider javadocTaskProvider, Configuration classpath) {

        TaskProvider resolveJavadocLinks = project.getTasks().register("resolveJavadocLinks", ResolveJavadocLinks.class);

        resolveJavadocLinks.configure(rjd -> {
            rjd.getJavadocTool().convention(javadocTaskProvider.get().getJavadocTool());
            rjd.setClasspath(classpath);
        });

        javadocTaskProvider.configure(javadoc -> {
            javadoc.dependsOn(resolveJavadocLinks);
            javadoc.getInputs()
                    .file(resolveJavadocLinks.map(ResolveJavadocLinks::getOutputFile))
                    .withPathSensitivity(PathSensitivity.NAME_ONLY);

            MinimalJavadocOptions options = javadoc.getOptions();

            if (options instanceof StandardJavadocDocletOptions) {
                StandardJavadocDocletOptions standardOptions = (StandardJavadocDocletOptions) options;
                standardOptions.linksFile(resolveJavadocLinks.get().getOutputFile().get().getAsFile());
            }
        });

    }

    private void addJavaSeLink(TaskProvider javadocTaskProvider) {

        javadocTaskProvider.configure(jd -> {
            JavaVersion javaVersion = JavadocLinkUtil.getJavaVersion(jd);
            String link = JavadocLinkUtil.getJavaSeLink(javaVersion);

            MinimalJavadocOptions options = jd.getOptions();
            if (options instanceof StandardJavadocDocletOptions) {
                ((StandardJavadocDocletOptions) options).links(link);
            }
        });
    }

}