Package net.sf.freecol.common.networking
Class ChangeWorkTypeMessage
- java.lang.Object
-
- net.sf.freecol.common.networking.Message
-
- net.sf.freecol.common.networking.TrivialMessage
-
- net.sf.freecol.common.networking.AttributeMessage
-
- net.sf.freecol.common.networking.ChangeWorkTypeMessage
-
public class ChangeWorkTypeMessage extends AttributeMessage
The message sent when changing the work type of a unit.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class net.sf.freecol.common.networking.Message
Message.MessagePriority
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TAG
private static java.lang.String
UNIT_TAG
private static java.lang.String
WORK_TYPE_TAG
-
Fields inherited from class net.sf.freecol.common.networking.AttributeMessage
attributes
-
Fields inherited from class net.sf.freecol.common.networking.TrivialMessage
continueMessage, disconnectMessage, endTurnMessage, enterRevengeModeMessage, reconnectMessage, requestLaunchMessage, retireMessage, startGameMessage
-
Fields inherited from class net.sf.freecol.common.networking.Message
logger, messagePriorityComparator
-
-
Constructor Summary
Constructors Constructor Description ChangeWorkTypeMessage(Game game, FreeColXMLReader xr)
Create a newChangeWorkTypeMessage
from a stream.ChangeWorkTypeMessage(Unit unit, GoodsType workType)
Create a newChangeWorkTypeMessage
with the supplied unit and produce.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
currentPlayerMessage()
Should this message only be sent to a server by the current player?Message.MessagePriority
getPriority()
Get the priority of this type of message.ChangeSet
serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)
Server-side handler for this message.-
Methods inherited from class net.sf.freecol.common.networking.AttributeMessage
canMerge, getStringAttribute, getStringAttributeMap, hasAttribute, setMergeable, setStringAttribute
-
Methods inherited from class net.sf.freecol.common.networking.TrivialMessage
aiHandler, appendChild, appendChildren, clientHandler, getChildCount, getChildren, getType, setChildren, setType
-
Methods inherited from class net.sf.freecol.common.networking.Message
clientGeneric, expected, getArrayAttributes, getBooleanAttribute, getChild, getChildren, getEnumAttribute, getIntegerAttribute, getPriorityLevel, igc, igc, invokeAndWait, invokeLater, isEmpty, isType, merge, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toString, toXML, writeAttributes, writeChildren
-
-
-
-
Field Detail
-
TAG
public static final java.lang.String TAG
- See Also:
- Constant Field Values
-
UNIT_TAG
private static final java.lang.String UNIT_TAG
- See Also:
- Constant Field Values
-
WORK_TYPE_TAG
private static final java.lang.String WORK_TYPE_TAG
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ChangeWorkTypeMessage
public ChangeWorkTypeMessage(Unit unit, GoodsType workType)
Create a newChangeWorkTypeMessage
with the supplied unit and produce.- Parameters:
unit
- TheUnit
that is working.workType
- TheGoodsType
to produce.
-
ChangeWorkTypeMessage
public ChangeWorkTypeMessage(Game game, FreeColXMLReader xr) throws javax.xml.stream.XMLStreamException
Create a newChangeWorkTypeMessage
from a stream.- Parameters:
game
- TheGame
this message belongs to.xr
- TheFreeColXMLReader
to read from.- Throws:
javax.xml.stream.XMLStreamException
- if the stream is corrupt.
-
-
Method Detail
-
currentPlayerMessage
public boolean currentPlayerMessage()
Should this message only be sent to a server by the current player?- Overrides:
currentPlayerMessage
in classTrivialMessage
- Returns:
- True if this is a current-player-only message.
-
getPriority
public Message.MessagePriority getPriority()
Get the priority of this type of message.- Overrides:
getPriority
in classAttributeMessage
- Returns:
- The message priority.
-
serverHandler
public ChangeSet serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)
Server-side handler for this message.- Overrides:
serverHandler
in classTrivialMessage
- Parameters:
freeColServer
- TheFreeColServer
handling the request.serverPlayer
- TheServerPlayer
that sent the request.- Returns:
- A
ChangeSet
defining the response.
-
-