DomainObjectView (docs 0.5.0-930919a0 API)

Type Parameters:

T - type of the elements in this view

All Known Subinterfaces:

ComponentContainer, DomainObjectContainer<T>, FunctionalSourceSet, NamedDomainObjectView<T>, TestSuiteContainer

All Known Implementing Classes:

dev.nokee.language.base.internal.BaseFunctionalSourceSet, dev.nokee.model.internal.BaseNamedDomainObjectView, CApplicationSources, CLibrarySources, CppApplicationSources, CppLibrarySources, JavaNativeInterfaceLibrarySources, NativeApplicationSources, NativeLibrarySources, ObjectiveCApplicationSources, ObjectiveCIosApplicationSources, ObjectiveCLibrarySources, ObjectiveCppApplicationSources, ObjectiveCppLibrarySources, SwiftApplicationSources, SwiftIosApplicationSources, SwiftLibrarySources
```
public interface DomainObjectView<T>
```
A view of a collection that are created and configured as they are required.

Since:

0.5

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`configureEach(Action<? super T> action)` Registers an action to execute to configure each element in the view.
`<S extends T> void`	`configureEach(Class<S> type, Action<? super S> action)` Registers an action to execute to configure each element in the view.
`default <S extends T> void`	`configureEach(Class<S> type, groovy.lang.Closure<Void> closure)` Registers a closure to execute to configure each element in the view.
`default void`	`configureEach(groovy.lang.Closure<Void> closure)` Registers a closure to execute to configure each element in the view.
`void`	`configureEach(Spec<? super T> spec, Action<? super T> action)` Registers an action to execute to configure each element in the view matching the given specification.
`default void`	`configureEach(Spec<? super T> spec, groovy.lang.Closure<Void> closure)` Registers a closure to execute to configure each element in the view matching the given specification.
`Provider<List<T>>`	`filter(Spec<? super T> spec)` Returns a single list containing all elements matching the given specification.
`<S> Provider<List<S>>`	`flatMap(Transformer<? extends Iterable<S>,? super T> mapper)` Returns a single list containing all elements yielded from results of mapper function being invoked on each element of this view.
`Set<T>`	`get()` Returns the contents of this view as a `Set` of `<T>` instances.
`Provider<Set<T>>`	`getElements()` Returns the contents of this view as a `Provider` of `<T>` instances.
`<S> Provider<List<S>>`	`map(Transformer<? extends S,? super T> mapper)` Returns a list containing the results of applying the given mapper function to each element in the view.
`default void`	`whenElementKnownEx(Action<? super KnownDomainObject<T>> action)` Executes given action when an element becomes known to the view.
`default <S extends T> void`	`whenElementKnownEx(Class<S> type, Action<? super KnownDomainObject<S>> action)` Executes given action when an element becomes known to the view of the specified type.
`default <S extends T> void`	`whenElementKnownEx(Class<S> type, groovy.lang.Closure<Void> closure)` Executes given closure when an element becomes known to the view of the specified type.
`default void`	`whenElementKnownEx(groovy.lang.Closure<Void> closure)` Executes given closure when an element becomes known to the view of the specified type.

- Method Detail
  - configureEach
```
void configureEach(Action<? super T> action)
```
    Registers an action to execute to configure each element in the view. The action is only executed for those elements that are required. Fails if any element has already been finalized.
    
    Parameters:
    
    action - The action to execute on each element for configuration.
  - configureEach
```
default void configureEach(@DelegatesTo(type="T",strategy=1)
                           groovy.lang.Closure<Void> closure)
```
    Registers a closure to execute to configure each element in the view. The action is only executed for those elements that are required. Fails if any element has already been finalized.
    
    Parameters:
    
    closure - The closure to execute on each element for configuration.
  - configureEach
```
<S extends T> void configureEach(Class<S> type,
                                 Action<? super S> action)
```
    Registers an action to execute to configure each element in the view. The action is only executed for those elements that are required. Fails if any matching element has already been finalized. This method is equivalent to view.withType(Foo).configureEach { ... }.
    
    Type Parameters:
    
    S - the base type of the element to configure.
    
    Parameters:
    
    type - the type of binary to select.
    
    action - the action to execute on each element for configuration.
  - configureEach
