org.gradle.api.tasks.TaskDependency 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.

There is a newer version: 8.11.1

/*
 * Copyright 2007-2008 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.tasks;

import org.gradle.api.Task;
import org.gradle.internal.accesscontrol.ForExternalUse;

import javax.annotation.Nullable;
import java.util.Set;

/**
 * A TaskDependency represents an unordered set of tasks which a {@link Task} depends on.
 * Gradle ensures that all the dependencies of a task are executed before the task itself is executed.
 *
 * You can add a TaskDependency to a task by calling the task's {@link Task#dependsOn(Object...)}
 * method.
 */
public interface TaskDependency {
    /**
     * Determines the dependencies for the given {@link Task}. This method is called when Gradle assembles the task
     * execution graph for a build. This occurs after all the projects have been evaluated, and before any task
     * execution begins.
     *
     * @param task The task to determine the dependencies for.
     * @return The tasks which the given task depends on. Returns an empty set if the task has no dependencies.
     */
    @ForExternalUse // see TaskDependencyInternal.getDependencies
    Set getDependencies(@Nullable Task task);
}