soc.message
Class SOCVersion

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCVersion

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCVersion

extends SOCMessage

This message sends the server's or client's version to the other side of the connection. Sent first from server to client, then client responds. Version numbers are read via Version.

Version:

1.10.0 Introduced 2008-08-07 to add client-server versioning

Author:

Jeremy D. Monin

See Also:

Serialized Form

Field Summary

private java.lang.String	versBuild Version build, or null, as in Version.buildnum()
private int	versNum Version number, as in Version.versionNumber()
private java.lang.String	versStr Version display string, as in Version.version()

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DELETECHANNEL, DELETEGAME, DEVCARD, DEVCARDCOUNT, DICERESULT, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAMEMEMBERS, GAMES, GAMESTATE, GAMESTATS, GAMETEXTMSG, IMAROBOT, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, JOINGAMEREQUEST, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEROBBER, NEWCHANNEL, NEWGAME, NULLMESSAGE, PLAYDEVCARDREQUEST, PLAYERELEMENT, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCVersion(int verNum, java.lang.String verStr, java.lang.String verBuild)
Create a Version message.

Method Summary

java.lang.String	getBuild()
int	getMinimumVersion() Minimum version where this message type is used.
int	getVersionNumber()
java.lang.String	getVersionString()
static SOCVersion	parseDataStr(java.lang.String s) Parse the command String into a Version message
java.lang.String	toCmd() VERSION SEP vernum SEP2 verstr SEP2 build; build may be blank
static java.lang.String	toCmd(int verNum, java.lang.String verStr, java.lang.String verBuild) VERSION SEP vernum SEP2 verstr SEP2 build; build may be blank
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

getMaximumVersion, getType, toMsg, toSingleElemArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

versStr

private java.lang.String versStr

Version display string, as in Version.version()

versNum

private int versNum

Version number, as in Version.versionNumber()

versBuild

private java.lang.String versBuild

Version build, or null, as in Version.buildnum()

Constructor Detail

SOCVersion

public SOCVersion(int verNum,
                  java.lang.String verStr,
                  java.lang.String verBuild)

Create a Version message.

Parameters:

verNum - The version number, as in Version.versionNumber()

verStr - The version display string, as in Version.version()

verBuild - The version build, or null, as in Version.buildnum()

Method Detail

getVersionNumber

public int getVersionNumber()

Returns:

the version number, as in Version.versionNumber()

getVersionString

public java.lang.String getVersionString()

Returns:

the version display string, as in Version.version()

getBuild

public java.lang.String getBuild()

Returns:

the build, as in Version.buildnum(), or null

toCmd

public java.lang.String toCmd()

VERSION SEP vernum SEP2 verstr SEP2 build; build may be blank

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(int verNum,
                                     java.lang.String verStr,
                                     java.lang.String verBuild)

VERSION SEP vernum SEP2 verstr SEP2 build; build may be blank

Parameters:

verNum - the version number, like 1100 for 1.1.00, as in Version.versionNumber()

verStr - the version as string, like "1.1.00"

verBuild - the version build, or null, from Version.buildnum()

Returns:

the command string

parseDataStr

public static SOCVersion parseDataStr(java.lang.String s)

Parse the command String into a Version message

Parameters:

s - the String to parse

Returns:

a Version message

toString

public java.lang.String toString()

Description copied from class: SOCMessage

Simple human-readable representation, used for debug purposes.

Specified by:

toString in class SOCMessage

Returns:

a human readable form of the message

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. VERSION introduced in 1.1.00 for client/server versioning.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 1100 for JSettlers 1.1.00.