io.vlingo.scooter.model.stateful

Class StatefulEntity<S,C>

java.lang.Object

io.vlingo.scooter.model.Entity<S,C>

io.vlingo.scooter.model.stateful.StatefulEntity<S,C>

public abstract class StatefulEntity<S,C>
extends Entity<S,C>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StatefulEntity() Construct my default state.

Method Summary

Modifier and Type	Method and Description
protected void	apply(S state) Apply my current state.
protected void	apply(S state, List<io.vlingo.symbio.Source<C>> sources) Apply my current state and sources.
protected void	apply(S state, List<io.vlingo.symbio.Source<C>> sources, String operation) Apply my current state that was modified due to the descriptive operation.
protected void	apply(S state, List<io.vlingo.symbio.Source<C>> sources, String metadataValue, String operation) Apply my current state and metadataValye that was modified due to the descriptive operation.
protected void	apply(S state, io.vlingo.symbio.Source<C> source) Apply my current state and source.
protected void	apply(S state, String operation) Apply my current state that was modified due to the descriptive operation.
protected void	apply(S state, String metadataValue, String operation) Apply my current state and metadataValye that was modified due to the descriptive operation.
int	currentVersion() Answer my currentVersion, which, if zero, indicates that the receiver is being initially constructed or reconstituted.
abstract String	id() Answer my unique identity, which much be provided by my concrete extender by overriding.
protected String	idFrom(String separator, String... idSegments) Answer a representation of a number of segments as a composite id.
protected abstract void	state(S state) Received by my extender when my current state has been applied and restored.

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

applied, applied, nextVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

StatefulEntity

protected StatefulEntity()

Construct my default state.

Method Detail

currentVersion

public int currentVersion()

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

Overrides:

currentVersion in class Entity<S,C>

Returns:

int

id

public abstract String id()

Answer my unique identity, which much be provided by my concrete extender by overriding.

Specified by:

id in class Entity<S,C>

Returns:

String

apply

protected void apply(S state,
                     List<io.vlingo.symbio.Source<C>> sources,
                     String metadataValue,
                     String operation)

Apply my current state and metadataValye that was modified due to the descriptive operation.

Parameters:

state - the S typed state to apply

sources - the List<Source> instances to apply

metadataValue - the String metadata value to apply along with the state

operation - the String descriptive name of the operation that caused the state modification

apply

protected void apply(S state,
                     String metadataValue,
                     String operation)

Apply my current state and metadataValye that was modified due to the descriptive operation.

Parameters:

state - the S typed state to apply

metadataValue - the String metadata value to apply along with the state

operation - the String descriptive name of the operation that caused the state modification

apply

protected void apply(S state,
                     List<io.vlingo.symbio.Source<C>> sources,
                     String operation)

Apply my current state that was modified due to the descriptive operation.

Parameters:

state - the S typed state to apply

sources - the List<Source> instances to apply

operation - the String descriptive name of the operation that caused the state modification

apply

protected void apply(S state,
                     String operation)

Apply my current state that was modified due to the descriptive operation.

Parameters:

state - the S typed state to apply

operation - the String descriptive name of the operation that caused the state modification

apply

protected void apply(S state,
                     List<io.vlingo.symbio.Source<C>> sources)

Apply my current state and sources.

Parameters:

state - the S typed state to apply

sources - the List<Source<C>> instances to apply

apply

protected void apply(S state,
                     io.vlingo.symbio.Source<C> source)

Apply my current state and source.

Parameters:

state - the S typed state to apply

source - the Source<C> instances to apply

apply

protected void apply(S state)

Apply my current state.

Parameters:

state - the S typed state to apply

idFrom

protected String idFrom(String separator,
                        String... idSegments)

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

Parameters:

separator - the String separator the insert between segments

idSegments - the varargs String of one or more segments

Returns:

String

state

protected abstract void state(S state)

Received by my extender when my current state has been applied and restored. Must be overridden by my extender.

Parameters:

state - the S typed state