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

Mark all the around hooks as internal in the api docs (#23587)

Browse source
This commit is contained in:
Johan Andrén 2017-09-01 14:48:10 +02:00 • committed by GitHub
parent 1fcb3d3ab2
commit 262779f0bb
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
akka-actor/src/main/scala/akka/actor/Actor.scala
View file

@ -12,6 +12,8 @@ import scala.beans.BeanProperty
import scala.util.control.NoStackTrace import scala.util.control.NoStackTrace
import java.util.Optional import java.util.Optional
import akka.annotation.InternalApi
/** /**
* INTERNAL API * INTERNAL API
* *
@ -509,6 +511,7 @@ trait Actor {
* @param receive current behavior. * @param receive current behavior.
* @param msg current message. * @param msg current message.
*/ */
@InternalApi
protected[akka] def aroundReceive(receive: Actor.Receive, msg: Any): Unit = { protected[akka] def aroundReceive(receive: Actor.Receive, msg: Any): Unit = {
// optimization: avoid allocation of lambda // optimization: avoid allocation of lambda
if (receive.applyOrElse(msg, Actor.notHandledFun).asInstanceOf[AnyRef] eq Actor.NotHandled) { if (receive.applyOrElse(msg, Actor.notHandledFun).asInstanceOf[AnyRef] eq Actor.NotHandled) {
@ -517,23 +520,35 @@ trait Actor {
} }
/** /**
* INTERNAL API.
*
* Can be overridden to intercept calls to `preStart`. Calls `preStart` by default. * Can be overridden to intercept calls to `preStart`. Calls `preStart` by default.
*/ */
@InternalApi
protected[akka] def aroundPreStart(): Unit = preStart() protected[akka] def aroundPreStart(): Unit = preStart()
/** /**
* INTERNAL API.
*
* Can be overridden to intercept calls to `postStop`. Calls `postStop` by default. * Can be overridden to intercept calls to `postStop`. Calls `postStop` by default.
*/ */
@InternalApi
protected[akka] def aroundPostStop(): Unit = postStop() protected[akka] def aroundPostStop(): Unit = postStop()
/** /**
* INTERNAL API.
*
* Can be overridden to intercept calls to `preRestart`. Calls `preRestart` by default. * Can be overridden to intercept calls to `preRestart`. Calls `preRestart` by default.
*/ */
@InternalApi
protected[akka] def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit = preRestart(reason, message) protected[akka] def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit = preRestart(reason, message)
/** /**
* INTERNAL API.
*
* Can be overridden to intercept calls to `postRestart`. Calls `postRestart` by default. * Can be overridden to intercept calls to `postRestart`. Calls `postRestart` by default.
*/ */
@InternalApi
protected[akka] def aroundPostRestart(reason: Throwable): Unit = postRestart(reason) protected[akka] def aroundPostRestart(reason: Throwable): Unit = postRestart(reason)
/** /**