net.sf.freecol.common.networking
Class DeclareIndependenceMessage

java.lang.Object
  net.sf.freecol.common.networking.DOMMessage
      net.sf.freecol.common.networking.DeclareIndependenceMessage

public class DeclareIndependenceMessage
extends DOMMessage

The message sent when a player declares independence.

Field Summary

private java.lang.String	countryName The new name for the rebelling country
private java.lang.String	nationName The new name for the rebelling nation

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

document, logger

Constructor Summary

DeclareIndependenceMessage(Game game, org.w3c.dom.Element element)
Create a new DeclareIndependenceMessage from a supplied element.

DeclareIndependenceMessage(java.lang.String nationName, java.lang.String countryName)
Create a new DeclareIndependenceMessage with the supplied name.

Method Summary

static java.lang.String	getXMLElementTagName() The tag name of the root element representing this object.
org.w3c.dom.Element	handle(FreeColServer server, Player player, Connection connection) Handle a "declareIndependence"-message.
org.w3c.dom.Element	toXMLElement() Convert this DeclareIndependenceMessage to XML.

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

clientError, collapseElements, createError, createError, 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

nationName

private java.lang.String nationName

The new name for the rebelling nation

countryName

private java.lang.String countryName

The new name for the rebelling country

Constructor Detail

DeclareIndependenceMessage

public DeclareIndependenceMessage(java.lang.String nationName,
                                  java.lang.String countryName)

Create a new DeclareIndependenceMessage with the supplied name.

Parameters:

nationName - The new name for the rebelling nation.

countryName - The new name for the rebelling country.

DeclareIndependenceMessage

public DeclareIndependenceMessage(Game game,
                                  org.w3c.dom.Element element)

Create a new DeclareIndependenceMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

handle

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

Handle a "declareIndependence"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection the message is from.

Returns:

An update Element describing the REF and the rebel player, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this DeclareIndependenceMessage 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:

"declareIndependence".