org.gradle.apiresult.ArtifactResolutionResult Maven / Gradle / Ivy

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.

There is a newer version: 8.6

/*
 * Copyright 2014 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.result;

import java.util.Set;

/**
 * The result of executing an artifact resolution query.
 *
 * @since 2.0
 */
public interface ArtifactResolutionResult {
    /**
     * Return a set of {@link ComponentResult} instances representing all requested components.
     *
     * 
Each element in the returned set is declared as an opaque {@link ComponentResult}.
     *    However each element in the result will also implement one of the following interfaces:
     *
     * 
     *     {@link ComponentArtifactsResult} for any component that could be resolved in the set of repositories.
     *     {@link UnresolvedComponentResult} for any component that could not be resolved from the set of repositories.
     * 
     * @return the set of results for all requested components
     */
    Set getComponents();

    /**
     * Return a set of {@link ComponentResult} instances representing all successfully resolved components.
     *
     * Calling this method is the same as calling {@link #getComponents()} and filtering the resulting set for elements of type {@link ComponentArtifactsResult}.
     *
     * @return the set of all successfully resolved components
     */
    Set getResolvedComponents();
}