EndTurnMessage (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.common.networking.Message
- - net.sf.freecol.common.networking.TrivialMessage
  - - net.sf.freecol.common.networking.EndTurnMessage

```
public class EndTurnMessage
extends TrivialMessage
```
A trivial message to inform the server that the client has finished its turn.

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
- 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
`EndTurnMessage()`	Create a new `EndTurnMessage` of a given type.
`EndTurnMessage(Game game, FreeColXMLReader xr)`	Create a new `EndTurnMessage` from a stream.

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?
`ChangeSet`	`serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)`	Server-side handler for this message.

Methods inherited from class net.sf.freecol.common.networking.TrivialMessage
aiHandler, appendChild, appendChildren, clientHandler, getChildCount, getChildren, getPriority, getStringAttribute, getStringAttributeMap, getType, hasAttribute, setChildren, setStringAttribute, setType

Methods inherited from class net.sf.freecol.common.networking.Message
canMerge, 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EndTurnMessage
```
public EndTurnMessage()
```
    Create a new EndTurnMessage of a given type.
  - EndTurnMessage
```
public EndTurnMessage(Game game,
                      FreeColXMLReader xr)
               throws javax.xml.stream.XMLStreamException
```
    Create a new EndTurnMessage from a stream.
    
    Parameters:
    
    game - The Game this message belongs to.
    
    xr - The FreeColXMLReader 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 class TrivialMessage
    
    Returns:
    
    True if this is a current-player-only message.
  - serverHandler
```
public ChangeSet serverHandler(FreeColServer freeColServer,
                               ServerPlayer serverPlayer)
```
    Server-side handler for this message.
    
    Overrides:
    
    serverHandler in class TrivialMessage
    
    Parameters:
    
    freeColServer - The FreeColServer handling the request.
    
    serverPlayer - The ServerPlayer that sent the request.
    
    Returns:
    
    A ChangeSet defining the response.