games.strategy.engine.framework.message
Class PlayerListing

java.lang.Object
  extended by games.strategy.engine.framework.message.PlayerListing
All Implemented Interfaces:
java.io.Serializable

public class PlayerListing
extends java.lang.Object
implements java.io.Serializable

data from the server indicating what players are available to be taken, and what players are being played. This object also contains versioning info which the client should check to ensure that it is playing the same game as the server.

Author:
Sean Bridges
See Also:
Serialized Form

Constructor Summary
PlayerListing(java.util.Map<java.lang.String,java.lang.String> map, Version gameVersion, java.lang.String gameName, java.lang.String gameRound)
          Creates a new instance of PlayerListingMessage
 
Method Summary
 java.lang.String getGameName()
           
 java.lang.String getGameRound()
           
 Version getGameVersion()
           
 java.util.Map<java.lang.String,java.lang.String> getPlayerListing()
           
 java.util.Set getPlayers()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PlayerListing

public PlayerListing(java.util.Map<java.lang.String,java.lang.String> map,
                     Version gameVersion,
                     java.lang.String gameName,
                     java.lang.String gameRound)
Creates a new instance of PlayerListingMessage

Method Detail

getPlayerListing

public java.util.Map<java.lang.String,java.lang.String> getPlayerListing()

getGameName

public java.lang.String getGameName()

getGameVersion

public Version getGameVersion()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getPlayers

public java.util.Set getPlayers()

getGameRound

public java.lang.String getGameRound()