Interface Aggregate

public interface Aggregate

An object with dependencies.

By default, Aggregates have no dependencies.

Author:

Laird Nelson

See Also:

• dependencies()

Field Summary

Fields

Modifier and Type	Field	Description
static final SequencedSet<Assignment<?>>	EMPTY_ASSIGNMENTS	An immutable, empty SequencedSet of Assignments.
static final SequencedSet<Annotated<Element>>	EMPTY_DEPENDENCIES	An immutable, empty SequencedSet of Elements.

Method Summary

Modifier and Type	Method	Description
default SequencedSet<? extends Assignment<?>>	assign(Function<? super Annotated<? extends AnnotatedConstruct>, ?> r)	A convenience method that assigns a contextual reference to each of this Aggregate's Annotated<? extends Element>-typed dependencies and returns the resulting SequencedSet of Assignments.
default SequencedSet<? extends Annotated<? extends Element>>	dependencies()	Returns an immutable, determinate, SequencedSet of Annotated<? extends Element> instances.

Field Details

EMPTY_ASSIGNMENTS

static final SequencedSet<Assignment<?>> EMPTY_ASSIGNMENTS

An immutable, empty SequencedSet of Assignments.

EMPTY_DEPENDENCIES

static final SequencedSet<Annotated<Element>> EMPTY_DEPENDENCIES

An immutable, empty SequencedSet of Elements.

Method Details

dependencies

default SequencedSet<? extends Annotated<? extends Element>> dependencies()

Returns an immutable, determinate, SequencedSet of Annotated<? extends Element> instances.

If an Annotated<? extends Element> in the set represents this very Aggregate implementation, undefined behavior, including the possibility of infinite loops, may result (an Aggregate may not have itself as a dependency).

Note that it is permissible for an Annotated<? extends Element> in the set to represent another type.

The default implementation of this method returns the value of the EMPTY_DEPENDENCIES field.

Returns:

an immutable, determinate, SequencedSet of Annotated<? extends Element> instances; never null

See Also:

• Annotated
• Annotated.of(AnnotatedConstruct)

assign

default SequencedSet<? extends Assignment<?>> assign(Function<? super Annotated<? extends AnnotatedConstruct>, ?> r)

A convenience method that assigns a contextual reference to each of this Aggregate's Annotated<? extends Element>-typed dependencies and returns the resulting SequencedSet of Assignments.

Note: Undefined behavior may result if an Annotated<? extends Element> in the dependencies represents this Aggregate implementation (an Aggregate may not have itself as a dependency).

Typically there is no need to override this method.

Usage of this method is not required.

Parameters:

r - a Function that retrieves a contextual reference suitable for an Annotated<? extends AnnotatedConstruct>; if dependencies() returns a non-empty SequencedSet then this argument must not be null

Returns:

an immutable SequencedSet of Assignment instances; never null

Throws:

NullPointerException - if r is null