net.sf.freecol.common.networking

Class GetNationSummaryMessage

java.lang.Object

net.sf.freecol.common.networking.DOMMessage

net.sf.freecol.common.networking.GetNationSummaryMessage

public class GetNationSummaryMessage
extends DOMMessage

The message sent when summarizing a nation.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	playerId The identifier of the player to summarize.
private NationSummary	summary The summary.

Fields inherited from class net.sf.freecol.common.networking.DOMMessage

document, logger

Constructor Summary

Constructors

Constructor and Description
GetNationSummaryMessage(org.w3c.dom.Element element) Create a new GetNationSummaryMessage from a supplied element.
GetNationSummaryMessage(Player player) Create a new GetNationSummaryMessage for the specified player.

Method Summary

Modifier and Type	Method and Description
NationSummary	getNationSummary() Client side helper to get the summary.
static java.lang.String	getXMLElementTagName() The tag name of the root element representing this object.
org.w3c.dom.Element	handle(FreeColServer server, Connection connection) Handle a "getNationSummary"-message.
org.w3c.dom.Element	toXMLElement() Convert this GetNationSummaryMessage to XML.

Methods inherited from class net.sf.freecol.common.networking.DOMMessage

clientError, collapseElements, createError, createError, createMessage, createMessage, createNewDocument, createNewRootElement, elementToString, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

playerId

private final java.lang.String playerId

The identifier of the player to summarize.

summary

private NationSummary summary

The summary.

Constructor Detail

GetNationSummaryMessage

public GetNationSummaryMessage(Player player)

Create a new GetNationSummaryMessage for the specified player.

Parameters:

player - The Player to summarize.

GetNationSummaryMessage

public GetNationSummaryMessage(org.w3c.dom.Element element)

Create a new GetNationSummaryMessage from a supplied element.

Parameters:

element - The Element to use to create the message.

Method Detail

getNationSummary

public NationSummary getNationSummary()

Client side helper to get the summary.

Returns:

The summary.

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Connection connection)

Handle a "getNationSummary"-message.

Parameters:

server - The FreeColServer handling the message.

connection - The Connection message was received on.

Returns:

An update containing the nation summaries, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this GetNationSummaryMessage to XML.

Overrides:

toXMLElement in class DOMMessage

Returns:

The XML representation of this message.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

The tag name of the root element representing this object.

Returns:

"getNationSummary".