org.gradle.apiCapabilitiesResolution Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
The newest version!
/*
 * Copyright 2019 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.capabilities.Capability;
import org.gradle.api.provider.Provider;
import org.gradle.internal.HasInternalProtocol;

/**
 * Allows configuring the capabilities resolution strategy.
 * When there's a capability conflict, this object will let you select
 * what to do in that situation. The configuration can either be global,
 * for any capability by calling the {@link #all(Action)} method,
 * or it can be specific to a capability by calling one of the {@link #withCapability(Object, Action)},
 * {@link #withCapability(Capability, Action)} or {@link #withCapability(String, String, Action)} methods.
 *
 * @since 5.6
 */
@HasInternalProtocol
public interface CapabilitiesResolution {
    /**
     * Configures the resolution strategy of capability conflicts for all capabilities.
     *
     * @param action the configuration action
     */
    void all(Action action);

    /**
     * Configures the resolution strategy of a specific capability. The capability version is irrelevant.
     *
     * @param capability a capability to configure
     *
     * @param action the configuration action
     */
    void withCapability(Capability capability, Action action);

    /**
     * Configures the resolution strategy of a specific capability.
     *
     * @param group the group of the capability to configure
     * @param name the name of the capability to configure
     *
     * @param action the configuration action
     */
    void withCapability(String group, String name, Action action);

    /**
     * Configures the resolution strategy of a specific capability.
     *
     * @param notation the {@linkplain ConfigurationPublications#capability(Object) notation} of the capability to configure, {@linkplain Provider Providers} of any notation are also accepted
     *
     * @param action the configuration action
     */
    void withCapability(Object notation, Action action);
}