io.vlingo.scooter.model.sourced

Class SourcedEntity<T>

java.lang.Object

io.vlingo.scooter.model.Entity<Object,T>

io.vlingo.scooter.model.sourced.SourcedEntity<T>

Direct Known Subclasses:

CommandSourcedEntity, EventSourcedEntity

public abstract class SourcedEntity<T>
extends Entity<Object,T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SourcedEntity() Construct my default state.
protected	SourcedEntity(List<io.vlingo.symbio.Source<T>> stream, int currentVersion) Construct my default state.

Method Summary

Modifier and Type	Method and Description
protected void	apply(List<io.vlingo.symbio.Source<T>> sources) Apply all of the given sources to myself, which includes appending them to my journal and reflecting the representative changes to my state.
protected void	apply(List<io.vlingo.symbio.Source<T>> sources, io.vlingo.symbio.Metadata metadata) Apply all of the given sources to myself along with metadata.
protected void	apply(io.vlingo.symbio.Source<T> source) Apply the given source to myself.
protected void	apply(io.vlingo.symbio.Source<T> source, io.vlingo.symbio.Metadata metadata) Apply the given source to myself with metadata.
protected List<io.vlingo.symbio.Source<T>>	asList(io.vlingo.symbio.Source<T>... sources) Answer a List<Source<T>> from the varargs sources.
int	currentVersion() Answer my currentVersion, which, if zero, indicates that the receiver is being initially constructed or reconstituted.
protected io.vlingo.symbio.Metadata	metadata() Answer my Metadata.
static <SOURCED extends SourcedEntity<?>,SOURCE extends io.vlingo.symbio.Source<?>> void	registerConsumer(Class<SOURCED> sourcedType, Class<SOURCE> sourceType, BiConsumer<SOURCED,SOURCE> consumer) Register the means to apply sourceType instances for state transition of sourcedType by means of a given consumer.
protected <SNAPSHOT> SNAPSHOT	snapshot() Answer a valid SNAPSHOT state instance if a snapshot should be taken and persisted along with applied Source<T> instance(s).
protected abstract String	streamName() Answer my stream name.
protected String	streamNameFrom(String separator, String... streamNameSegments) Answer a representation of a number of segments as a composite stream name.
String	type() Answer my type name.

Methods inherited from class io.vlingo.scooter.model.Entity

applied, applied, id, nextVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourcedEntity

protected SourcedEntity()

Construct my default state.

SourcedEntity

protected SourcedEntity(List<io.vlingo.symbio.Source<T>> stream,
                        int currentVersion)

Construct my default state.

Parameters:

stream - the List<Source<T>> with which to initialize my state

currentVersion - the int to set as my currentVersion

Method Detail

registerConsumer

public static <SOURCED extends SourcedEntity<?>,SOURCE extends io.vlingo.symbio.Source<?>> void registerConsumer(Class<SOURCED> sourcedType,
                                                                                                                 Class<SOURCE> sourceType,
                                                                                                                 BiConsumer<SOURCED,SOURCE> consumer)

Register the means to apply sourceType instances for state transition of sourcedType by means of a given consumer.

Type Parameters:

SOURCED - the type <? extends Sourced<?>> of the sourced entity to apply to

SOURCE - the type <? extends Source<?>> of the source to be applied

Parameters:

sourcedType - the concrete Class<SOURCED> type to which sourceType instances are applied

sourceType - the concrete Class<SOURCE> type to apply

consumer - the BiConsumer<SOURCED, SOURCE> used to perform the application of sourceType

currentVersion

public int currentVersion()

Description copied from class: Entity

Answer my currentVersion, which, if zero, indicates that the receiver is being initially constructed or reconstituted.

Overrides:

currentVersion in class Entity<Object,T>

Returns:

int

type

public String type()

Answer my type name.

Returns:

String

apply

protected final void apply(List<io.vlingo.symbio.Source<T>> sources)

Apply all of the given sources to myself, which includes appending them to my journal and reflecting the representative changes to my state.

Parameters:

sources - the List<Source<T>> to apply

apply

protected final void apply(List<io.vlingo.symbio.Source<T>> sources,
                           io.vlingo.symbio.Metadata metadata)

Apply all of the given sources to myself along with metadata.

Parameters:

sources - the List<Source<T>> to apply

metadata - the Metadata to apply along with source

apply

protected final void apply(io.vlingo.symbio.Source<T> source)

Apply the given source to myself.

Parameters:

source - the Source<T> to apply

apply

protected final void apply(io.vlingo.symbio.Source<T> source,
                           io.vlingo.symbio.Metadata metadata)

Apply the given source to myself with metadata.

Parameters:

source - the Source<T> to apply

metadata - the Metadata to apply along with source

asList

protected List<io.vlingo.symbio.Source<T>> asList(io.vlingo.symbio.Source<T>... sources)

Answer a List<Source<T>> from the varargs sources.

Parameters:

sources - the varargs Source<T> of sources to answer as a List<Source<T>>

Returns:

List<Source<T>>

metadata

protected io.vlingo.symbio.Metadata metadata()

Answer my Metadata. Must override if Metadata is to be supported.

Returns:

Metadata

snapshot

protected <SNAPSHOT> SNAPSHOT snapshot()

Answer a valid SNAPSHOT state instance if a snapshot should be taken and persisted along with applied Source<T> instance(s). Must override if snapshots are to be supported.

Type Parameters:

SNAPSHOT - the type of the snapshot

Returns:

SNAPSHOT

streamName

protected abstract String streamName()

Answer my stream name. Must override.

Returns:

String

streamNameFrom

protected String streamNameFrom(String separator,
                                String... streamNameSegments)

Answer a representation of a number of segments as a composite stream name. The implementor of streamName() would use this method if the its stream name is built from segments.

Parameters:

separator - the String separator the insert between segments

streamNameSegments - the varargs String of one or more segments

Returns:

String