org.gradle.apiDependencySubstitution Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.8 API redistribution.
There is a newer version: 8.6
/*
 * Copyright 2015 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.api.artifacts;

import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.artifacts.component.ComponentSelector;
import org.gradle.internal.HasInternalProtocol;

/**
 * Provides means to substitute a different dependency during resolution.
 *
 * @since 2.5
 */
@HasInternalProtocol
public interface DependencySubstitution {
    /**
     * The requested dependency, before it is resolved.
     * The requested dependency does not change even if there are multiple dependency substitution rules
     * that manipulate the dependency metadata.
     */
    ComponentSelector getRequested();

    /**
     * This method can be used to replace a dependency before it is resolved,
     * e.g. change group, name or version (or all three of them), or replace it
     * with a project dependency.
     *
     * Accepted notations are:
     * 
     *     Strings encoding group:module:version, like 'org.gradle:gradle-core:2.4'
     *     Maps like [group: 'org.gradle', name: 'gradle-core', version: '2.4']
     *     Project instances like project(":api")
     *     Any instance of ModuleComponentSelector or ProjectComponentSelector
     * 
     *
     * @param notation the notation that gets parsed into an instance of {@link ComponentSelector}.
     */
    void useTarget(Object notation);

    /**
     * This method can be used to replace a dependency before it is resolved,
     * e.g. change group, name or version (or all three of them), or replace it
     * with a project dependency and provides a human readable reason for diagnostics.
     *
     * Accepted notations are:
     * 
     *     Strings encoding group:module:version, like 'org.gradle:gradle-core:2.4'
     *     Maps like [group: 'org.gradle', name: 'gradle-core', version: '2.4']
     *     Project instances like project(":api")
     *     Any instance of ModuleComponentSelector or ProjectComponentSelector
     * 
     *
     * @param notation the notation that gets parsed into an instance of {@link ComponentSelector}.
     *
     * @since 4.5
     */
    void useTarget(Object notation, String reason);

    /**
     * Configures the artifact selection for the substitution.
     * This is a convenience method which allows selecting, typically, different artifact classifiers
     * for the same component.
     *
     * Artifact selection matters for components which are not published with Gradle Module Metadata
     * and therefore do not provide proper variants to reason with.
     *
     * @param action the artifact selection configuration action
     *
     * @since 6.6
     */
    @Incubating
    void artifactSelection(Action action);
}