```
default <S extends T> void configureEach(Class<S> type,
                                         @DelegatesTo(type="S",strategy=1)
                                         groovy.lang.Closure<Void> closure)
```
    Registers a closure to execute to configure each element in the view. The action is only executed for those elements that are required. Fails if any matching element has already been finalized. This method is equivalent to view.withType(Foo).configureEach { ... }.
    
    Type Parameters:
    
    S - the base type of the element to configure.
    
    Parameters:
    
    type - the type of binary to select.
    
    closure - the closure to execute on each element for configuration.
  - configureEach
```
void configureEach(Spec<? super T> spec,
                   Action<? super T> action)
```
    Registers an action to execute to configure each element in the view matching the given specification. The action is only executed for those elements that are required. Fails if any element has already been finalized.
    
    Parameters:
    
    spec - a specification to satisfy. The spec is applied to each binary prior to configuration.
    
    action - the action to execute on each element for configuration.
    
    Since:
    
    0.4
  - configureEach
```
default void configureEach(Spec<? super T> spec,
                           @DelegatesTo(type="S",strategy=1)
                           groovy.lang.Closure<Void> closure)
```
    Registers a closure to execute to configure each element in the view matching the given specification. The action is only executed for those elements that are required. Fails if any element has already been finalized.
    
    Parameters:
    
    spec - a specification to satisfy. The spec is applied to each binary prior to configuration.
    
    closure - the closure to execute on each element for configuration.
    
    Since:
    
    0.4
  - getElements
```
Provider<Set<T>> getElements()
```
    Returns the contents of this view as a Provider of <T> instances.
    The returned Provider is live, and tracks changes of the view.
    
    Returns:
    
    a provider containing all the elements included in this view.
  - get
```
Set<T> get()
```
    Returns the contents of this view as a Set of <T> instances.
    
    Returns:
    
    a set containing all the elements included in this view.
  - map
```
<S> Provider<List<S>> map(Transformer<? extends S,? super T> mapper)
```
    Returns a list containing the results of applying the given mapper function to each element in the view.
    The returned Provider is live, and tracks changes of the view.
    
    Type Parameters:
    
    S - the type of the mapped elements
    
    Parameters:
    
    mapper - a transform function to apply on each element of this view
    
    Returns:
    
    a provider containing the transformed elements included in this view.
  - flatMap
```
<S> Provider<List<S>> flatMap(Transformer<? extends Iterable<S>,? super T> mapper)
```
    Returns a single list containing all elements yielded from results of mapper function being invoked on each element of this view.
    The returned Provider is live, and tracks changes of the view.
    
    Type Parameters:
    
    S - the type of the mapped elements
    
    Parameters:
    
    mapper - a transform function to apply on each element of this view
    
    Returns:
    
    a provider containing the mapped elements of this view.
  - filter
```
Provider<List<T>> filter(Spec<? super T> spec)
```
    Returns a single list containing all elements matching the given specification.
    The returned Provider is live, and tracks changes of the view.
    
    Parameters:
    
    spec - a specification to satisfy
    
    Returns:
    
    a provider containing the filtered elements of this view.
  - whenElementKnownEx
```
default void whenElementKnownEx(Action<? super KnownDomainObject<T>> action)
```
    Executes given action when an element becomes known to the view.
    
    Parameters:
    
    action - the action to execute for each known element of this view
  - whenElementKnownEx
```
default void whenElementKnownEx(@DelegatesTo(value=KnownDomainObject.class,strategy=1)
                                groovy.lang.Closure<Void> closure)
```
    Executes given closure when an element becomes known to the view of the specified type.
    
    Parameters:
    
    closure - the closure to execute for each known element of this view
  - whenElementKnownEx
```
default <S extends T> void whenElementKnownEx(Class<S> type,
                                              Action<? super KnownDomainObject<S>> action)
```
    Executes given action when an element becomes known to the view of the specified type.
    
    Type Parameters:
    
    S - the element type to match
    
    Parameters:
    
    type - the element type to match
    
    action - the action to execute for each known element of this view
  - whenElementKnownEx
```
default <S extends T> void whenElementKnownEx(Class<S> type,
                                              @DelegatesTo(type="S",strategy=1)
                                              groovy.lang.Closure<Void> closure)
```
    Executes given closure when an element becomes known to the view of the specified type.
    
    Type Parameters:
    
    S - the element type to match
    
    Parameters:
    
    type - the element type to match
    
    closure - the closure to execute for each known element of this view

Interface DomainObjectView<T>

Method Summary

Method Detail

configureEach

configureEach

configureEach

configureEach

configureEach

configureEach

getElements

get

map

flatMap

filter

whenElementKnownEx

whenElementKnownEx

whenElementKnownEx

whenElementKnownEx