org.gradle.api.tasks.TaskCollection 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 2009 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 groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.Task;
import org.gradle.api.UnknownTaskException;
import org.gradle.api.provider.Provider;
import org.gradle.api.specs.Spec;

/**
 * A {@code TaskCollection} contains a set of {@link Task} instances, and provides a number of query methods.
 *
 * @param  The type of tasks which this collection contains.
 */
public interface TaskCollection extends NamedDomainObjectSet {

    /**
     * {@inheritDoc}
     */
    @Override
    TaskCollection named(Spec nameFilter);

    /**
     * {@inheritDoc}
     */
    @Override
    TaskCollection matching(Spec spec);

    /**
     * {@inheritDoc}
     */
    @Override
    TaskCollection matching(Closure closure);

    /**
     * {@inheritDoc}
     */
    @Override
    T getByName(String name, Closure configureClosure) throws UnknownTaskException;

    /**
     * {@inheritDoc}
     */
    @Override
    T getByName(String name) throws UnknownTaskException;

    /**
     * {@inheritDoc}
     */
    @Override
     TaskCollection withType(Class type);

    /**
     * Adds an {@code Action} to be executed when a task is added to this collection.
     * 
     * Like {@link #all(Action)}, this method will cause all tasks in this container to be realized.
     * 
     *
     * @param action The action to be executed
     * @return the supplied action
     */
    @SuppressWarnings("UnusedDeclaration")
    Action whenTaskAdded(Action action);

    /**
     * Adds a closure to be called when a task is added to this collection. The task is passed to the closure as the
     * parameter.
     *
     * @param closure The closure to be called
     * @see #whenTaskAdded(Action)
     */
    @SuppressWarnings("UnusedDeclaration")
    void whenTaskAdded(Closure closure);

    /**
     * {@inheritDoc}
     */
    @Override
    T getAt(String name) throws UnknownTaskException;

    /**
     * Locates a task by name, without triggering its creation or configuration, failing if there is no such object.
     *
     *
     * @param name The task name
     * @return A {@link Provider} that will return the task when queried. The task may be created and configured at this point, if not already.
     * @throws UnknownTaskException If a task with the given name is not defined.
     * @since 4.9
     */
    @Override
    TaskProvider named(String name) throws UnknownTaskException;

    /**
     * {@inheritDoc}
     *
     * @since 5.0
     */
    @Override
    TaskProvider named(String name, Action configurationAction) throws UnknownTaskException;

    /**
     * {@inheritDoc}
     *
     * @since 5.0
     */
    @Override
     TaskProvider named(String name, Class type) throws UnknownTaskException;

    /**
     * {@inheritDoc}
     *
     * @since 5.0
     */
    @Override
     TaskProvider named(String name, Class type, Action configurationAction) throws UnknownTaskException;
}