From 0d57c71766bf978a274e50927e69c85ac0895822 Mon Sep 17 00:00:00 2001 From: Christopher Batey Date: Fri, 31 Jan 2020 15:09:02 +0000 Subject: [PATCH] Add paramater documentation for event sourced entities (#28540) * Add paramater documentation for event sourced entities Useful for help in IDEs, text taken from the docs. * whitespace Co-authored-by: Arnout Engelen --- .../persistence/typed/javadsl/EventSourcedBehavior.scala | 7 +++++++ .../persistence/typed/scaladsl/EventSourcedBehavior.scala | 5 +++++ 2 files changed, 12 insertions(+) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/EventSourcedBehavior.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/EventSourcedBehavior.scala index 813d92c141..15976bded4 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/EventSourcedBehavior.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/EventSourcedBehavior.scala @@ -23,10 +23,17 @@ abstract class EventSourcedBehavior[Command, Event, State] private[akka] ( onPersistFailure: Optional[BackoffSupervisorStrategy]) extends DeferredBehavior[Command] { + /** + * @param persistenceId stable unique identifier for the event sourced behavior + */ def this(persistenceId: PersistenceId) = { this(persistenceId, Optional.empty[BackoffSupervisorStrategy]) } + /** + * @param persistenceId stable unique identifier for the event sourced behavior + * @param onPersistFailure BackoffSupervisionStrategy for persist failures + */ def this(persistenceId: PersistenceId, onPersistFailure: BackoffSupervisorStrategy) = { this(persistenceId, Optional.ofNullable(onPersistFailure)) } diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/EventSourcedBehavior.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/EventSourcedBehavior.scala index 7c0987b1b7..44fddfd5ea 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/EventSourcedBehavior.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/EventSourcedBehavior.scala @@ -43,6 +43,11 @@ object EventSourcedBehavior { /** * Create a `Behavior` for a persistent actor. + * + * @param persistenceId stable unique identifier for the event sourced behavior + * @param emtpyState the intial state for the entity before any events have been processed + * @param commandHandler map commands to effects e.g. persisting events, replying to commands + * @param evnetHandler compute the new state given the current state when an event has been persisted */ def apply[Command, Event, State]( persistenceId: PersistenceId,