Javadoc warnings cleanups.
Note: this involves generated code from a samskivert patch I only just sent to mdb, but he's in a meeting, so that won't show up for a little. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@741 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
@@ -21,6 +21,8 @@
|
||||
|
||||
package com.threerings.parlor.card.data;
|
||||
|
||||
import java.util.ArrayList;
|
||||
|
||||
import com.threerings.util.ActionScript;
|
||||
import com.threerings.util.StreamableArrayList;
|
||||
|
||||
@@ -35,22 +37,22 @@ public class Hand extends StreamableArrayList<Card>
|
||||
@ActionScript(name="addAllCards")
|
||||
public void addAll (Card[] cards)
|
||||
{
|
||||
for (int i = 0; i < cards.length; i++) {
|
||||
add(cards[i]);
|
||||
for (Card card : cards) {
|
||||
add(card);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Removes all of the specified cards from this hand.
|
||||
*/
|
||||
@ActionScript(name="removeAllCards")
|
||||
public void removeAll (Card[] cards)
|
||||
{
|
||||
for (int i = 0; i < cards.length; i++) {
|
||||
remove(cards[i]);
|
||||
for (Card card : cards) {
|
||||
remove(card);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Checks whether this hand contains all of the specified cards.
|
||||
*/
|
||||
@@ -64,7 +66,7 @@ public class Hand extends StreamableArrayList<Card>
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Counts the members of a particular suit within this hand.
|
||||
*
|
||||
@@ -84,7 +86,7 @@ public class Hand extends StreamableArrayList<Card>
|
||||
|
||||
/**
|
||||
* Converts this list of cards into an array. This only necessary if you
|
||||
* need the cards in array form, use {@link #get} if you simply need to get
|
||||
* need the cards in array form, use {@link ArrayList#get} if you simply need to get
|
||||
* a card from the hand.
|
||||
*/
|
||||
public Card[] getCards ()
|
||||
|
||||
@@ -37,12 +37,12 @@ import com.threerings.parlor.game.data.GameConfig;
|
||||
public interface ParlorService extends InvocationService
|
||||
{
|
||||
/**
|
||||
* Used to communicate responses to {@link #invite} requests.
|
||||
* Used to communicate responses to {@link ParlorService#invite} requests.
|
||||
*/
|
||||
public static interface InviteListener extends InvocationListener
|
||||
{
|
||||
/**
|
||||
* Called in response to a successful {@link #invite} request.
|
||||
* Called in response to a successful {@link ParlorService#invite} request.
|
||||
*/
|
||||
public void inviteReceived (int inviteId);
|
||||
}
|
||||
|
||||
@@ -38,7 +38,7 @@ import com.threerings.parlor.game.data.GameConfig;
|
||||
*
|
||||
* <p> Clients that use the game configurator will want to instantiate one
|
||||
* based on the class returned from the {@link GameConfig} and then
|
||||
* initialize it with a call to {@link #init}.
|
||||
* initialize it with a call to {@link GameConfigurator#init}.
|
||||
*/
|
||||
public abstract class SwingGameConfigurator extends GameConfigurator
|
||||
{
|
||||
|
||||
@@ -38,12 +38,14 @@ import com.threerings.parlor.game.client.GameConfigurator;
|
||||
*
|
||||
* <p> The game config object is also the mechanism used to instantiate the appropriate game
|
||||
* manager and controller. Every game must have an associated game config derived class that
|
||||
* overrides {@link #createController} and {@link #getManagerClassName}, returning the appropriate
|
||||
* game controller and manager class for that game. Thus the entire chain of events that causes a
|
||||
* particular game to be created is the construction of the appropriate game config instance which
|
||||
* is provided to the server as part of an invitation or via some other matchmaking mechanism.
|
||||
* overrides {@link PlaceConfig#createController} and {@link PlaceConfig#getManagerClassName},
|
||||
* returning the appropriate game controller and manager class for that game. Thus the entire chain
|
||||
* of events that causes a particular game to be created is the construction of the appropriate
|
||||
* game config instance which is provided to the server as part of an invitation or via some other
|
||||
* matchmaking mechanism.
|
||||
*/
|
||||
public abstract class GameConfig extends PlaceConfig implements Cloneable
|
||||
public abstract class GameConfig extends PlaceConfig
|
||||
implements Cloneable
|
||||
{
|
||||
/** Matchmaking type constant: a game that is started with a list of players, and those are the
|
||||
* only players that may play. */
|
||||
|
||||
@@ -67,7 +67,8 @@ public class GameManager extends PlaceManager
|
||||
{
|
||||
/**
|
||||
* An interface for identifying users. A larger system using the Parlor game services can
|
||||
* enable user identification by passing a UserIdentifier to {@link #setUserIdentifier}.
|
||||
* enable user identification by passing a UserIdentifier to
|
||||
* {@link GameManager#setUserIdentifier}.
|
||||
*/
|
||||
public interface UserIdentifier
|
||||
{
|
||||
@@ -690,7 +691,7 @@ public class GameManager extends PlaceManager
|
||||
DObject player = _omgr.getObject(playerId);
|
||||
return (player instanceof BodyObject) ? (BodyObject) player : null;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Returns true if this game requires a no-show timer. The default implementation returns true
|
||||
|
||||
@@ -26,7 +26,6 @@ import com.samskivert.jdbc.depot.PersistentRecord;
|
||||
import com.samskivert.jdbc.depot.annotation.Column;
|
||||
import com.samskivert.jdbc.depot.annotation.Id;
|
||||
import com.samskivert.jdbc.depot.expression.ColumnExp;
|
||||
|
||||
import com.threerings.parlor.rating.util.Percentiler;
|
||||
|
||||
/**
|
||||
@@ -63,7 +62,7 @@ public class PercentileRecord extends PersistentRecord
|
||||
|
||||
// AUTO-GENERATED: METHODS START
|
||||
/**
|
||||
* Create and return a primary {@link Key} to identify a {@link #PercentileRecord}
|
||||
* Create and return a primary {@link Key} to identify a {@link PercentileRecord}
|
||||
* with the supplied key values.
|
||||
*/
|
||||
public static Key<PercentileRecord> getKey (int gameId)
|
||||
|
||||
@@ -125,7 +125,7 @@ public class RatingRecord extends PersistentRecord
|
||||
|
||||
// AUTO-GENERATED: METHODS START
|
||||
/**
|
||||
* Create and return a primary {@link Key} to identify a {@link #RatingRecord}
|
||||
* Create and return a primary {@link Key} to identify a {@link RatingRecord}
|
||||
* with the supplied key values.
|
||||
*/
|
||||
public static Key<RatingRecord> getKey (int gameId, int playerId)
|
||||
|
||||
@@ -21,15 +21,14 @@
|
||||
|
||||
package com.threerings.parlor.turn.client;
|
||||
|
||||
import com.threerings.crowd.client.PlaceController;
|
||||
import com.threerings.util.Name;
|
||||
|
||||
import com.threerings.parlor.game.client.GameController;
|
||||
|
||||
/**
|
||||
* Games that wish to make use of the turn game services should have their
|
||||
* controller implement this interface and create an instance of {@link
|
||||
* TurnGameControllerDelegate} which should be passed to {@link
|
||||
* GameController#addDelegate}.
|
||||
* PlaceController#addDelegate}.
|
||||
*/
|
||||
public interface TurnGameController
|
||||
{
|
||||
|
||||
@@ -21,24 +21,22 @@
|
||||
|
||||
package com.threerings.parlor.turn.server;
|
||||
|
||||
import com.samskivert.util.RandomUtil;
|
||||
import com.threerings.util.Name;
|
||||
import static com.threerings.parlor.Log.log;
|
||||
|
||||
import com.samskivert.util.RandomUtil;
|
||||
import com.threerings.crowd.data.PlaceConfig;
|
||||
import com.threerings.crowd.data.PlaceObject;
|
||||
|
||||
import com.threerings.crowd.server.PlaceManager;
|
||||
import com.threerings.parlor.game.server.GameManager;
|
||||
import com.threerings.parlor.game.server.GameManagerDelegate;
|
||||
|
||||
import com.threerings.parlor.turn.data.TurnGameObject;
|
||||
|
||||
import static com.threerings.parlor.Log.log;
|
||||
import com.threerings.util.Name;
|
||||
|
||||
/**
|
||||
* Performs the server-side turn-based game processing for a turn based game. Game managers which
|
||||
* wish to make use of the turn services must implement {@link TurnGameManager} and either create
|
||||
* an instance of this class, or an instance of a derivation which customizes the behavior, either
|
||||
* of which would be passed to {@link GameManager#addDelegate} to be activated.
|
||||
* of which would be passed to {@link PlaceManager#addDelegate} to be activated.
|
||||
*/
|
||||
public class TurnGameManagerDelegate extends GameManagerDelegate
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user