Package org.gradle.api
Interface NamedDomainObjectSet<T>
-
- Type Parameters:
T- The type of objects in the set
- All Superinterfaces:
java.util.Collection<T>,DomainObjectCollection<T>,DomainObjectSet<T>,java.lang.Iterable<T>,NamedDomainObjectCollection<T>,java.util.Set<T>
- All Known Subinterfaces:
ArtifactTypeContainer,AuthenticationContainer,BuildDashboardReports,BuildTypeContainer,CheckstyleReports,CodeNarcReports,ConfigurationContainer,ConfigurationReports,DependencyReportContainer,DistributionContainer,ExtensiblePolymorphicDomainObjectContainer<T>,FlavorContainer,IvyConfigurationContainer,JacocoReportsContainer,MutableVersionCatalogContainer,NamedDomainObjectContainer<T>,NativeToolChainRegistry,PlatformContainer,PmdReports,PolymorphicDomainObjectContainer<T>,PrebuiltLibraries,PublicationContainer,ReportContainer<T>,Repositories,SoftwareComponentContainer,SourceSetContainer,TaskCollection<T>,TaskContainer,TestTaskReports
public interface NamedDomainObjectSet<T> extends NamedDomainObjectCollection<T>, DomainObjectSet<T>
A specialization of
NamedDomainObjectCollectionthat also implementsSetand orders objects by their inherent name.All object equality is determined in terms of object names. That is, calling
remove()with an object that is NOT equal to an existing object in terms ofequals, 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
ObjectFactory.namedDomainObjectSet(Class).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<T>findAll(Closure spec)Returns a collection which contains the objects in this collection which meet the given closure specification.NamedDomainObjectSet<T>matching(Closure spec)Returns a collection which contains the objects in this collection which meet the given closure specification.NamedDomainObjectSet<T>matching(Spec<? super T> spec)Returns a collection which contains the objects in this collection which meet the given specification.NamedDomainObjectSet<T>named(Spec<java.lang.String> nameFilter)Returns a collection containing the objects with names matching the provided filter.<S extends T>
NamedDomainObjectSet<S>withType(java.lang.Class<S> type)Returns a collection containing the objects in this collection of the given type.-
Methods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType
-
-
-
-
Method Detail
-
withType
<S extends T> NamedDomainObjectSet<S> withType(java.lang.Class<S> type)
Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.- Specified by:
withTypein interfaceDomainObjectCollection<T>- Specified by:
withTypein interfaceDomainObjectSet<T>- Specified by:
withTypein interfaceNamedDomainObjectCollection<T>- Parameters:
type- The type of objects to find.- Returns:
- The matching objects. Returns an empty collection if there are no such objects in this collection.
-
named
NamedDomainObjectSet<T> named(Spec<java.lang.String> nameFilter)
Returns a collection containing the objects with names matching the provided filter. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection. This method will NOT cause any pending objects in this container to be realized.- Specified by:
namedin interfaceNamedDomainObjectCollection<T>- Parameters:
nameFilter- The specification to test names against.- Returns:
- The collection of objects with names satisfying the filter. Returns an empty collection if there are no such objects in this collection.
-
matching
NamedDomainObjectSet<T> matching(Spec<? super T> spec)
Returns a collection which contains the objects in this collection which meet the given specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.- Specified by:
matchingin interfaceDomainObjectCollection<T>- Specified by:
matchingin interfaceDomainObjectSet<T>- Specified by:
matchingin interfaceNamedDomainObjectCollection<T>- Parameters:
spec- The specification to use.- Returns:
- The collection of matching objects. Returns an empty collection if there are no such objects in this collection.
-
matching
NamedDomainObjectSet<T> matching(Closure spec)
Returns a collection which contains the objects in this collection which meet the given closure specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.- Specified by:
matchingin interfaceDomainObjectCollection<T>- Specified by:
matchingin interfaceDomainObjectSet<T>- Specified by:
matchingin interfaceNamedDomainObjectCollection<T>- Parameters:
spec- The specification to use. The closure gets a collection element as an argument.- Returns:
- The collection of matching objects. Returns an empty collection if there are no such objects in this collection.
-
findAll
java.util.Set<T> findAll(Closure spec)
Returns a collection which contains the objects in this collection which meet the given closure specification.- Specified by:
findAllin interfaceDomainObjectCollection<T>- Specified by:
findAllin interfaceDomainObjectSet<T>- Parameters:
spec- The specification to use. The closure gets a collection element as an argument.- Returns:
- The collection of matching objects. Returns an empty collection if there are no such objects in this collection.
-
-