net.sf.freecol.common.networking
Class RenameMessage

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

public class RenameMessage
extends DOMMessage

The message sent when renaming a FreeColGameObject.

Field Summary

private java.lang.String	id The id of the object to be renamed.
private java.lang.String	newName The new name.

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

document, logger

Constructor Summary

RenameMessage(FreeColGameObject object, java.lang.String newName)
Create a new RenameMessage with the supplied name.

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

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 "rename"-message.
org.w3c.dom.Element	toXMLElement() Convert this RenameMessage 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

id

private java.lang.String id

The id of the object to be renamed.

newName

private java.lang.String newName

The new name.

Constructor Detail

RenameMessage

public RenameMessage(FreeColGameObject object,
                     java.lang.String newName)

Create a new RenameMessage with the supplied name.

Parameters:

object - The FreeColGameObject to rename.

newName - The new name for the object.

RenameMessage

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

Create a new RenameMessage 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 "rename"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

An update containing the renamed unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"rename".