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

protected FreeColGameObject

fcgo

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

see

Constructor Summary

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

Method Summary

boolean	isPerhapsNotifiable(ServerPlayer serverPlayer) Should a player perhaps be notified of this update?
int	sortPriority() The sort priority.
org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a ObjectChange to a particular player.

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

attachToElement, consequences, convertsToElement, isNotifiable

Methods inherited from class java.lang.Object

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

Field Detail

fcgo

protected FreeColGameObject fcgo

Constructor Detail

ChangeSet.ObjectChange

ChangeSet.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

sortPriority

public int sortPriority()

The sort priority.

Specified by:

sortPriority 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.