net.sf.freecol.server.control

Class ChangeSet.MoveChange

java.lang.Object

net.sf.freecol.server.control.ChangeSet.Change

net.sf.freecol.server.control.ChangeSet.MoveChange

Enclosing class:

ChangeSet

private static class ChangeSet.MoveChange
extends ChangeSet.Change

Encapsulate a move.

Field Summary

Fields

Modifier and Type	Field and Description
private Tile	newTile
private Location	oldLocation
private Unit	unit

Fields inherited from class net.sf.freecol.server.control.ChangeSet.Change

see

Constructor Summary

Constructors

Constructor and Description
MoveChange(ChangeSet.See see, Unit unit, Location oldLocation, Tile newTile) Build a new MoveChange.

Method Summary

Modifier and Type	Method and Description
void	attachToElement(org.w3c.dom.Element element) Some changes can not be directly specialized, but need to be directly attached to an element.
java.util.List<ChangeSet.Change>	consequences(ServerPlayer serverPlayer) There are consequences to a move.
int	getPriority() Gets the sort priority.
boolean	isPerhapsNotifiable(ServerPlayer serverPlayer) Should a player perhaps be notified of this move?
private boolean	seeNew(ServerPlayer serverPlayer)
private boolean	seeOld(ServerPlayer serverPlayer)
org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a MoveChange into an "animateMove" element for a particular player.
java.lang.String	toString()

Methods inherited from class net.sf.freecol.server.control.ChangeSet.Change

convertsToElement, isNotifiable, matches

Methods inherited from class java.lang.Object

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

Field Detail

unit

private final Unit unit

oldLocation

private final Location oldLocation

newTile

private final Tile newTile

Constructor Detail

MoveChange

public MoveChange(ChangeSet.See see,
                  Unit unit,
                  Location oldLocation,
                  Tile newTile)

Build a new MoveChange.

Parameters:

see - The visibility of this change.

unit - The Unit that is moving.

oldLocation - The location from which the unit is moving.

newTile - The Tile to which the unit is moving.

Method Detail

seeOld

private boolean seeOld(ServerPlayer serverPlayer)

seeNew

private boolean seeNew(ServerPlayer serverPlayer)

getPriority

public int getPriority()

Gets the sort priority.

Specified by:

getPriority in class ChangeSet.Change

Returns:

"CHANGE_ANIMATION"

isPerhapsNotifiable

public boolean isPerhapsNotifiable(ServerPlayer serverPlayer)

Should a player perhaps be notified of this move?

Overrides:

isPerhapsNotifiable in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to notify.

Returns:

True if the player should be notified.

consequences

public java.util.List<ChangeSet.Change> consequences(ServerPlayer serverPlayer)

There are consequences to a move. If the player can not see the unit after the move, it should be removed.

Overrides:

consequences in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to notify.

Returns:

A RemoveChange if the unit disappears (but not if it is destroyed, that is handled elsewhere).

toElement

public org.w3c.dom.Element toElement(ServerPlayer serverPlayer,
                                     org.w3c.dom.Document doc)

Specialize a MoveChange into an "animateMove" element for a particular player.

Specified by:

toElement in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to update.

doc - The owner Document.

Returns:

An "animateMove" element.

attachToElement

public void attachToElement(org.w3c.dom.Element element)

Some changes can not be directly specialized, but need to be directly attached to an element.

Specified by:

attachToElement in class ChangeSet.Change

Parameters:

element - The Element to attach to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object