org.gradle.plugin.devel.GradlePluginDevelopmentExtension Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2016 the original author or authors.
*
* 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.gradle.plugin.devel;
import org.gradle.api.Action;
import org.gradle.api.NamedDomainObjectContainer;
import org.gradle.api.Project;
import org.gradle.api.tasks.SourceSet;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
/**
* Configuration options for the {@link org.gradle.plugin.devel.plugins.JavaGradlePluginPlugin}.
*
* Below is a full configuration example. Since all properties have sensible defaults,
* typically only selected properties will be configured.
*
*
* apply plugin: "java-gradle-plugin"
*
* gradlePlugin {
* pluginSourceSet project.sourceSets.customMain
* testSourceSets project.sourceSets.functionalTest
* plugins {
* helloPlugin {
* id = 'org.example.hello'
* implementationClass = 'org.example.HelloPlugin'
* }
* }
* }
*
*
* @see org.gradle.plugin.devel.plugins.JavaGradlePluginPlugin
* @since 2.13
*/
public class GradlePluginDevelopmentExtension {
private SourceSet pluginSourceSet;
private Set testSourceSets = Collections.emptySet();
private final NamedDomainObjectContainer plugins;
private boolean automatedPublishing = true;
public GradlePluginDevelopmentExtension(Project project, SourceSet pluginSourceSet, SourceSet testSourceSet) {
this(project, pluginSourceSet, new SourceSet[] {testSourceSet});
}
public GradlePluginDevelopmentExtension(Project project, SourceSet pluginSourceSet, SourceSet[] testSourceSets) {
this.plugins = project.container(PluginDeclaration.class);
this.pluginSourceSet = pluginSourceSet;
testSourceSets(testSourceSets);
}
/**
* Provides the source set that compiles the code under test.
*
* @param pluginSourceSet the plugin source set
*/
public void pluginSourceSet(SourceSet pluginSourceSet) {
this.pluginSourceSet = pluginSourceSet;
}
/**
* Provides the source sets executing the functional tests with TestKit.
*
* Calling this method multiple times with different source sets is not additive.
*
* @param testSourceSets the test source sets
*/
public void testSourceSets(SourceSet... testSourceSets) {
this.testSourceSets = Collections.unmodifiableSet(new HashSet(Arrays.asList(testSourceSets)));
}
/**
* Returns the source set that compiles the code under test. Defaults to {@code project.sourceSets.main}.
*
* @return the plugin source set
*/
public SourceSet getPluginSourceSet() {
return pluginSourceSet;
}
/**
* Returns the source sets executing the functional tests with TestKit. Defaults to {@code project.sourceSets.test}.
*
* @return the test source sets
*/
public Set getTestSourceSets() {
return testSourceSets;
}
/**
* Returns the declared plugins.
*
* @return the declared plugins, never null
*/
public NamedDomainObjectContainer getPlugins() {
return plugins;
}
/**
* Configures the declared plugins.
*
* @param action the configuration action to invoke on the plugins
*/
public void plugins(Action> action) {
action.execute(plugins);
}
/**
* Whether the plugin should automatically configure the publications for the plugins.
* @return true if publishing should be automated, false otherwise
*/
public boolean isAutomatedPublishing() {
return automatedPublishing;
}
/**
* Configures whether the plugin should automatically configure the publications for the plugins.
* @param automatedPublishing whether to automated publication
*/
public void setAutomatedPublishing(boolean automatedPublishing) {
this.automatedPublishing = automatedPublishing;
}
}