org.gradle.api

インタフェース NamedDomainObjectContainer<T>

型パラメータ:

T - The type of domain objects in this container.

すべてのスーパーインタフェース:

Collection<T>, org.gradle.util.Configurable<NamedDomainObjectContainer<T>>, DomainObjectCollection<T>, Iterable<T>, NamedDomainObjectCollection<T>, NamedDomainObjectSet<T>, Set<T>

既知のサブインタフェースのリスト:

BinaryContainer, BuildTypeContainer, ComponentSpecContainer, ConfigurationContainer, DistributionContainer, ExtensiblePolymorphicDomainObjectContainer<T>, FlavorContainer, FunctionalSourceSet, IvyConfigurationContainer, PlatformContainer, PolymorphicDomainObjectContainer<T>, ProjectSourceSet, PublicationContainer, Repositories, SourceSetContainer, TaskContainer, TestSuiteContainer, ToolChainRegistry

public interface NamedDomainObjectContainer<T>
extends NamedDomainObjectSet<T>, org.gradle.util.Configurable<NamedDomainObjectContainer<T>>

A named domain object container is a specialisation of NamedDomainObjectSet that adds the ability to create instances of the element type.

Implementations may use different strategies for creating new object instances.

Note that a container is an implementation of SortedSet, which means that the container is guaranteed to only contain elements with unique names within this container. Furthermore, items are ordered by their name.

関連項目:

NamedDomainObjectSet

メソッドの概要

修飾子とタイプ	メソッドと説明
NamedDomainObjectContainer<T>	configure(Closure configureClosure) Allows the container to be configured, creating missing objects as they are referenced.
T	create(String name) Creates a new item with the given name, adding it to this container.
T	create(String name, Action<? super T> configureAction) Creates a new item with the given name, adding it to this container, then configuring it with the given action.
T	create(String name, Closure configureClosure) Creates a new item with the given name, adding it to this container, then configuring it with the given closure.
T	maybeCreate(String name) Looks for an item with the given name, creating and adding it to this container if it does not exist.

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectSet

findAll, matching, matching, withType

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getNames, getRules

インタフェースから継承されたメソッド org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

インタフェースから継承されたメソッド java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

インタフェースから継承されたメソッド java.lang.Iterable

forEach

インタフェースから継承されたメソッド java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

メソッドの詳細

create

T create(String name)
  throws InvalidUserDataException

Creates a new item with the given name, adding it to this container.

パラメータ:

name - The name to assign to the created object

戻り値:

The created object. Never null.

例外:

InvalidUserDataException - if an object with the given name already exists in this container.

maybeCreate

T maybeCreate(String name)

Looks for an item with the given name, creating and adding it to this container if it does not exist.

パラメータ:

name - The name to find or assign to the created object

戻り値:

The found or created object. Never null.

create

T create(String name,
         Closure configureClosure)
  throws InvalidUserDataException

Creates a new item with the given name, adding it to this container, then configuring it with the given closure.

パラメータ:

name - The name to assign to the created object

configureClosure - The closure to configure the created object with

戻り値:

The created object. Never null.

例外:

InvalidUserDataException - if an object with the given name already exists in this container.

create

T create(String name,
         Action<? super T> configureAction)
  throws InvalidUserDataException

Creates a new item with the given name, adding it to this container, then configuring it with the given action.

パラメータ:

name - The name to assign to the created object

configureAction - The action to configure the created object with

戻り値:

The created object. Never null.

例外:

InvalidUserDataException - if an object with the given name already exists in this container.

configure

NamedDomainObjectContainer<T> configure(Closure configureClosure)

Allows the container to be configured, creating missing objects as they are referenced.

TODO: example usage

定義:

configure インタフェース内 org.gradle.util.Configurable<NamedDomainObjectContainer<T>>

パラメータ:

configureClosure - The closure to configure this container with

戻り値:

This.