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

akka-docs/java/code/docs/transactor/CoordinatedCounter.java

@@ -0,0 +1,38 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+//#class
+import akka.actor.*;
+import akka.transactor.*;
+import scala.concurrent.stm.Ref;
+import scala.concurrent.stm.japi.STM;
+
+public class CoordinatedCounter extends UntypedActor {
+    private Ref.View<Integer> count = STM.newRef(0);
+
+    public void onReceive(Object incoming) throws Exception {
+        if (incoming instanceof Coordinated) {
+            Coordinated coordinated = (Coordinated) incoming;
+            Object message = coordinated.getMessage();
+            if (message instanceof Increment) {
+                Increment increment = (Increment) message;
+                if (increment.hasFriend()) {
+                    increment.getFriend().tell(coordinated.coordinate(new Increment()));
+                }
+                coordinated.atomic(new Runnable() {
+                    public void run() {
+                        STM.increment(count, 1);
+                    }
+                });
+            }
+        } else if ("GetCount".equals(incoming)) {
+            getSender().tell(count.get());
+        } else {
+          unhandled(incoming);
+        }
+    }
+}
+//#class

akka-docs/java/code/docs/transactor/Coordinator.java

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+import akka.actor.*;
+import akka.transactor.*;
+
+public class Coordinator extends UntypedActor {
+    public void onReceive(Object incoming) throws Exception {
+        if (incoming instanceof Coordinated) {
+            Coordinated coordinated = (Coordinated) incoming;
+            Object message = coordinated.getMessage();
+            if (message instanceof Message) {
+                //#coordinated-atomic
+                coordinated.atomic(new Runnable() {
+                    public void run() {
+                        // do something in the coordinated transaction ...
+                    }
+                });
+                //#coordinated-atomic
+            }
+        } else {
+          unhandled(incoming);
+        }
+    }
+}

akka-docs/java/code/docs/transactor/Counter.java

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+//#class
+import akka.transactor.*;
+import scala.concurrent.stm.Ref;
+import scala.concurrent.stm.japi.STM;
+
+public class Counter extends UntypedTransactor {
+    Ref.View<Integer> count = STM.newRef(0);
+
+    public void atomically(Object message) {
+        if (message instanceof Increment) {
+            STM.increment(count, 1);
+        }
+    }
+
+    @Override public boolean normally(Object message) {
+        if ("GetCount".equals(message)) {
+            getSender().tell(count.get());
+            return true;
+        } else return false;
+    }
+}
+//#class

akka-docs/java/code/docs/transactor/FriendlyCounter.java

@@ -0,0 +1,39 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+//#class
+import akka.actor.*;
+import akka.transactor.*;
+import java.util.Set;
+import scala.concurrent.stm.Ref;
+import scala.concurrent.stm.japi.STM;
+
+public class FriendlyCounter extends UntypedTransactor {
+    Ref.View<Integer> count = STM.newRef(0);
+
+    @Override public Set<SendTo> coordinate(Object message) {
+        if (message instanceof Increment) {
+            Increment increment = (Increment) message;
+            if (increment.hasFriend())
+                return include(increment.getFriend(), new Increment());
+        }
+        return nobody();
+    }
+
+    public void atomically(Object message) {
+        if (message instanceof Increment) {
+            STM.increment(count, 1);
+        }
+    }
+
+    @Override public boolean normally(Object message) {
+        if ("GetCount".equals(message)) {
+            getSender().tell(count.get());
+            return true;
+        } else return false;
+    }
+}
+//#class

akka-docs/java/code/docs/transactor/Increment.java

@@ -0,0 +1,27 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+//#class
+import akka.actor.ActorRef;
+
+public class Increment {
+    private ActorRef friend = null;
+
+    public Increment() {}
+
+    public Increment(ActorRef friend) {
+        this.friend = friend;
+    }
+
+    public boolean hasFriend() {
+        return friend != null;
+    }
+
+    public ActorRef getFriend() {
+        return friend;
+    }
+}
+//#class

akka-docs/java/code/docs/transactor/Message.java

