T
- the contract type for all items@Incubating public interface ModelMap<T> extends CollectionBuilder<T>, Iterable<T>
Managed
types may declare model map properties.
Model maps can only contain managed types.
Modifier and Type | Method and Description |
---|---|
void |
afterEach(Action<? super T> configAction)
Applies the given action to each item in the collection, as each item is required.
|
<S> void |
afterEach(Class<S> type,
Action<? super S> configAction)
Applies the given action to each item of the given type in the collection, as each item is required.
|
void |
all(Action<? super T> configAction)
Applies the given action to each item in the collection, as each item is required.
|
void |
beforeEach(Action<? super T> configAction)
Applies the given action to each item in this collection, as each item is required.
|
<S> void |
beforeEach(Class<S> type,
Action<? super S> configAction)
Applies the given action to each item of the given type in this collection, as each item is required.
|
boolean |
containsKey(Object name)
Returns true if this collection contains an item with the given name.
|
boolean |
containsValue(Object item)
Returns true if this collection contains the given item.
|
void |
create(String name)
Defines an item with the given name and type T.
|
void |
create(String name,
Action<? super T> configAction)
Defines an item with the given name and type T.
|
<S extends T> |
create(String name,
Class<S> type)
Defines an item with the given name and type.
|
<S extends T> |
create(String name,
Class<S> type,
Action<? super S> configAction)
Defines an item with the given name and type.
|
T |
get(Object name)
Returns the item with the given name, if any.
|
T |
get(String name)
Returns the item with the given name, if any.
|
boolean |
isEmpty()
Returns true if this collection contains no items.
|
Set<String> |
keySet()
Returns the names of the items in this collection.
|
void |
named(String name,
Action<? super T> configAction)
Applies the given action to the given item, when the item is required.
|
void |
named(String name,
Class<? extends RuleSource> ruleSource)
Applies the given rule source class to the given item, when the item is required.
|
void |
put(String name,
T instance)
This should be internal.
|
int |
size()
Returns the number of items in this collection.
|
Collection<T> |
values()
Returns the items in this collection.
|
<S> ModelMap<S> |
withType(Class<S> type)
Returns a collection containing the items from this collection which are of the specified type.
|
<S> void |
withType(Class<S> type,
Action<? super S> configAction)
Applies the given action to each item of the given type in the collection, as each item is required.
|
<S> void |
withType(Class<S> type,
Class<? extends RuleSource> rules)
Applies the given rules to all items of the collection of the given type.
|
<S> ModelMap<S> withType(Class<S> type)
withType
in interface CollectionBuilder<T>
S
- The type.type
- The type.int size()
size
in interface CollectionBuilder<T>
boolean isEmpty()
isEmpty
in interface CollectionBuilder<T>
@Nullable T get(Object name)
get
in interface CollectionBuilder<T>
name
- The name of the item.@Nullable T get(String name)
get
in interface CollectionBuilder<T>
name
- The name of the item.boolean containsKey(Object name)
containsKey
in interface CollectionBuilder<T>
name
- The name of the item.boolean containsValue(Object item)
containsValue
in interface CollectionBuilder<T>
item
- The item.Set<String> keySet()
keySet
in interface CollectionBuilder<T>
void create(String name)
create
in interface CollectionBuilder<T>
name
- The name.void create(String name, Action<? super T> configAction)
The given action is invoked to configure the item when the item is required.
create
in interface CollectionBuilder<T>
name
- The name.configAction
- An action that initialises the item. The action is executed when the item is required.<S extends T> void create(String name, Class<S> type)
create
in interface CollectionBuilder<T>
name
- The name.<S extends T> void create(String name, Class<S> type, Action<? super S> configAction)
The given action is invoked to configure the item when the item is required.
create
in interface CollectionBuilder<T>
name
- The name.configAction
- An action that initialises the item. The action is executed when the item is required.void named(String name, Action<? super T> configAction)
The given action is invoked to configure the item when the item is required. It is called after any actions provided to CollectionBuilder.beforeEach(org.gradle.api.Action)
and CollectionBuilder.create(String,
org.gradle.api.Action)
.
named
in interface CollectionBuilder<T>
name
- The name.configAction
- An action that configures the item. The action is executed when the item is required.void named(String name, Class<? extends RuleSource> ruleSource)
Rules are applied in the scope of the item therefore:
named
in interface CollectionBuilder<T>
name
- The name.ruleSource
- A rule source class.void beforeEach(Action<? super T> configAction)
The given action is invoked to configure the item when the item is required. It is called before any actions provided to CollectionBuilder.create(String, org.gradle.api.Action)
.
beforeEach
in interface CollectionBuilder<T>
configAction
- An action that configures the item. The action is executed when the item is required.<S> void beforeEach(Class<S> type, Action<? super S> configAction)
The given action is invoked to configure the item when the item is required. It is called before any actions provided to CollectionBuilder.create(String, org.gradle.api.Action)
.
beforeEach
in interface CollectionBuilder<T>
type
- The type of elements to apply the action to.configAction
- An action that configures the item. The action is executed when the item is required.void all(Action<? super T> configAction)
The given action is invoked to configure the item when the item is required. It is called after any actions provided to CollectionBuilder.beforeEach(org.gradle.api.Action)
and CollectionBuilder.create(String,
org.gradle.api.Action)
.
all
in interface CollectionBuilder<T>
configAction
- An action that configures the item. The action is executed when the item is required.<S> void withType(Class<S> type, Action<? super S> configAction)
The given action is invoked to configure the item when the item is required. It is called after any actions provided to CollectionBuilder.beforeEach(org.gradle.api.Action)
and CollectionBuilder.create(String,
org.gradle.api.Action)
.
withType
in interface CollectionBuilder<T>
type
- The type of elements to apply the action to.configAction
- An action that configures the item. The action is executed when the item is required.<S> void withType(Class<S> type, Class<? extends RuleSource> rules)
CollectionBuilder
withType
in interface CollectionBuilder<T>
type
- the type that the item must be/implement to have the rules appliedrules
- rules to applyvoid afterEach(Action<? super T> configAction)
CollectionBuilder
The given action is invoked to configure the item when the item is required. It is called after any actions provided to CollectionBuilder.beforeEach(org.gradle.api.Action)
, CollectionBuilder.create(String,
org.gradle.api.Action)
, and other mutation methods.
afterEach
in interface CollectionBuilder<T>
configAction
- An action that configures the item. The action is executed when the item is required.<S> void afterEach(Class<S> type, Action<? super S> configAction)
CollectionBuilder
The given action is invoked to configure the item when the item is required. It is called after any actions provided to CollectionBuilder.beforeEach(org.gradle.api.Action)
, CollectionBuilder.create(String,
org.gradle.api.Action)
, and other mutation methods.
afterEach
in interface CollectionBuilder<T>
type
- The type of elements to apply the action to.configAction
- An action that configures the item. The action is executed when the item is required.Collection<T> values()
values
in interface CollectionBuilder<T>