raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Scaladoc: Change untyped to classic - General Typed docs cleanup after all API changes #24717 (#27622)

Browse source
This commit is contained in:
Helena Edelson 2019-09-04 07:10:57 -07:00 • committed by GitHub
parent aca63ea198
commit 7e84d242ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

2
akka-actor-typed-tests/src/test/scala/akka/actor/typed/scaladsl/adapter/GuardianStartupSpec.scala
View file

@ -38,7 +38,7 @@ class GuardianStartupSpec extends WordSpec with Matchers with ScalaFutures {
} }
} }
"not start before untyped system initialization is complete" in { "not start before classic system initialization is complete" in {
var system: ActorSystem[String] = null var system: ActorSystem[String] = null
val initialized = new CountDownLatch(1) val initialized = new CountDownLatch(1)
val guardianBehavior = Behaviors.setup[String] { ctx => val guardianBehavior = Behaviors.setup[String] { ctx =>

6
akka-actor-typed/src/main/scala/akka/actor/typed/internal/adapter/ActorSystemAdapter.scala
View file

@ -134,11 +134,11 @@ private[akka] object ActorSystemAdapter {
} }
/** /**
* An untyped extension to load configured typed extensions. It is loaded via * A classic extension to load configured typed extensions. It is loaded via
* akka.library-extensions. `loadExtensions` cannot be called from the AdapterExtension * akka.library-extensions. `loadExtensions` cannot be called from the AdapterExtension
* directly because the adapter is created too early during typed actor system creation. * directly because the adapter is created too early during typed actor system creation.
* *
* When on the classpath typed extensions will be loaded for untyped ActorSystems as well. * When on the classpath typed extensions will be loaded for classic ActorSystems as well.
*/ */
class LoadTypedExtensions(system: untyped.ExtendedActorSystem) extends untyped.Extension { class LoadTypedExtensions(system: untyped.ExtendedActorSystem) extends untyped.Extension {
ActorSystemAdapter.AdapterExtension(system).adapter.loadExtensions() ActorSystemAdapter.AdapterExtension(system).adapter.loadExtensions()
@ -155,7 +155,7 @@ private[akka] object ActorSystemAdapter {
case adapter: ActorSystemAdapter[_] => adapter.untypedSystem case adapter: ActorSystemAdapter[_] => adapter.untypedSystem
case _ => case _ =>
throw new UnsupportedOperationException( throw new UnsupportedOperationException(
"only adapted untyped ActorSystem permissible " + "Only adapted classic ActorSystem permissible " +
s"($sys of class ${sys.getClass.getName})") s"($sys of class ${sys.getClass.getName})")
} }
} }

14
akka-actor-typed/src/main/scala/akka/actor/typed/scaladsl/adapter/package.scala
View file

@ -10,23 +10,23 @@ import akka.actor.typed.internal.adapter.{ PropsAdapter => _, _ }
import akka.annotation.InternalApi import akka.annotation.InternalApi
/** /**
* Scala API: Adapters between typed and untyped actors and actor systems. * Scala API: Adapters between typed and classic actors and actor systems.
* The underlying `ActorSystem` is the untyped [[akka.actor.ActorSystem]] * The underlying `ActorSystem` is the classic [[akka.actor.ActorSystem]]
* which runs Akka Typed [[akka.actor.typed.Behavior]] on an emulation layer. In this * which runs Akka Typed [[akka.actor.typed.Behavior]] on an emulation layer. In this
* system typed and untyped actors can coexist. * system typed and classic actors can coexist.
* *
* Use these adapters with `import akka.actor.typed.scaladsl.adapter._`. * Use these adapters with `import akka.actor.typed.scaladsl.adapter._`.
* *
* Implicit extension methods are added to untyped and typed `ActorSystem`, * Implicit extension methods are added to classic and typed `ActorSystem`,
* `ActorContext`. Such methods make it possible to create typed child actor * `ActorContext`. Such methods make it possible to create typed child actor
* from untyped parent actor, and the opposite untyped child from typed parent. * from classic parent actor, and the opposite untyped child from typed parent.
* `watch` is also supported in both directions. * `watch` is also supported in both directions.
* *
* There is an implicit conversion from untyped [[akka.actor.ActorRef]] to * There is an implicit conversion from classic [[akka.actor.ActorRef]] to
* typed [[akka.actor.typed.ActorRef]]. * typed [[akka.actor.typed.ActorRef]].
* *
* There are also converters (`toTyped`, `toUntyped`) from typed * There are also converters (`toTyped`, `toUntyped`) from typed
* [[akka.actor.typed.ActorRef]] to untyped [[akka.actor.ActorRef]], and between untyped * [[akka.actor.typed.ActorRef]] to classic [[akka.actor.ActorRef]], and between classic
* [[akka.actor.ActorSystem]] and typed [[akka.actor.typed.ActorSystem]]. * [[akka.actor.ActorSystem]] and typed [[akka.actor.typed.ActorSystem]].
*/ */
package object adapter { package object adapter {

2
akka-cluster-sharding-typed/src/main/scala/akka/cluster/sharding/typed/internal/ClusterShardingImpl.scala
View file

@ -129,7 +129,7 @@ import akka.util.Timeout
require( require(
system.isInstanceOf[ActorSystemAdapter[_]], system.isInstanceOf[ActorSystemAdapter[_]],
"only adapted untyped actor systems can be used for cluster features") "only adapted classic actor systems can be used for cluster features")
private val cluster = Cluster(system) private val cluster = Cluster(system)
private val untypedSystem: ExtendedActorSystem = system.toUntyped.asInstanceOf[ExtendedActorSystem] private val untypedSystem: ExtendedActorSystem = system.toUntyped.asInstanceOf[ExtendedActorSystem]

4
akka-cluster-sharding-typed/src/test/scala/akka/cluster/sharding/typed/scaladsl/ClusterShardingSpec.scala
View file

@ -395,8 +395,8 @@ class ClusterShardingSpec extends ScalaTestWithActorTestKit(ClusterShardingSpec.
exc.getMessage should include("[10 ms]") // timeout exc.getMessage should include("[10 ms]") // timeout
} }
"handle untyped StartEntity message" in { "handle classic StartEntity message" in {
// it is normally using envelopes, but the untyped StartEntity message can be sent internally, // it is normally using envelopes, but the classic StartEntity message can be sent internally,
// e.g. for remember entities // e.g. for remember entities
val totalCountBefore = totalEntityCount1() val totalCountBefore = totalEntityCount1()

2
akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/DistributedData.scala
View file

@ -65,7 +65,7 @@ object DistributedData extends ExtensionId[DistributedData] {
* *
* This is using the same underlying `Replicator` instance as * This is using the same underlying `Replicator` instance as
* [[akka.cluster.ddata.DistributedData]] and that means that typed * [[akka.cluster.ddata.DistributedData]] and that means that typed
* and untyped actors can share the same data. * and classic actors can share the same data.
* *
* This class is not intended for user extension other than for test purposes (e.g. * This class is not intended for user extension other than for test purposes (e.g.
* stub implementation). More methods may be added in the future and that may break * stub implementation). More methods may be added in the future and that may break

2
akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/scaladsl/DistributedData.scala
View file

@ -61,7 +61,7 @@ object DistributedData extends ExtensionId[DistributedData] {
* *
* This is using the same underlying `Replicator` instance as * This is using the same underlying `Replicator` instance as
* [[akka.cluster.ddata.DistributedData]] and that means that typed * [[akka.cluster.ddata.DistributedData]] and that means that typed
* and untyped actors can share the same data. * and classic actors can share the same data.
*/ */
class DistributedData(system: ActorSystem[_]) extends Extension { class DistributedData(system: ActorSystem[_]) extends Extension {
import akka.actor.typed.scaladsl.adapter._ import akka.actor.typed.scaladsl.adapter._

2
akka-cluster-typed/src/main/scala/akka/cluster/typed/internal/AkkaClusterTypedSerializer.scala
View file

@ -22,7 +22,7 @@ private[akka] final class AkkaClusterTypedSerializer(override val system: Extend
extends SerializerWithStringManifest extends SerializerWithStringManifest
with BaseSerializer { with BaseSerializer {
// Serializers are initialized early on. `toTyped` might then try to initialize the untyped ActorSystemAdapter extension. // Serializers are initialized early on. `toTyped` might then try to initialize the classic ActorSystemAdapter extension.
private lazy val resolver = ActorRefResolver(system.toTyped) private lazy val resolver = ActorRefResolver(system.toTyped)
private val ReceptionistEntryManifest = "a" private val ReceptionistEntryManifest = "a"

2
akka-distributed-data/src/main/scala/akka/cluster/ddata/DistributedData.scala
View file

@ -62,7 +62,7 @@ class DistributedData(system: ExtendedActorSystem) extends Extension {
} }
/** /**
* Cluster non-specific (typed vs untyped) wrapper for [[akka.cluster.UniqueAddress]]. * Cluster non-specific (typed vs classic) wrapper for [[akka.cluster.UniqueAddress]].
*/ */
@SerialVersionUID(1L) @SerialVersionUID(1L)
final case class SelfUniqueAddress(uniqueAddress: UniqueAddress) final case class SelfUniqueAddress(uniqueAddress: UniqueAddress)

2
akka-stream-typed/src/main/scala/akka/stream/typed/scaladsl/ActorFlow.scala
View file

@ -110,7 +110,7 @@ object ActorFlow {
val res = akka.pattern.extended.ask(untypedRef, (replyTo: akka.actor.ActorRef) => makeMessage(el, replyTo)) val res = akka.pattern.extended.ask(untypedRef, (replyTo: akka.actor.ActorRef) => makeMessage(el, replyTo))
// we need to cast manually (yet safely, by construction!) since otherwise we need a ClassTag, // we need to cast manually (yet safely, by construction!) since otherwise we need a ClassTag,
// which in Scala is fine, but then we would force JavaDSL to create one, which is a hassle in the Akka Typed DSL, // which in Scala is fine, but then we would force JavaDSL to create one, which is a hassle in the Akka Typed DSL,
// since one may say "but I already specified the type!", and that we have to go via the untyped ask is an implementation detail // since one may say "but I already specified the type!", and that we have to go via the classic ask is an implementation detail
res.asInstanceOf[Future[A]] res.asInstanceOf[Future[A]]
} }
.mapError { .mapError {

4
akka-stream/src/main/scala/akka/stream/Shape.scala
View file

@ -13,7 +13,7 @@ import akka.annotation.InternalApi
/** /**
* An input port of a StreamLayout.Module. This type logically belongs * An input port of a StreamLayout.Module. This type logically belongs
* into the impl package but must live here due to how `sealed` works. * into the impl package but must live here due to how `sealed` works.
* It is also used in the Java DSL for “untyped Inlets” as a work-around * It is also used in the Java DSL for “classic Inlets” as a work-around
* for otherwise unreasonable existential types. * for otherwise unreasonable existential types.
*/ */
sealed abstract class InPort { self: Inlet[_] => sealed abstract class InPort { self: Inlet[_] =>
@ -39,7 +39,7 @@ sealed abstract class InPort { self: Inlet[_] =>
/** /**
* An output port of a StreamLayout.Module. This type logically belongs * An output port of a StreamLayout.Module. This type logically belongs
* into the impl package but must live here due to how `sealed` works. * into the impl package but must live here due to how `sealed` works.
* It is also used in the Java DSL for “untyped Outlets” as a work-around * It is also used in the Java DSL for “classic Outlets” as a work-around
* for otherwise unreasonable existential types. * for otherwise unreasonable existential types.
*/ */
sealed abstract class OutPort { self: Outlet[_] => sealed abstract class OutPort { self: Outlet[_] =>