net.sf.freecol.common.networking
Class NewLandNameMessage

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

public class NewLandNameMessage
extends DOMMessage

The message sent when naming a new land.

Field Summary

private java.lang.String	acceptString Has a treaty been accepted with the welcomer?
private java.lang.String	campCount An optional number of camps for the welcome message.
private java.lang.String	newLandName The name to use.
private java.lang.String	unitId The unit that has come ashore.
private java.lang.String	welcomerId An optional welcoming player.

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

document, logger

Constructor Summary

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

NewLandNameMessage(Unit unit, java.lang.String newLandName, Player welcomer, int camps, boolean accept)
Create a new NewLandNameMessage with the supplied name.

Method Summary

java.lang.String	getCamps() Public accessor for the camp count.
java.lang.String	getNewLandName() Public accessor for the new land name.
Unit	getUnit(Game game) Public accessor for the unit.
Player	getWelcomer(Game game) Public accessor for the welcomer.
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 "newLandName"-message.
void	setAccept(boolean accept) Sets the accept value of this message.
org.w3c.dom.Element	toXMLElement() Convert this NewLandNameMessage 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 unit that has come ashore.

newLandName

private java.lang.String newLandName

The name to use.

welcomerId

private java.lang.String welcomerId

An optional welcoming player.

campCount

private java.lang.String campCount

An optional number of camps for the welcome message.

acceptString

private java.lang.String acceptString

Has a treaty been accepted with the welcomer?

Constructor Detail

NewLandNameMessage

public NewLandNameMessage(Unit unit,
                          java.lang.String newLandName,
                          Player welcomer,
                          int camps,
                          boolean accept)

Create a new NewLandNameMessage with the supplied name.

Parameters:

unit - The Unit that has come ashore.

newLandName - The new land name.

welcomer - The optional welcomer nation.

camps - The optional number of camps of the welcomer nation.

accept - Accept the welcomer offer?

NewLandNameMessage

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

Create a new NewLandNameMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getUnit

public Unit getUnit(Game game)

Public accessor for the unit.

Parameters:

game - The Game to look for a unit in.

Returns:

The unit of this message.

getNewLandName

public java.lang.String getNewLandName()

Public accessor for the new land name.

Returns:

The new land name of this message.

getWelcomer

public Player getWelcomer(Game game)

Public accessor for the welcomer.

Parameters:

game - The Game to look for a welcomer in.

Returns:

The welcomer of this message.

setAccept

public void setAccept(boolean accept)

Sets the accept value of this message.

Parameters:

accept - The new accept value.

getCamps

public java.lang.String getCamps()

Public accessor for the camp count.

Returns:

The camp count of this message.

handle

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

Handle a "newLandName"-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 setting the new land name, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"newLandName".