Documentation updates; name changes.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@136 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/crowd/server/PlaceManager.java

@@ -1,10 +1,9 @@
 //
-// $Id: PlaceManager.java,v 1.3 2001/08/01 03:22:54 mdb Exp $
+// $Id: PlaceManager.java,v 1.4 2001/08/01 17:00:58 mdb Exp $
 
 package com.threerings.cocktail.party.server;
 
 import com.threerings.cocktail.cher.dobj.*;
-
 import com.threerings.cocktail.party.data.PlaceObject;
 
 /**
@@ -20,14 +19,35 @@ import com.threerings.cocktail.party.data.PlaceObject;
  * interactions with the place registry to manage place registration. It
  * handles the place-related component of chatting. It also provides the
  * basis for place-based access control.
+ *
+ * <p> A derived class is expected to achieve its functionality via the
+ * callback functions:
+ *
+ * <pre>
+ * protected void didStartup ()
+ * protected void willShutdown ()
+ * protected void didShutdown ()
+ * </pre>
+ *
+ * as well as through additions to <code>handlEvent</code>.
  */
 public class PlaceManager implements Subscriber
 {
+    /**
+     * Called by the place registry after creating this place manager.
+     * Initialization is followed by startup which happens when the place
+     * object that this manager will manage is available.
+     */
+    public void init (PlaceRegistry registry)
+    {
+        _registry = registry;
+    }
+
     /**
      * Called by the place manager after the place object has been
      * successfully created.
      */
-    public void init (PlaceObject plobj)
+    public void startup (PlaceObject plobj)
     {
         // keep track of this
         _plobj = plobj;
@@ -39,10 +59,16 @@ public class PlaceManager implements Subscriber
         plobj.addSubscriber(this);
 
         // let our derived classes do their thang
-        didInit();
+        didStartup();
     }
 
-    protected void didInit ()
+    /**
+     * Derived classes should override this (and be sure to call
+     * <code>super.didStartup()</code>) to perform any startup time
+     * initialization. The place object will be available by the time this
+     * method is executed.
+     */
+    protected void didStartup ()
     {
     }
 
@@ -54,29 +80,28 @@ public class PlaceManager implements Subscriber
         return _plobj;
     }
 
+    // nothing doing
     public void objectAvailable (DObject object)
     {
     }
 
+    // nothing doing
     public void requestFailed (int oid, ObjectAccessException cause)
     {
     }
 
+    /**
+     * Derived classes can override this to handle events, but they must
+     * be sure to pass unknown events up to their super class.
+     */
     public boolean handleEvent (DEvent event, DObject target)
     {
         return true;
     }
 
-    /**
-     * Called by the place registry after creating this place manager.
-     * This is necessary so that the manager can inform the place registry
-     * when the place goes away.
-     */
-    public void setRegistry (PlaceRegistry registry)
-    {
-        _registry = registry;
-    }
-
+    /** A reference to the place object that we manage. */
     protected PlaceObject _plobj;
+
+    /** A reference to the place registry with which we're registered. */
     protected PlaceRegistry _registry;
 }

src/java/com/threerings/crowd/server/PlaceRegistry.java

@@ -1,5 +1,5 @@
 //
-// $Id: PlaceRegistry.java,v 1.1 2001/08/01 03:22:54 mdb Exp $
+// $Id: PlaceRegistry.java,v 1.2 2001/08/01 17:00:59 mdb Exp $
 
 package com.threerings.cocktail.party.server;
 
@@ -44,6 +44,8 @@ public class PlaceRegistry implements Subscriber
         // create a place manager for this place
         try {
             PlaceManager pmgr = (PlaceManager)pmgrClass.newInstance();
+            // let the pmgr know about us
+            pmgr.init(this);
             // stick the manager on the creation queue because we know
             // we'll get our calls to objectAvailable()/requestFailed() in
             // the order that we call createObject()
@@ -109,9 +111,8 @@ public class PlaceRegistry implements Subscriber
             return;
         }
 
-        // initialize the place manager with the newly created place
-        // object
-        pmgr.init((PlaceObject)object);
+        // start the place manager up with the newly created place object
+        pmgr.startup((PlaceObject)object);
 
         // stick the manager into our table
         _pmgrs.put(object.getOid(), pmgr);