Remove ApiMayChange from Durable State (#30733)

This commit is contained in:
Patrik Nordwall 2021-10-06 17:22:07 +02:00 committed by GitHub
parent 2050b62090
commit e0ce825a55
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 0 additions and 52 deletions

View file

@ -30,5 +30,4 @@ These are the current complete modules marked as **may change**:
* @ref:[Multi Node Testing](../multi-node-testing.md)
* @ref:[Reliable Delivery](../typed/reliable-delivery.md)
* @ref:[Durable State](../typed/durable-state/persistence.md)

View file

@ -22,14 +22,6 @@ To use Akka Persistence, add the module to your project:
You also have to select durable state store plugin, see @ref:[Persistence Plugins](../../persistence-plugins.md).
@@@ warning
This module is currently marked as @ref:[may change](../../common/may-change.md) because it is a new feature that
needs feedback from real usage before finalizing the API. This means that API or semantics can change without
warning or deprecation period. It is also not recommended to use this module in production just yet.
@@@
@@project-info{ projectId="akka-persistence-typed" }
## Introduction

View file

@ -4,12 +4,9 @@
package akka.persistence.query
import akka.annotation.ApiMayChange
import akka.annotation.DoNotInherit
/**
* API May Change
*
* The `DurableStateStoreQuery` stream elements for `DurableStateStoreQuery`.
*
* The implementation can be a [[UpdatedDurableState]] or a `DeletedDurableState`.
@ -35,16 +32,11 @@ sealed trait DurableStateChange[A] {
object UpdatedDurableState {
/**
* API May Change
*/
@ApiMayChange
def unapply[A](arg: UpdatedDurableState[A]): Option[(String, Long, A, Offset, Long)] =
Some((arg.persistenceId, arg.revision, arg.value, arg.offset, arg.timestamp))
}
/**
* API May Change
*
* @param persistenceId The persistence id of the origin entity.
* @param revision The revision number from the origin entity.
@ -54,7 +46,6 @@ object UpdatedDurableState {
* (same as `System.currentTimeMillis`).
* @tparam A the type of the value
*/
@ApiMayChange
final class UpdatedDurableState[A](
val persistenceId: String,
val revision: Long,

View file

@ -5,7 +5,6 @@
package akka.persistence.query.javadsl
import akka.NotUsed
import akka.annotation.ApiMayChange
import akka.persistence.state.javadsl.DurableStateStore
import akka.persistence.query.DurableStateChange
import akka.persistence.query.Offset
@ -15,10 +14,7 @@ import akka.stream.javadsl.Source
* Query API for reading durable state objects.
*
* For Scala API see [[akka.persistence.query.scaladsl.DurableStateStoreQuery]].
*
* API May Change
*/
@ApiMayChange
trait DurableStateStoreQuery[A] extends DurableStateStore[A] {
/**

View file

@ -5,7 +5,6 @@
package akka.persistence.query.scaladsl
import akka.NotUsed
import akka.annotation.ApiMayChange
import akka.persistence.query.DurableStateChange
import akka.persistence.state.scaladsl.DurableStateStore
import akka.persistence.query.Offset
@ -15,10 +14,7 @@ import akka.stream.scaladsl.Source
* Query API for reading durable state objects.
*
* For Java API see [[akka.persistence.query.javadsl.DurableStateStoreQuery]].
*
* API May Change
*/
@ApiMayChange
trait DurableStateStoreQuery[A] extends DurableStateStore[A] {
/**

View file

@ -4,8 +4,6 @@
package akka.persistence.state
import akka.annotation.ApiMayChange
/**
* A durable state store plugin must implement a class that implements this trait.
* It provides the concrete implementations for the Java and Scala APIs.
@ -13,10 +11,7 @@ import akka.annotation.ApiMayChange
* A durable state store plugin plugin must provide implementations for both
* `akka.persistence.state.scaladsl.DurableStateStore` and `akka.persistence.state.javadsl.DurableStateStore`.
* One of the implementations can delegate to the other.
*
* API May Change
*/
@ApiMayChange
trait DurableStateStoreProvider {
/**

View file

@ -14,7 +14,6 @@ import akka.actor.ExtendedActorSystem
import akka.actor.Extension
import akka.actor.ExtensionId
import akka.actor.ExtensionIdProvider
import akka.annotation.ApiMayChange
import akka.annotation.InternalApi
import akka.persistence.Persistence
import akka.persistence.PersistencePlugin
@ -24,10 +23,7 @@ import akka.util.unused
/**
* Persistence extension for queries.
*
* API May Change
*/
@ApiMayChange
object DurableStateStoreRegistry extends ExtensionId[DurableStateStoreRegistry] with ExtensionIdProvider {
override def get(system: ActorSystem): DurableStateStoreRegistry = super.get(system)
@ -47,7 +43,6 @@ object DurableStateStoreRegistry extends ExtensionId[DurableStateStoreRegistry]
}
@ApiMayChange
class DurableStateStoreRegistry(system: ExtendedActorSystem)
extends PersistencePlugin[scaladsl.DurableStateStore[_], javadsl.DurableStateStore[_], DurableStateStoreProvider](
system)(ClassTag(classOf[DurableStateStoreProvider]), DurableStateStoreRegistry.pluginProvider)

View file

@ -9,7 +9,6 @@ import java.util.concurrent.CompletionStage
import scala.compat.java8.OptionConverters._
import akka.annotation.ApiMayChange
import akka.persistence.state.scaladsl.{ GetObjectResult => SGetObjectResult }
/**
@ -18,10 +17,7 @@ import akka.persistence.state.scaladsl.{ GetObjectResult => SGetObjectResult }
* For Scala API see [[akka.persistence.state.scaladsl.DurableStateStore]].
*
* See also [[DurableStateUpdateStore]]
*
* API May Change
*/
@ApiMayChange
trait DurableStateStore[A] {
def getObject(persistenceId: String): CompletionStage[GetObjectResult[A]]

View file

@ -7,16 +7,12 @@ package akka.persistence.state.javadsl
import java.util.concurrent.CompletionStage
import akka.Done
import akka.annotation.ApiMayChange
/**
* API for updating durable state objects.
*
* For Scala API see [[akka.persistence.state.scaladsl.DurableStateUpdateStore]].
*
* API May Change
*/
@ApiMayChange
trait DurableStateUpdateStore[A] extends DurableStateStore[A] {
/**

View file

@ -7,7 +7,6 @@ package akka.persistence.state.scaladsl
import scala.concurrent.Future
import scala.compat.java8.OptionConverters._
import akka.annotation.ApiMayChange
import akka.persistence.state.javadsl.{ GetObjectResult => JGetObjectResult }
/**
@ -16,10 +15,7 @@ import akka.persistence.state.javadsl.{ GetObjectResult => JGetObjectResult }
* For Java API see [[akka.persistence.state.javadsl.DurableStateStore]].
*
* See also [[DurableStateUpdateStore]]
*
* API May Change
*/
@ApiMayChange
trait DurableStateStore[A] {
def getObject(persistenceId: String): Future[GetObjectResult[A]]

View file

@ -7,16 +7,12 @@ package akka.persistence.state.scaladsl
import scala.concurrent.Future
import akka.Done
import akka.annotation.ApiMayChange
/**
* API for updating durable state objects.
*
* For Java API see [[akka.persistence.state.javadsl.DurableStateUpdateStore]].
*
* API May Change
*/
@ApiMayChange
trait DurableStateUpdateStore[A] extends DurableStateStore[A] {
/**