net.sf.freecol.server.control

Class ChangeSet.ObjectChange

java.lang.Object

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

net.sf.freecol.server.control.ChangeSet.ObjectChange

Direct Known Subclasses:

ChangeSet.PartialObjectChange

Enclosing class:

ChangeSet

private static class ChangeSet.ObjectChange
extends ChangeSet.Change

Encapsulate a FreeColGameObject update.

Field Summary

Fields

Modifier and Type	Field and Description
protected FreeColGameObject	fcgo

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

see

Constructor Summary

Constructors

Constructor and Description
ObjectChange(ChangeSet.See see, FreeColGameObject fcgo) Build a new ObjectChange for a single object.

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 update?
boolean	matches(FreeColGameObject fcgo) Does this Change operate on the given object?
org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a ObjectChange to a particular player.
java.lang.String	toString()

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

consequences, convertsToElement, isNotifiable

Methods inherited from class java.lang.Object

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

Field Detail

fcgo

protected final FreeColGameObject fcgo

Constructor Detail

ObjectChange

public ObjectChange(ChangeSet.See see,
                    FreeColGameObject fcgo)

Build a new ObjectChange for a single object.

Parameters:

see - The visibility of this change.

fcgo - The FreeColGameObject to update.

Method Detail

matches

public boolean matches(FreeColGameObject fcgo)

Does this Change operate on the given object?

Overrides:

matches in class ChangeSet.Change

Parameters:

fcgo - The FreeColGameObject to check.

Returns:

True if the object is a subject of this change.

getPriority

public int getPriority()

Gets the sort priority.

Specified by:

getPriority in class ChangeSet.Change

Returns:

"CHANGE_UPDATE"

isPerhapsNotifiable

public boolean isPerhapsNotifiable(ServerPlayer serverPlayer)

Should a player perhaps be notified of this update?

Overrides:

isPerhapsNotifiable in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to notify.

Returns:

True if the object update can is notifiable.

toElement

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

Specialize a ObjectChange to a particular player.

Specified by:

toElement in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to update.

doc - The owner Document.

Returns:

An "update" element, or null if the update should not be visible to the player.

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