net.sf.freecol.server.control

Class ChangeSet.RemoveChange

java.lang.Object

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

net.sf.freecol.server.control.ChangeSet.RemoveChange

Enclosing class:

ChangeSet

private static class ChangeSet.RemoveChange
extends ChangeSet.Change

Encapsulates removing some objects. -vis: If removing settlements or units, visibility changes.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<? extends FreeColGameObject>	contents
private FreeColGameObject	fcgo
private Tile	tile

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

see

Constructor Summary

Constructors

Constructor and Description
RemoveChange(ChangeSet.See see, Location loc, java.util.List<? extends FreeColGameObject> objects) Build a new RemoveChange for an object that is disposed.

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.
int	getPriority() Gets the sort priority.
boolean	isPerhapsNotifiable(ServerPlayer serverPlayer) Should a player perhaps be notified of this removal? They should if they can see the tile, and there is no other-player settlement present.
org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a RemoveChange to a particular player.
java.lang.String	toString()

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

consequences, convertsToElement, isNotifiable, matches

Methods inherited from class java.lang.Object

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

Field Detail

tile

private final Tile tile

fcgo

private final FreeColGameObject fcgo

contents

private final java.util.List<? extends FreeColGameObject> contents

Constructor Detail

RemoveChange

public RemoveChange(ChangeSet.See see,
                    Location loc,
                    java.util.List<? extends FreeColGameObject> objects)

Build a new RemoveChange for an object that is disposed.

Parameters:

see - The visibility of this change.

loc - The Location where the object was.

objects - The FreeColGameObjects to remove.

Method Detail

getPriority

public int getPriority()

Gets the sort priority.

Specified by:

getPriority in class ChangeSet.Change

Returns:

"CHANGE_REMOVE"

isPerhapsNotifiable

public boolean isPerhapsNotifiable(ServerPlayer serverPlayer)

Should a player perhaps be notified of this removal? They should if they can see the tile, and there is no other-player settlement present.

Overrides:

isPerhapsNotifiable in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to notify.

Returns:

True if the player should be notified.

toElement

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

Specialize a RemoveChange to a particular player.

Specified by:

toElement in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to update.

doc - The owner Document.

Returns:

A "remove" 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