Move all doc examples out of the akka-package to avoid use of private APIs. See #2092

akka-docs/modules/code/docs/actor/mailbox/DurableMailboxDocSpec.scala

@@ -0,0 +1,132 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+package docs.actor.mailbox
+
+//#imports
+import akka.actor.Props
+
+//#imports
+
+import org.scalatest.{ BeforeAndAfterAll, WordSpec }
+import org.scalatest.matchers.MustMatchers
+import akka.testkit.AkkaSpec
+import akka.actor.Actor
+
+class MyActor extends Actor {
+  def receive = {
+    case x ⇒
+  }
+}
+
+object DurableMailboxDocSpec {
+  val config = """
+    //#dispatcher-config
+    my-dispatcher {
+      mailbox-type = akka.actor.mailbox.FileBasedMailboxType
+    }
+    //#dispatcher-config
+    """
+}
+
+class DurableMailboxDocSpec extends AkkaSpec(DurableMailboxDocSpec.config) {
+
+  "configuration of dispatcher with durable mailbox" in {
+    //#dispatcher-config-use
+    val myActor = system.actorOf(Props[MyActor].
+      withDispatcher("my-dispatcher"), name = "myactor")
+    //#dispatcher-config-use
+  }
+
+}
+
+//#custom-mailbox
+import com.typesafe.config.Config
+import akka.actor.ActorContext
+import akka.actor.ActorRef
+import akka.actor.ActorSystem
+import akka.dispatch.Envelope
+import akka.dispatch.MailboxType
+import akka.dispatch.MessageQueue
+import akka.actor.mailbox.DurableMessageQueue
+import akka.actor.mailbox.DurableMessageSerialization
+
+class MyMailboxType(systemSettings: ActorSystem.Settings, config: Config)
+  extends MailboxType {
+
+  override def create(owner: Option[ActorContext]): MessageQueue = owner match {
+    case Some(o) ⇒ new MyMessageQueue(o)
+    case None ⇒ throw new IllegalArgumentException(
+      "requires an owner (i.e. does not work with BalancingDispatcher)")
+  }
+}
+
+class MyMessageQueue(_owner: ActorContext)
+  extends DurableMessageQueue(_owner) with DurableMessageSerialization {
+
+  val storage = new QueueStorage
+
+  def enqueue(receiver: ActorRef, envelope: Envelope) {
+    val data: Array[Byte] = serialize(envelope)
+    storage.push(data)
+  }
+
+  def dequeue(): Envelope = {
+    val data: Option[Array[Byte]] = storage.pull()
+    data.map(deserialize).orNull
+  }
+
+  def hasMessages: Boolean = !storage.isEmpty
+
+  def numberOfMessages: Int = storage.size
+
+  /**
+   * Called when the mailbox is disposed.
+   * An ordinary mailbox would send remaining messages to deadLetters,
+   * but the purpose of a durable mailbox is to continue
+   * with the same message queue when the actor is started again.
+   */
+  def cleanUp(owner: ActorContext, deadLetters: MessageQueue): Unit = ()
+
+}
+//#custom-mailbox
+
+// dummy
+class QueueStorage {
+  import java.util.concurrent.ConcurrentLinkedQueue
+  val queue = new ConcurrentLinkedQueue[Array[Byte]]
+  def push(data: Array[Byte]): Unit = queue.offer(data)
+  def pull(): Option[Array[Byte]] = Option(queue.poll())
+  def isEmpty: Boolean = queue.isEmpty
+  def size: Int = queue.size
+}
+
+//#custom-mailbox-test
+import akka.actor.mailbox.DurableMailboxSpec
+
+object MyMailboxSpec {
+  val config = """
+    MyStorage-dispatcher {
+      mailbox-type = docs.actor.mailbox.MyMailboxType
+    }
+    """
+}
+
+class MyMailboxSpec extends DurableMailboxSpec("MyStorage", MyMailboxSpec.config) {
+  override def atStartup() {
+  }
+
+  override def atTermination() {
+  }
+
+  "MyMailbox" must {
+    "deliver a message" in {
+      val actor = createMailboxTestActor()
+      implicit val sender = testActor
+      actor ! "hello"
+      expectMsg("hello")
+    }
+
+    // add more tests
+  }
+}

akka-docs/modules/code/docs/actor/mailbox/DurableMailboxDocTest.scala

@@ -0,0 +1,8 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+package docs.actor.mailbox
+
+import org.scalatest.junit.JUnitSuite
+
+class DurableMailboxDocTest extends DurableMailboxDocTestBase with JUnitSuite

akka-docs/modules/code/docs/actor/mailbox/DurableMailboxDocTestBase.java

@@ -0,0 +1,52 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+package docs.actor.mailbox;
+
+//#imports
+import akka.actor.Props;
+import akka.actor.ActorRef;
+
+//#imports
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import akka.testkit.AkkaSpec;
+import com.typesafe.config.ConfigFactory;
+import akka.actor.ActorSystem;
+import akka.actor.UntypedActor;
+
+import static org.junit.Assert.*;
+
+public class DurableMailboxDocTestBase {
+
+  ActorSystem system;
+
+  @Before
+  public void setUp() {
+    system = ActorSystem.create("MySystem",
+        ConfigFactory.parseString(DurableMailboxDocSpec.config()).withFallback(AkkaSpec.testConf()));
+  }
+
+  @After
+  public void tearDown() {
+    system.shutdown();
+  }
+
+  @Test
+  public void configDefinedDispatcher() {
+    //#dispatcher-config-use
+    ActorRef myActor = system.actorOf(new Props(MyUntypedActor.class).
+        withDispatcher("my-dispatcher"), "myactor");
+    //#dispatcher-config-use
+    myActor.tell("test");
+  }
+
+  public static class MyUntypedActor extends UntypedActor {
+    public void onReceive(Object message) {
+    }
+  }
+
+}