org.gradle.api.NamedDomainObjectSet 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;

import groovy.lang.Closure;
import org.gradle.api.specs.Spec;

import java.util.Set;

/**
 * A specialization of {@link NamedDomainObjectCollection} that also implements {@link Set} and orders objects by their inherent name.
 *
 * All object equality is determined in terms of object names. That is, calling {@code remove()} with an object that is NOT equal to
 * an existing object in terms of {@code equals}, but IS in terms of name equality will result in the existing collection item with
 * the equal name being removed.
 *
 * You can create an instance of this type using the factory method {@link org.gradle.api.model.ObjectFactory#namedDomainObjectSet(Class)}.
 *
 * @param  The type of objects in the set
 */
public interface NamedDomainObjectSet extends NamedDomainObjectCollection, DomainObjectSet {

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

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

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

    /**
     * {@inheritDoc}
     */
    @Override
    NamedDomainObjectSet matching(Closure spec);

    /**
     * {@inheritDoc}
     */
    @Override
    Set findAll(Closure spec);
}