Search in sources :

Example 1 with JAVADOC

use of org.gradle.api.attributes.DocsType.JAVADOC in project gradle by gradle.

the class DefaultJvmVariantBuilder method build.

void build() {
    SourceSet sourceSet = this.sourceSet == null ? sourceSets.maybeCreate(name) : this.sourceSet;
    boolean mainSourceSet = SourceSet.isMain(sourceSet);
    String apiConfigurationName;
    String implementationConfigurationName;
    String apiElementsConfigurationName;
    String runtimeElementsConfigurationName;
    String compileOnlyConfigurationName;
    String compileOnlyApiConfigurationName;
    String runtimeOnlyConfigurationName;
    if (mainSourceSet) {
        apiConfigurationName = name + "Api";
        implementationConfigurationName = name + "Implementation";
        apiElementsConfigurationName = apiConfigurationName + "Elements";
        runtimeElementsConfigurationName = name + "RuntimeElements";
        compileOnlyConfigurationName = name + "CompileOnly";
        compileOnlyApiConfigurationName = name + "CompileOnlyApi";
        runtimeOnlyConfigurationName = name + "RuntimeOnly";
    } else {
        apiConfigurationName = sourceSet.getApiConfigurationName();
        implementationConfigurationName = sourceSet.getImplementationConfigurationName();
        apiElementsConfigurationName = sourceSet.getApiElementsConfigurationName();
        runtimeElementsConfigurationName = sourceSet.getRuntimeElementsConfigurationName();
        compileOnlyConfigurationName = sourceSet.getCompileOnlyConfigurationName();
        compileOnlyApiConfigurationName = sourceSet.getCompileOnlyApiConfigurationName();
        runtimeOnlyConfigurationName = sourceSet.getRuntimeOnlyConfigurationName();
    }
    String displayName = this.displayName == null ? name : this.displayName;
    // In the general case, the following configurations are already created
    // but if we're using the "main" source set, it means that the component we're creating shares
    // the same source set (main) but declares its dependencies in its own buckets, so we need
    // to create them
    Configuration implementation = bucket("Implementation", implementationConfigurationName, displayName);
    Configuration compileOnly = bucket("Compile-Only", compileOnlyConfigurationName, displayName);
    Configuration compileOnlyApi = bucket("Compile-Only API", compileOnlyApiConfigurationName, displayName);
    Configuration runtimeOnly = bucket("Runtime-Only", runtimeOnlyConfigurationName, displayName);
    TaskProvider<Task> jarTask = registerOrGetJarTask(sourceSet, displayName);
    Configuration api = exposeApi ? bucket("API", apiConfigurationName, displayName) : null;
    Configuration apiElements = exposeApi ? jvmPluginServices.createOutgoingElements(apiElementsConfigurationName, builder -> {
        builder.fromSourceSet(sourceSet).providesApi().withDescription("API elements for " + displayName).extendsFrom(api, compileOnlyApi).withCapabilities(capabilities).withClassDirectoryVariant().artifact(jarTask);
    }) : null;
    if (exposeApi) {
        implementation.extendsFrom(api);
    }
    Configuration runtimeElements = jvmPluginServices.createOutgoingElements(runtimeElementsConfigurationName, builder -> {
        builder.fromSourceSet(sourceSet).providesRuntime().withDescription("Runtime elements for " + displayName).extendsFrom(implementation, runtimeOnly).withCapabilities(capabilities).artifact(jarTask);
    });
    if (mainSourceSet) {
        // we need to wire the compile only and runtime only to the classpath configurations
        configurations.getByName(sourceSet.getCompileClasspathConfigurationName()).extendsFrom(implementation, compileOnly);
        configurations.getByName(sourceSet.getRuntimeClasspathConfigurationName()).extendsFrom(implementation, runtimeOnly);
        // and we also want the feature dependencies to be available on the test classpath
        configurations.getByName(JavaPlugin.TEST_COMPILE_CLASSPATH_CONFIGURATION_NAME).extendsFrom(implementation, compileOnlyApi);
        configurations.getByName(JavaPlugin.TEST_RUNTIME_CLASSPATH_CONFIGURATION_NAME).extendsFrom(implementation, runtimeOnly);
    }
    final AdhocComponentWithVariants component = findJavaComponent();
    JavaPluginExtension javaPluginExtension = project.getExtensions().findByType(JavaPluginExtension.class);
    configureJavaDocTask(name, sourceSet, tasks, javaPluginExtension);
    if (javadocJar) {
        configureDocumentationVariantWithArtifact(sourceSet.getJavadocElementsConfigurationName(), mainSourceSet ? null : name, displayName, JAVADOC, sourceSet.getJavadocJarTaskName(), tasks.named(sourceSet.getJavadocTaskName()), component);
    }
    if (sourcesJar) {
        configureDocumentationVariantWithArtifact(sourceSet.getSourcesElementsConfigurationName(), mainSourceSet ? null : name, displayName, SOURCES, sourceSet.getSourcesJarTaskName(), sourceSet.getAllSource(), component);
    }
    if (published && component != null) {
        if (apiElements != null) {
            component.addVariantsFromConfiguration(apiElements, new JavaConfigurationVariantMapping("compile", true));
        }
        component.addVariantsFromConfiguration(runtimeElements, new JavaConfigurationVariantMapping("runtime", true));
    }
}
Also used : SOURCES(org.gradle.api.attributes.DocsType.SOURCES) JavaPlugin(org.gradle.api.plugins.JavaPlugin) BasePlugin(org.gradle.api.plugins.BasePlugin) AdhocComponentWithVariants(org.gradle.api.component.AdhocComponentWithVariants) SourceSet(org.gradle.api.tasks.SourceSet) Inject(javax.inject.Inject) Configuration(org.gradle.api.artifacts.Configuration) LifecycleBasePlugin(org.gradle.language.base.plugins.LifecycleBasePlugin) Task(org.gradle.api.Task) Lists(com.google.common.collect.Lists) ConfigurationContainer(org.gradle.api.artifacts.ConfigurationContainer) TaskProvider(org.gradle.api.tasks.TaskProvider) JavaConfigurationVariantMapping(org.gradle.api.plugins.internal.JavaConfigurationVariantMapping) SourceSetContainer(org.gradle.api.tasks.SourceSetContainer) ProjectInternal(org.gradle.api.internal.project.ProjectInternal) TextUtil(org.gradle.util.internal.TextUtil) SoftwareComponentContainer(org.gradle.api.component.SoftwareComponentContainer) ProjectDerivedCapability(org.gradle.internal.component.external.model.ProjectDerivedCapability) Nullable(javax.annotation.Nullable) ImmutableCapability(org.gradle.internal.component.external.model.ImmutableCapability) LazyPublishArtifact(org.gradle.api.internal.artifacts.dsl.LazyPublishArtifact) Jar(org.gradle.api.tasks.bundling.Jar) JAVADOC(org.gradle.api.attributes.DocsType.JAVADOC) List(java.util.List) JvmPluginsHelper.configureJavaDocTask(org.gradle.api.plugins.internal.JvmPluginsHelper.configureJavaDocTask) Capability(org.gradle.api.capabilities.Capability) TaskContainer(org.gradle.api.tasks.TaskContainer) JavaPluginExtension(org.gradle.api.plugins.JavaPluginExtension) InvalidUserDataException(org.gradle.api.InvalidUserDataException) SoftwareComponent(org.gradle.api.component.SoftwareComponent) SourceSet(org.gradle.api.tasks.SourceSet) Task(org.gradle.api.Task) JvmPluginsHelper.configureJavaDocTask(org.gradle.api.plugins.internal.JvmPluginsHelper.configureJavaDocTask) AdhocComponentWithVariants(org.gradle.api.component.AdhocComponentWithVariants) Configuration(org.gradle.api.artifacts.Configuration) JavaConfigurationVariantMapping(org.gradle.api.plugins.internal.JavaConfigurationVariantMapping) JavaPluginExtension(org.gradle.api.plugins.JavaPluginExtension)

