org.gradle.plugin.management.internal.autoapply.AutoAppliedPluginHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 5.6 API redistribution.

There is a newer version: 8.6

/*
 * Copyright 2017 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.management.internal.autoapply;

import org.gradle.plugin.management.internal.PluginRequests;

/**
 * 
 * Certain plugins are important enough that Gradle should auto-apply them when it is clear
 * that the user is trying to use it. For instance, when the user uses the --scan option, it
 * is clear they expect the build scan plugin to be applied.
 * 
 *
 * Auto-application of a plugin is skipped in the following situations, so the user can adjust the version they want:
 *
 * 
 *  The plugin was already applied (e.g. through an init script)
 * 
 The plugin was already requested in the plugins {} block 
 *  The plugin was already requested in the buildscript {} block 
 *
 */
public interface AutoAppliedPluginHandler {

    /**
     * Merges the provided user requests with other plugin requests that should be auto-applied
     * based on the current build invocation and the given target.
     */
    PluginRequests mergeWithAutoAppliedPlugins(PluginRequests initialRequests, Object pluginTarget);
}