RetireMessage (FreeCol Code Documentation)

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

```
public class RetireMessage
extends TrivialMessage
```
A trivial message sent to the server when the client wants to retire.

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

RetireMessage()
Create a new RetireMessage.

RetireMessage(Game game, FreeColXMLReader xr)
Create a new RetireMessage from a stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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, currentPlayerMessage, 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
  - RetireMessage
```
public RetireMessage()
```
    Create a new RetireMessage.
  - RetireMessage
```
public RetireMessage(Game game,
                     FreeColXMLReader xr)
              throws javax.xml.stream.XMLStreamException
```
    Create a new RetireMessage 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
  - 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.