Aggregations

Lists (com.google.common.collect.Lists)1 List (java.util.List)1 Nullable (javax.annotation.Nullable)1 Inject (javax.inject.Inject)1 InvalidUserDataException (org.gradle.api.InvalidUserDataException)1 Task (org.gradle.api.Task)1 Configuration (org.gradle.api.artifacts.Configuration)1 ConfigurationContainer (org.gradle.api.artifacts.ConfigurationContainer)1 JAVADOC (org.gradle.api.attributes.DocsType.JAVADOC)1 SOURCES (org.gradle.api.attributes.DocsType.SOURCES)1 Capability (org.gradle.api.capabilities.Capability)1 AdhocComponentWithVariants (org.gradle.api.component.AdhocComponentWithVariants)1 SoftwareComponent (org.gradle.api.component.SoftwareComponent)1 SoftwareComponentContainer (org.gradle.api.component.SoftwareComponentContainer)1 LazyPublishArtifact (org.gradle.api.internal.artifacts.dsl.LazyPublishArtifact)1 ProjectInternal (org.gradle.api.internal.project.ProjectInternal)1 BasePlugin (org.gradle.api.plugins.BasePlugin)1 JavaPlugin (org.gradle.api.plugins.JavaPlugin)1 JavaPluginExtension (org.gradle.api.plugins.JavaPluginExtension)1 JavaConfigurationVariantMapping (org.gradle.api.plugins.internal.JavaConfigurationVariantMapping)1