Fix broken javadoc links and params to kill my Eclipse warnings. This includes

importing receivers from their senders to satisfy their links.



git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5333 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Charlie Groves
2008-08-21 01:46:51 +00:00
parent 8a22502f47
commit 80ca1dbc64
23 changed files with 40 additions and 32 deletions
@@ -33,6 +33,7 @@ import com.samskivert.util.StringUtil;
import com.threerings.io.ObjectInputStream; import com.threerings.io.ObjectInputStream;
import com.threerings.io.ObjectOutputStream; import com.threerings.io.ObjectOutputStream;
import com.threerings.io.Streamable; import com.threerings.io.Streamable;
import com.threerings.presents.dobj.AccessController;
import com.threerings.presents.dobj.AttributeChangeListener; import com.threerings.presents.dobj.AttributeChangeListener;
import com.threerings.presents.dobj.AttributeChangedEvent; import com.threerings.presents.dobj.AttributeChangedEvent;
import com.threerings.presents.dobj.DObject; import com.threerings.presents.dobj.DObject;
@@ -152,13 +153,13 @@ public abstract class ConfigRegistry
Class<?> cclass = object.getClass(); Class<?> cclass = object.getClass();
try { try {
Field[] fields = cclass.getFields(); Field[] fields = cclass.getFields();
for (int ii = 0; ii < fields.length; ii++) { for (Field field : fields) {
int mods = fields[ii].getModifiers(); int mods = field.getModifiers();
if ((mods & Modifier.STATIC) != 0 || (mods & Modifier.PUBLIC) == 0 || if ((mods & Modifier.STATIC) != 0 || (mods & Modifier.PUBLIC) == 0 ||
(mods & Modifier.TRANSIENT) != 0) { (mods & Modifier.TRANSIENT) != 0) {
continue; continue;
} }
initField(fields[ii]); initField(field);
} }
// listen for attribute updates // listen for attribute updates
@@ -23,6 +23,7 @@ package com.threerings.admin.server;
import com.google.inject.Singleton; import com.google.inject.Singleton;
import com.samskivert.util.Config;
import com.samskivert.util.PrefsConfig; import com.samskivert.util.PrefsConfig;
import com.threerings.presents.dobj.DObject; import com.threerings.presents.dobj.DObject;
@@ -35,7 +35,6 @@ public abstract class BureauClient extends Client
{ {
/** /**
* Creates a new client. * Creates a new client.
* @param creds the credentials supplied during connection
* @param runQueue the place to post tasks required by clients * @param runQueue the place to post tasks required by clients
*/ */
public BureauClient (String token, String bureauId, RunQueue runQueue) public BureauClient (String token, String bureauId, RunQueue runQueue)
@@ -5,6 +5,7 @@ import com.threerings.bureau.data.BureauCodes;
import com.samskivert.util.IntMap; import com.samskivert.util.IntMap;
import com.samskivert.util.IntMaps; import com.samskivert.util.IntMaps;
import com.threerings.bureau.data.AgentObject; import com.threerings.bureau.data.AgentObject;
import com.threerings.bureau.server.BureauRegistry;
import com.threerings.bureau.util.BureauContext; import com.threerings.bureau.util.BureauContext;
import com.threerings.presents.client.Client; import com.threerings.presents.client.Client;
import com.threerings.presents.dobj.Subscriber; import com.threerings.presents.dobj.Subscriber;
@@ -21,6 +21,7 @@
package com.threerings.bureau.client; package com.threerings.bureau.client;
import com.threerings.bureau.data.AgentObject;
import com.threerings.presents.client.InvocationReceiver; import com.threerings.presents.client.InvocationReceiver;
/** /**
@@ -32,7 +33,6 @@ public interface BureauReceiver extends InvocationReceiver
* Creates a new agent. Implementors should create a new {@link Agent} and give it access to * Creates a new agent. Implementors should create a new {@link Agent} and give it access to
* the {@link AgentObject} referred to by the <code>agentId</code> parameter and must notify * the {@link AgentObject} referred to by the <code>agentId</code> parameter and must notify
* the service that the agent has been created using {@link BureauService#agentCreated}. * the service that the agent has been created using {@link BureauService#agentCreated}.
* @param client the client receiving the request
* @param agentId the id of the <code>AgentObject</code> that needs an <code>Agent</code> * @param agentId the id of the <code>AgentObject</code> that needs an <code>Agent</code>
*/ */
void createAgent (int agentId); void createAgent (int agentId);
@@ -41,7 +41,6 @@ public interface BureauReceiver extends InvocationReceiver
* Destroys a previously created agent. Implementors should destroy the agent that was created * Destroys a previously created agent. Implementors should destroy the agent that was created
* by the call to <code>createAgent</code> with the same agent id and must notify * by the call to <code>createAgent</code> with the same agent id and must notify
* the service that the agent has been created using {@link BureauService#agentDestroyed}. * the service that the agent has been created using {@link BureauService#agentDestroyed}.
* @param client the client receiving the request
* @param agentId the id of the <code>AgentObject</code> whose <code>Agent</code> * @param agentId the id of the <code>AgentObject</code> whose <code>Agent</code>
* should be destroyed * should be destroyed
*/ */
@@ -22,6 +22,7 @@
package com.threerings.bureau.server; package com.threerings.bureau.server;
import com.threerings.bureau.client.BureauDecoder; import com.threerings.bureau.client.BureauDecoder;
import com.threerings.bureau.client.BureauReceiver;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
import com.threerings.presents.server.InvocationSender; import com.threerings.presents.server.InvocationSender;
@@ -27,6 +27,7 @@ import com.threerings.presents.data.ClientObject;
import com.threerings.presents.dobj.DObject; import com.threerings.presents.dobj.DObject;
import com.threerings.presents.server.InvocationManager; import com.threerings.presents.server.InvocationManager;
import com.threerings.crowd.chat.client.SpeakService;
import com.threerings.crowd.chat.data.ChatCodes; import com.threerings.crowd.chat.data.ChatCodes;
import com.threerings.crowd.data.BodyObject; import com.threerings.crowd.data.BodyObject;
@@ -74,7 +74,7 @@ public class LocationManager
* *
* @return the config object for the new location. * @return the config object for the new location.
* *
* @exception ServiceFaildException thrown if the move was not successful for some reason * @exception InvocationException thrown if the move was not successful for some reason
* (which will be communicated as an error code in the exception's message data). * (which will be communicated as an error code in the exception's message data).
*/ */
public PlaceConfig moveTo (BodyObject source, int placeOid) public PlaceConfig moveTo (BodyObject source, int placeOid)
@@ -22,6 +22,7 @@
package com.threerings.crowd.server; package com.threerings.crowd.server;
import com.threerings.crowd.client.LocationDecoder; import com.threerings.crowd.client.LocationDecoder;
import com.threerings.crowd.client.LocationReceiver;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
import com.threerings.presents.server.InvocationSender; import com.threerings.presents.server.InvocationSender;
@@ -451,7 +451,7 @@ public class Client
* user of the failure and then simply call {@link #logon} to attempt to reconnect to the old * user of the failure and then simply call {@link #logon} to attempt to reconnect to the old
* server. * server.
* *
* @param observer an observer that will be notified when we have successfully logged onto the * @param obs an observer that will be notified when we have successfully logged onto the
* other server, or if the move failed. * other server, or if the move failed.
*/ */
public void moveToServer (String hostname, int[] ports, InvocationService.ConfirmListener obs) public void moveToServer (String hostname, int[] ports, InvocationService.ConfirmListener obs)
@@ -470,7 +470,7 @@ public class Client
* user of the failure and then simply call {@link #logon} to attempt to reconnect to the old * user of the failure and then simply call {@link #logon} to attempt to reconnect to the old
* server. * server.
* *
* @param observer an observer that will be notified when we have successfully logged onto the * @param obs an observer that will be notified when we have successfully logged onto the
* other server, or if the move failed. * other server, or if the move failed.
*/ */
public void moveToServer ( public void moveToServer (
@@ -74,7 +74,7 @@ public class ClientObject extends DObject
} }
/** /**
* A version of {@link #checkAccess(Permission,Object} that provides no context. * A version of {@link #checkAccess(Permission,Object)} that provides no context.
*/ */
public String checkAccess (Permission perm) public String checkAccess (Permission perm)
{ {
@@ -136,7 +136,7 @@ public class InvocationMarshaller
} }
/** /**
* Defines a marshaller for the standard {@link ConfirmListener}. * Defines a marshaller for the standard {@link InvocationService.ConfirmListener}.
*/ */
public static class ConfirmMarshaller extends ListenerMarshaller public static class ConfirmMarshaller extends ListenerMarshaller
implements ConfirmListener implements ConfirmListener
@@ -167,7 +167,7 @@ public class InvocationMarshaller
} }
/** /**
* Defines a marshaller for the standard {@link ResultListener}. * Defines a marshaller for the standard {@link InvocationService.ResultListener}.
*/ */
public static class ResultMarshaller extends ListenerMarshaller public static class ResultMarshaller extends ListenerMarshaller
implements ResultListener implements ResultListener
@@ -453,8 +453,7 @@ public class DObject
return; return;
} }
for (int ii = 0, ll = _subs.length; ii < ll; ii++) { for (Object sub : _subs) {
Object sub = _subs[ii];
try { try {
if (sub != null && sub instanceof ProxySubscriber) { if (sub != null && sub instanceof ProxySubscriber) {
((ProxySubscriber)sub).eventReceived(event); ((ProxySubscriber)sub).eventReceived(event);
@@ -569,7 +568,7 @@ public class DObject
* distributed object manager. This is called by the distributed object manager when an object * distributed object manager. This is called by the distributed object manager when an object
* is created and registered with the system. * is created and registered with the system.
* *
* @see DObjectManager#createObject * @see RootDObjectManager#registerObject(DObject)
*/ */
public void setManager (DObjectManager omgr) public void setManager (DObjectManager omgr)
{ {
@@ -580,7 +579,7 @@ public class DObject
* Don't call this function. It is called by the distributed object manager when an object is * Don't call this function. It is called by the distributed object manager when an object is
* created and registered with the system. * created and registered with the system.
* *
* @see DObjectManager#createObject * @see RootDObjectManager#registerObject(DObject)
*/ */
public void setOid (int oid) public void setOid (int oid)
{ {
@@ -45,7 +45,7 @@ public class ElementUpdatedEvent extends NamedEvent
* @param name the name of the attribute (data member) for which an element has changed. * @param name the name of the attribute (data member) for which an element has changed.
* @param value the new value of the element (in the case of primitive types, the * @param value the new value of the element (in the case of primitive types, the
* reflection-defined object-alternative is used). * reflection-defined object-alternative is used).
* @param oldValue the previous value of the element (in the case of primitive types, the * @param ovalue the previous value of the element (in the case of primitive types, the
* reflection-defined object-alternative is used). * reflection-defined object-alternative is used).
* @param index the index in the array of the updated element. * @param index the index in the array of the updated element.
*/ */
@@ -62,7 +62,7 @@ public class ElementUpdatedEvent extends NamedEvent
* @param name the name of the attribute (data member) for which an element has changed. * @param name the name of the attribute (data member) for which an element has changed.
* @param value the new value of the element (in the case of primitive types, the * @param value the new value of the element (in the case of primitive types, the
* reflection-defined object-alternative is used). * reflection-defined object-alternative is used).
* @param oldValue the previous value of the element (in the case of primitive types, the * @param ovalue the previous value of the element (in the case of primitive types, the
* reflection-defined object-alternative is used). * reflection-defined object-alternative is used).
* @param index the index in the array of the updated element. * @param index the index in the array of the updated element.
* @param transport a hint as to the type of transport desired for the event. * @param transport a hint as to the type of transport desired for the event.
@@ -25,6 +25,7 @@ import com.samskivert.util.Invoker;
import com.samskivert.util.ResultListener; import com.samskivert.util.ResultListener;
import com.threerings.presents.server.net.AuthingConnection; import com.threerings.presents.server.net.AuthingConnection;
import com.threerings.presents.server.net.ConnectionManager;
/** /**
* Handles certain special kinds of authentications and passes the remainder through to the default * Handles certain special kinds of authentications and passes the remainder through to the default
@@ -547,7 +547,7 @@ public class ClientManager
protected ClientOp _clop; protected ClientOp _clop;
} }
/** Used to resolve dependencies in {@link PresentClient} instances that we create. */ /** Used to resolve dependencies in {@link PresentsClient} instances that we create. */
protected Injector _injector; protected Injector _injector;
/** A mapping from auth username to client instances. */ /** A mapping from auth username to client instances. */
@@ -73,7 +73,7 @@ public class PresentsDObjectMgr
implements RootDObjectManager, RunQueue, ReportManager.Reporter implements RootDObjectManager, RunQueue, ReportManager.Reporter
{ {
/** Contains operational statistics that are tracked by the distributed object manager between /** Contains operational statistics that are tracked by the distributed object manager between
* {@link ReportManager#Reporter} intervals. The snapshot for the most recently completed * {@link ReportManager.Reporter} intervals. The snapshot for the most recently completed
* period can be requested via {@link #getStats()}. . */ * period can be requested via {@link #getStats()}. . */
public static class Stats public static class Stats
{ {
@@ -380,13 +380,12 @@ public class PresentsDObjectMgr
// deal with any remaining oid lists that reference this object // deal with any remaining oid lists that reference this object
Reference[] refs = _refs.remove(oid); Reference[] refs = _refs.remove(oid);
if (refs != null) { if (refs != null) {
for (int i = 0; i < refs.length; i++) { for (Reference ref : refs) {
// skip empty spots // skip empty spots
if (refs[i] == null) { if (ref == null) {
continue; continue;
} }
Reference ref = refs[i];
DObject reffer = _objects.get(ref.reffingOid); DObject reffer = _objects.get(ref.reffingOid);
// ensure that the referencing object is still around // ensure that the referencing object is still around
@@ -405,9 +404,7 @@ public class PresentsDObjectMgr
// to clear out those references // to clear out those references
Class<?> oclass = target.getClass(); Class<?> oclass = target.getClass();
Field[] fields = oclass.getFields(); Field[] fields = oclass.getFields();
for (int f = 0; f < fields.length; f++) { for (Field field : fields) {
Field field = fields[f];
// ignore static and non-public fields // ignore static and non-public fields
int mods = field.getModifiers(); int mods = field.getModifiers();
if ((mods & Modifier.STATIC) != 0 || (mods & Modifier.PUBLIC) == 0) { if ((mods & Modifier.STATIC) != 0 || (mods & Modifier.PUBLIC) == 0) {
@@ -36,6 +36,7 @@ import com.threerings.presents.annotation.EventQueue;
import com.threerings.presents.annotation.MainInvoker; import com.threerings.presents.annotation.MainInvoker;
import com.threerings.presents.client.Client; import com.threerings.presents.client.Client;
import com.threerings.presents.dobj.AccessController; import com.threerings.presents.dobj.AccessController;
import com.threerings.presents.dobj.DObject;
import com.threerings.presents.dobj.DObjectManager; import com.threerings.presents.dobj.DObjectManager;
import com.threerings.presents.dobj.RootDObjectManager; import com.threerings.presents.dobj.RootDObjectManager;
import com.threerings.presents.server.net.ConnectionManager; import com.threerings.presents.server.net.ConnectionManager;
@@ -69,8 +69,7 @@ public class GenReceiverTask extends InvocationTask
// look through and locate our receiver methods // look through and locate our receiver methods
Method[] methdecls = receiver.getDeclaredMethods(); Method[] methdecls = receiver.getDeclaredMethods();
for (int ii = 0; ii < methdecls.length; ii++) { for (Method m : methdecls) {
Method m = methdecls[ii];
// receiver interface methods must be public and abstract // receiver interface methods must be public and abstract
if (!Modifier.isPublic(m.getModifiers()) && if (!Modifier.isPublic(m.getModifiers()) &&
!Modifier.isAbstract(m.getModifiers())) { !Modifier.isAbstract(m.getModifiers())) {
@@ -104,6 +103,7 @@ public class GenReceiverTask extends InvocationTask
checkedAdd(implist, InvocationSender.class.getName()); checkedAdd(implist, InvocationSender.class.getName());
String dname = StringUtil.replace(rname, "Receiver", "Decoder"); String dname = StringUtil.replace(rname, "Receiver", "Decoder");
checkedAdd(implist, rpackage + "." + dname); checkedAdd(implist, rpackage + "." + dname);
checkedAdd(implist, rpackage + "." + rname);
implist.sort(); implist.sort();
VelocityContext ctx = new VelocityContext(); VelocityContext ctx = new VelocityContext();
@@ -21,11 +21,16 @@
package com.threerings.presents.util; package com.threerings.presents.util;
import com.samskivert.util.ResultListener;
import com.threerings.presents.client.InvocationService; import com.threerings.presents.client.InvocationService;
import com.threerings.presents.client.InvocationService.ConfirmListener;
import com.threerings.presents.data.InvocationCodes;
import com.threerings.presents.server.InvocationException;
/** /**
* Adapts the response from a {@link ResultListener} to a {@link ConfirmListener} if the failure is * Adapts the response from a {@link ResultListener} to a {@link ConfirmListener} if the failure is
* an instance fo {@link InvocationException} the message will be passed on to the confirm * an instance of {@link InvocationException} the message will be passed on to the confirm
* listener, otherwise they will be provided with {@link InvocationCodes#INTERNAL_ERROR}. * listener, otherwise they will be provided with {@link InvocationCodes#INTERNAL_ERROR}.
*/ */
public class ConfirmAdapter extends IgnoreConfirmAdapter<Void> public class ConfirmAdapter extends IgnoreConfirmAdapter<Void>
@@ -24,6 +24,7 @@ package com.threerings.presents.util;
import com.samskivert.util.ResultListener; import com.samskivert.util.ResultListener;
import com.threerings.presents.client.InvocationService; import com.threerings.presents.client.InvocationService;
import com.threerings.presents.client.InvocationService.ConfirmListener;
import com.threerings.presents.data.InvocationCodes; import com.threerings.presents.data.InvocationCodes;
import com.threerings.presents.server.InvocationException; import com.threerings.presents.server.InvocationException;
@@ -130,7 +130,7 @@ public class JabberClient
} }
/** /**
* Creates the {@link JabberContext} implementation that will be * Creates the {@link CrowdContext} implementation that will be
* passed around to all of the client code. Derived classes may wish * passed around to all of the client code. Derived classes may wish
* to override this and create some extended context implementation. * to override this and create some extended context implementation.
*/ */
@@ -37,7 +37,7 @@ public class TestMarshaller extends InvocationMarshaller
implements TestService implements TestService
{ {
/** /**
* Marshalls results to implementations of {@link TestFuncListener}. * Marshalls results to implementations of {@link TestService.TestFuncListener}.
*/ */
public static class TestFuncMarshaller extends ListenerMarshaller public static class TestFuncMarshaller extends ListenerMarshaller
implements TestFuncListener implements TestFuncListener
@@ -72,7 +72,7 @@ public class TestMarshaller extends InvocationMarshaller
} }
/** /**
* Marshalls results to implementations of {@link TestOidListener}. * Marshalls results to implementations of {@link TestService.TestOidListener}.
*/ */
public static class TestOidMarshaller extends ListenerMarshaller public static class TestOidMarshaller extends ListenerMarshaller
implements TestOidListener implements TestOidListener