games.strategy.engine.lobby.server
Class GameDescription

java.lang.Object
  extended by games.strategy.engine.lobby.server.GameDescription
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class GameDescription
extends java.lang.Object
implements java.io.Externalizable, java.lang.Cloneable

NOTE - this class is not thread safe. Modifications should be done holding an external lock.

Author:
sgb
See Also:
Serialized Form

Nested Class Summary
static class GameDescription.GameStatus
           
 
Constructor Summary
GameDescription()
           
GameDescription(INode hostedBy, int port, java.util.Date startDateTime, java.lang.String gameName, int playerCount, GameDescription.GameStatus status, java.lang.String round, java.lang.String hostName, java.lang.String comment)
           
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String getComment()
           
 java.lang.String getGameName()
           
 INode getHostedBy()
           
 java.lang.String getHostName()
           
 int getPlayerCount()
           
 int getPort()
           
 java.lang.String getRound()
           
 java.util.Date getStartDateTime()
           
 GameDescription.GameStatus getStatus()
           
 int getVersion()
          The version number is updated after every change.
 void readExternal(java.io.ObjectInput in)
           
 void setComment(java.lang.String comment)
           
 void setGameName(java.lang.String gameName)
           
 void setHostedBy(INode hostedBy)
           
 void setHostName(java.lang.String hostName)
           
 void setPlayerCount(int playerCount)
           
 void setPort(int port)
           
 void setRound(java.lang.String round)
           
 void setStartDateTime(java.util.Date startDateTime)
           
 void setStatus(GameDescription.GameStatus status)
           
 java.lang.String toString()
           
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GameDescription

public GameDescription()

GameDescription

public GameDescription(INode hostedBy,
                       int port,
                       java.util.Date startDateTime,
                       java.lang.String gameName,
                       int playerCount,
                       GameDescription.GameStatus status,
                       java.lang.String round,
                       java.lang.String hostName,
                       java.lang.String comment)
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

getVersion

public int getVersion()
The version number is updated after every change. This handles synchronization problems where updates arrive out of order


setGameName

public void setGameName(java.lang.String gameName)

setHostedBy

public void setHostedBy(INode hostedBy)

setPlayerCount

public void setPlayerCount(int playerCount)

setPort

public void setPort(int port)

setRound

public void setRound(java.lang.String round)

setStartDateTime

public void setStartDateTime(java.util.Date startDateTime)

setStatus

public void setStatus(GameDescription.GameStatus status)

getRound

public java.lang.String getRound()

getGameName

public java.lang.String getGameName()

getHostedBy

public INode getHostedBy()

getPlayerCount

public int getPlayerCount()

getPort

public int getPort()

getStartDateTime

public java.util.Date getStartDateTime()

getStatus

public GameDescription.GameStatus getStatus()

getHostName

public java.lang.String getHostName()

setHostName

public void setHostName(java.lang.String hostName)

getComment

public java.lang.String getComment()

setComment

public void setComment(java.lang.String comment)

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

toString

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