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

2012-05-22 11:37:09 +02:00 · 2012-05-22 11:37:09 +02:00 · 0eae9d8d22
commit 0eae9d8d22
parent 09469b73e1
85 changed files with 105 additions and 105 deletions
--- a/akka-docs/java/code/docs/dispatcher/DispatcherDocTestBase.java
+++ b/akka-docs/java/code/docs/dispatcher/DispatcherDocTestBase.java
@ -0,0 +1,139 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+package docs.dispatcher;
+
+//#imports
+import akka.actor.*;
+import akka.actor.ActorRef;
+import akka.actor.Props;
+import akka.actor.UntypedActor;
+import akka.actor.UntypedActorFactory;
+//#imports
+
+//#imports-prio
+import akka.event.Logging;
+import akka.event.LoggingAdapter;
+
+//#imports-prio
+
+//#imports-prio-mailbox
+import akka.dispatch.PriorityGenerator;
+import akka.dispatch.UnboundedPriorityMailbox;
+import com.typesafe.config.Config;
+
+//#imports-prio-mailbox
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import scala.Option;
+import static org.junit.Assert.*;
+
+import com.typesafe.config.ConfigFactory;
+
+import docs.actor.MyUntypedActor;
+import docs.actor.UntypedActorDocTestBase.MyActor;
+import akka.testkit.AkkaSpec;
+
+public class DispatcherDocTestBase {
+
+  ActorSystem system;
+
+  @Before
+  public void setUp() {
+    system = ActorSystem.create("MySystem",
+        ConfigFactory.parseString(DispatcherDocSpec.config()).withFallback(AkkaSpec.testConf()));
+  }
+
+  @After
+  public void tearDown() {
+    system.shutdown();
+  }
+
+  @Test
+  public void defineDispatcher() {
+    //#defining-dispatcher
+    ActorRef myActor =
+      system.actorOf(new Props(MyUntypedActor.class).withDispatcher("my-dispatcher"),
+        "myactor3");
+    //#defining-dispatcher
+  }
+
+  @Test
+  public void definePinnedDispatcher() {
+    //#defining-pinned-dispatcher
+    ActorRef myActor = system.actorOf(new Props(MyUntypedActor.class)
+        .withDispatcher("my-pinned-dispatcher"));
+    //#defining-pinned-dispatcher
+  }
+
+  @Test
+  public void priorityDispatcher() throws Exception {
+    //#prio-dispatcher
+
+      // We create a new Actor that just prints out what it processes
+    ActorRef myActor = system.actorOf(
+        new Props().withCreator(new UntypedActorFactory() {
+          public UntypedActor create() {
+            return new UntypedActor() {
+              LoggingAdapter log =
+                      Logging.getLogger(getContext().system(), this);
+              {
+                getSelf().tell("lowpriority");
+                getSelf().tell("lowpriority");
+                getSelf().tell("highpriority");
+                getSelf().tell("pigdog");
+                getSelf().tell("pigdog2");
+                getSelf().tell("pigdog3");
+                getSelf().tell("highpriority");
+                getSelf().tell(PoisonPill.getInstance());
+              }
+
+              public void onReceive(Object message) {
+                log.info(message.toString());
+              }
+            };
+          }
+        }).withDispatcher("prio-dispatcher"));
+
+    /*
+    Logs:
+      'highpriority
+      'highpriority
+      'pigdog
+      'pigdog2
+      'pigdog3
+      'lowpriority
+      'lowpriority
+    */
+    //#prio-dispatcher
+
+    for (int i = 0; i < 10; i++) {
+      if (myActor.isTerminated())
+        break;
+      Thread.sleep(100);
+    }
+  }
+
+  //#prio-mailbox
+  public static class MyPrioMailbox extends UnboundedPriorityMailbox {
+    public MyPrioMailbox(ActorSystem.Settings settings, Config config) { // needed for reflective instantiation
+      // Create a new PriorityGenerator, lower prio means more important
+      super(new PriorityGenerator() {
+        @Override
+        public int gen(Object message) {
+          if (message.equals("highpriority"))
+            return 0; // 'highpriority messages should be treated first if possible
+          else if (message.equals("lowpriority"))
+            return 2; // 'lowpriority messages should be treated last if possible
+          else if (message.equals(PoisonPill.getInstance()))
+            return 3; // PoisonPill when no other left
+          else
+            return 1; // By default they go between high and low prio
+        }
+      });
+    }
+  }
+  //#prio-mailbox
+}