net.sf.freecol.common.networking
Class AttackMessage

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

public class AttackMessage
extends DOMMessage

The message sent when attacking.

Field Summary

private java.lang.String	directionString The direction to attack.
private java.lang.String	unitId The id of the attacker.

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

document, logger

Constructor Summary

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

AttackMessage(Unit unit, Map.Direction direction)
Create a new AttackMessage for the supplied unit and direction.

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

unitId

private java.lang.String unitId

The id of the attacker.

directionString

private java.lang.String directionString

The direction to attack.

Constructor Detail

AttackMessage

public AttackMessage(Unit unit,
                     Map.Direction direction)

Create a new AttackMessage for the supplied unit and direction.

Parameters:

unit - The Unit attacking.

direction - The Direction to attack in.

AttackMessage

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

Create a new AttackMessage 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 "attack"-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 encapsulating the attack or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"attack".