io.vlingo.scooter.model.object

Class ObjectEntity<S extends io.vlingo.symbio.store.object.StateObject,C>

java.lang.Object

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

io.vlingo.scooter.model.object.ObjectEntity<S,C>

public abstract class ObjectEntity<S extends io.vlingo.symbio.store.object.StateObject,C>
extends Entity<S,C>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	apply(S state) Apply state to myself.
protected void	apply(S state, List<io.vlingo.symbio.Source<C>> sources) Apply state and sources to myself.
protected void	apply(S state, List<io.vlingo.symbio.Source<C>> sources, io.vlingo.symbio.Metadata metadata) Apply state and sources to myself.
protected void	apply(S state, io.vlingo.symbio.Source<C> source) Apply state and source to myself.
protected void	apply(S state, io.vlingo.symbio.Source<C> source, io.vlingo.symbio.Metadata metadata) Apply state, sources, with metadata to myself.
protected List<io.vlingo.symbio.Source<C>>	asList(io.vlingo.symbio.Source<C>... sources) Answer a List<Source<C>> from the varargs sources.
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 io.vlingo.symbio.Metadata	metadata() Answer my Metadata.
protected abstract void	stateObject(S stateObject) Received by my extender when my state object has been preserved and restored.

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

applied, applied, currentVersion, nextVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectEntity

protected ObjectEntity()

Construct my default state.

Method Detail

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 extends io.vlingo.symbio.store.object.StateObject,C>

Returns:

String

apply

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

Apply state and sources to myself.

Parameters:

state - the Object state to preserve

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

metadata - the Metadata to apply along with source

apply

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

Apply state, sources, with metadata to myself.

Parameters:

state - the Object state to preserve

source - the Source<C> to apply

metadata - the Metadata to apply along with source

apply

protected void apply(S state)

Apply state to myself.

Parameters:

state - the Object state to preserve

apply

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

Apply state and sources to myself.

Parameters:

state - the S state to preserve

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

apply

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

Apply state and source to myself.

Parameters:

state - the T typed state to apply

source - the Source<C> instances to apply

asList

@SafeVarargs
protected final List<io.vlingo.symbio.Source<C>> asList(io.vlingo.symbio.Source<C>... sources)

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

Parameters:

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

Returns:

List<Source<C>>

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

metadata

protected io.vlingo.symbio.Metadata metadata()

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

Returns:

Metadata

stateObject

protected abstract void stateObject(S stateObject)

Received by my extender when my state object has been preserved and restored. Must be overridden by my extender.

Parameters:

stateObject - the T typed state object