gradle-master/subprojects/core/src/main/java/org/gradle/api/internal/artifacts/configurations/ResolveConfigurationDependenciesBuildOperationType.java
/*
 * 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.api.internal.artifacts.configurations;

import org.gradle.api.artifacts.result.ResolvedComponentResult;
import org.gradle.api.attributes.AttributeContainer;
import org.gradle.internal.operations.BuildOperationType;
import org.gradle.internal.scan.UsedByScanPlugin;

import javax.annotation.Nullable;
import java.util.List;
import java.util.Map;

/**
 * Resolution of a configuration's dependencies.
 *
 * @since 4.4
 */
public final class ResolveConfigurationDependenciesBuildOperationType implements BuildOperationType<ResolveConfigurationDependenciesBuildOperationType.Details, ResolveConfigurationDependenciesBuildOperationType.Result> {

    @UsedByScanPlugin
    public interface Details {

        String getConfigurationName();

        @Nullable
        String getProjectPath();

        boolean isScriptConfiguration();

        @Nullable
        String getConfigurationDescription();

        String getBuildPath();

        boolean isConfigurationVisible();

        boolean isConfigurationTransitive();

        /**
         * @since 4.10
         */
        @Nullable
        List<Repository> getRepositories();

    }

    @UsedByScanPlugin
    public interface Result {

        ResolvedComponentResult getRootComponent();

        /**
         * If the component was resolved from a repository, its {@link Repository#getId()}.
         */
        @Nullable
        String getRepositoryId(ResolvedComponentResult resolvedComponentResult);

        /**
         * Which attributes the resolved configuration was requested with, if any.
         * @since 5.6
         */
        AttributeContainer getRequestedAttributes();
    }

    /**
     * A description of a repository potentially used in the resolution.
     *
     * Effectively maps to a RepositoryDescriptor.
     */
    @UsedByScanPlugin
    public interface Repository {

        /**
         *  A unique identifier for this repository, used for associating resolved components to their source repository.
         */
        String getId();

        /**
         * The type of repository.
         *
         * Then name of one of RepositoryDescriptor.Type.
         */
        String getType();

        /**
         *  The name of this repository.
         */
        String getName();

        /**
         * The properties of the repository.
         *
         * See RepositoryDescriptor.getProperties() and the specific properties used by the subtypes.
         * The properties sent, their names and types, should be kept stable.
         * Ordered by key lexicographically.
         */
        Map<String, ?> getProperties();

    }

}
