Package akka.persistence.typed.internal

Class EffectImpl<Event,State>

java.lang.Object

akka.persistence.typed.javadsl.EffectBuilder<Event,State>

akka.persistence.typed.internal.EffectImpl<Event,State>

All Implemented Interfaces:

Effect<Event,State>, ReplyEffect<Event,State>, Effect<Event,State>, EffectBuilder<Event,State>, ReplyEffect<Event,State>

Direct Known Subclasses:

CompositeEffect, Persist, PersistAll, PersistNothing$, Stash$, Unhandled$

public abstract class EffectImpl<Event,State>
extends EffectBuilder<Event,State>
implements ReplyEffect<Event,State>, ReplyEffect<Event,State>, EffectBuilder<Event,State>

INTERNAL API

Constructor Summary

Constructors

Constructor	Description
EffectImpl()

Method Summary

Modifier and Type	Method	Description
scala.collection.immutable.Seq<Event>	events()
EffectImpl<Event,State>	thenNoReply()	When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
<ReplyMessage> EffectImpl<Event,State>	thenReply(ExpectingReply<ReplyMessage> cmd, scala.Function1<State,ReplyMessage> replyWithMessage)	Send a reply message to the command, which implements ExpectingReply.
EffectImpl<Event,State>	thenRun(scala.Function1<State,scala.runtime.BoxedUnit> chainedEffect)	Run the given callback.
EffectImpl<Event,State>	thenStop()	The side effect is to stop the actor
EffectImpl<Event,State>	thenUnstashAll()	Unstash the commands that were stashed with EffectFactories.stash.

Methods inherited from class akka.persistence.typed.javadsl.EffectBuilder

thenReply, thenRun, thenRun

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectImpl

public EffectImpl()

Method Detail

events

public scala.collection.immutable.Seq<Event> events()

Specified by:

events in interface EffectBuilder<Event,State>

thenNoReply

public EffectImpl<Event,State> thenNoReply()

Description copied from class: EffectBuilder

When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This thenNoReply can be used as a conscious decision that a reply shouldn't be sent for a specific command or the reply will be sent later.

Specified by:

thenNoReply in interface EffectBuilder<Event,State>

Specified by:

thenNoReply in class EffectBuilder<Event,State>

Returns:

(undocumented)

thenReply

public <ReplyMessage> EffectImpl<Event,State> thenReply(ExpectingReply<ReplyMessage> cmd,
                                                              scala.Function1<State,ReplyMessage> replyWithMessage)

Description copied from interface: EffectBuilder

Send a reply message to the command, which implements ExpectingReply. The type of the reply message must conform to the type specified in ExpectingReply.replyTo ActorRef.

This has the same semantics as cmd.replyTo.tell.

It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the EventSourcedBehavior is created with EventSourcedBehavior.withEnforcedReplies. When withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also if withEnforcedReplies isn't used, but then the compiler will not help finding mistakes.

Specified by:

thenReply in interface EffectBuilder<Event,State>

Parameters:

cmd - (undocumented)

replyWithMessage - (undocumented)

Returns:

(undocumented)

thenRun

public EffectImpl<Event,State> thenRun(scala.Function1<State,scala.runtime.BoxedUnit> chainedEffect)

Description copied from interface: EffectBuilder

Run the given callback. Callbacks are run sequentially.

Specified by:

thenRun in interface EffectBuilder<Event,State>

Parameters:

chainedEffect - (undocumented)

Returns:

(undocumented)

thenStop

public EffectImpl<Event,State> thenStop()

Description copied from class: EffectBuilder

The side effect is to stop the actor

Specified by:

thenStop in interface EffectBuilder<Event,State>

Specified by:

thenStop in class EffectBuilder<Event,State>

thenUnstashAll

public EffectImpl<Event,State> thenUnstashAll()

Description copied from class: EffectBuilder

Unstash the commands that were stashed with EffectFactories.stash.

It's allowed to stash messages while unstashing. Those newly added commands will not be processed by this unstashAll effect and have to be unstashed by another unstashAll.

Specified by:

thenUnstashAll in interface EffectBuilder<Event,State>

Specified by:

thenUnstashAll in interface ReplyEffect<Event,State>

Specified by:

thenUnstashAll in interface ReplyEffect<Event,State>

Specified by:

thenUnstashAll in class EffectBuilder<Event,State>

Returns:

(undocumented)