org.gradle.api.plugins.PluginCollection 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 2010 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.plugins;

import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.DomainObjectSet;
import org.gradle.api.Plugin;
import org.gradle.api.specs.Spec;

import java.util.Collection;

/**
 * A {@code PluginCollection} represents a collection of {@link org.gradle.api.Plugin} instances.
 *
 * @param  The type of plugins which this collection contains.
 */
public interface PluginCollection extends DomainObjectSet {
    /**
     * {@inheritDoc}
     */
    @Override
    PluginCollection matching(Spec spec);

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

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

    /**
     * Adds an {@code Action} to be executed when a plugin is added to this collection.
     *
     * @param action The action to be executed
     * @return the supplied action
     */
    @SuppressWarnings("UnusedDeclaration")
    Action whenPluginAdded(Action action);

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

    /**
     * Unsupported.
     * @deprecated Use {@link PluginManager#apply(Class)} instead.
     */
    @Override
    @Deprecated
    boolean add(T plugin);

    /**
     * Unsupported.
     * @deprecated Use {@link PluginManager#apply(Class)} instead.
     */
    @Deprecated
    @Override
    boolean addAll(Collection c);

    /**
     * Unsupported.
     * @deprecated plugins cannot be removed.
     */
    @Override
    @Deprecated
    boolean remove(Object o);

    /**
     * Unsupported.
     * @deprecated plugins cannot be removed.
     */
    @Override
    @Deprecated
    boolean removeAll(Collection c);

    /**
     * Unsupported.
     * @deprecated plugins cannot be removed.
     */
    @Override
    @Deprecated
    void clear();
}