@@ -0,0 +1,7 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+public class Message {}

akka-docs/java/code/docs/transactor/TransactorDocJavaSpec.scala

@@ -0,0 +1,11 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor
+
+import org.scalatest.junit.JUnitWrapperSuite
+
+class TransactorDocJavaSpec extends JUnitWrapperSuite(
+  "docs.transactor.TransactorDocTest",
+  Thread.currentThread.getContextClassLoader)

akka-docs/java/code/docs/transactor/TransactorDocTest.java

@@ -0,0 +1,100 @@
+/**
+ * Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
+ */
+
+package docs.transactor;
+
+import static org.junit.Assert.*;
+import org.junit.Test;
+
+//#imports
+import akka.actor.*;
+import akka.dispatch.Await;
+import static akka.pattern.Patterns.ask;
+import akka.transactor.Coordinated;
+import akka.util.Duration;
+import akka.util.Timeout;
+import static java.util.concurrent.TimeUnit.SECONDS;
+//#imports
+
+public class TransactorDocTest {
+
+    @Test
+    public void coordinatedExample() throws Exception {
+        //#coordinated-example
+        ActorSystem system = ActorSystem.create("CoordinatedExample");
+
+        ActorRef counter1 = system.actorOf(new Props(CoordinatedCounter.class));
+        ActorRef counter2 = system.actorOf(new Props(CoordinatedCounter.class));
+
+        Timeout timeout = new Timeout(5, SECONDS);
+
+        counter1.tell(new Coordinated(new Increment(counter2), timeout));
+
+        Integer count = (Integer) Await.result(ask(counter1, "GetCount", timeout), timeout.duration());
+        //#coordinated-example
+
+        assertEquals(count, new Integer(1));
+
+        system.shutdown();
+    }
+
+    @Test
+    public void coordinatedApi() {
+        //#create-coordinated
+        Timeout timeout = new Timeout(5, SECONDS);
+        Coordinated coordinated = new Coordinated(timeout);
+        //#create-coordinated
+
+        ActorSystem system = ActorSystem.create("CoordinatedApi");
+        ActorRef actor = system.actorOf(new Props(Coordinator.class));
+
+        //#send-coordinated
+        actor.tell(new Coordinated(new Message(), timeout));
+        //#send-coordinated
+
+        //#include-coordinated
+        actor.tell(coordinated.coordinate(new Message()));
+        //#include-coordinated
+
+        coordinated.await();
+
+        system.shutdown();
+    }
+
+    @Test
+    public void counterTransactor() throws Exception {
+        ActorSystem system = ActorSystem.create("CounterTransactor");
+        ActorRef counter = system.actorOf(new Props(Counter.class));
+
+        Timeout timeout = new Timeout(5, SECONDS);
+        Coordinated coordinated = new Coordinated(timeout);
+        counter.tell(coordinated.coordinate(new Increment()));
+        coordinated.await();
+
+        Integer count = (Integer) Await.result(ask(counter, "GetCount", timeout), timeout.duration());
+        assertEquals(count, new Integer(1));
+
+        system.shutdown();
+    }
+
+    @Test
+    public void friendlyCounterTransactor() throws Exception {
+        ActorSystem system = ActorSystem.create("FriendlyCounterTransactor");
+        ActorRef friend = system.actorOf(new Props(Counter.class));
+        ActorRef friendlyCounter = system.actorOf(new Props(FriendlyCounter.class));
+
+        Timeout timeout = new Timeout(5, SECONDS);
+        Coordinated coordinated = new Coordinated(timeout);
+        friendlyCounter.tell(coordinated.coordinate(new Increment(friend)));
+        coordinated.await();
+
+        Integer count1 = (Integer) Await.result(ask(friendlyCounter, "GetCount", timeout), timeout.duration());
+        assertEquals(count1, new Integer(1));
+
+        Integer count2 = (Integer) Await.result(ask(friend, "GetCount", timeout), timeout.duration());
+        assertEquals(count2, new Integer(1));
+
+        system.shutdown();
+    }
+}