net.sf.freecol.server.control

Class ChangeSet.Change

java.lang.Object

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

Direct Known Subclasses:

ChangeSet.AttackChange, ChangeSet.AttributeChange, ChangeSet.FeatureChange, ChangeSet.MessageChange, ChangeSet.MoveChange, ChangeSet.ObjectChange, ChangeSet.OwnedChange, ChangeSet.PlayerChange, ChangeSet.RemoveChange, ChangeSet.SpyChange, ChangeSet.StanceChange, ChangeSet.TrivialChange

Enclosing class:

ChangeSet

private abstract static class ChangeSet.Change
extends java.lang.Object

Abstract template for all types of Change.

Field Summary

Fields

Modifier and Type	Field and Description
protected ChangeSet.See	see The visibility of the change.

Constructor Summary

Constructors

Constructor and Description
Change(ChangeSet.See see) Make a new Change.

Method Summary

Modifier and Type	Method and Description
abstract 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) Are the secondary changes consequent to this Change?
boolean	convertsToElement() Can this Change be directly converted to an Element?
abstract int	getPriority() Gets the sort priority of a change, to be used by the changeComparator.
boolean	isNotifiable(ServerPlayer serverPlayer) Should a player be notified of this Change?
boolean	isPerhapsNotifiable(ServerPlayer serverPlayer) Should a player be notified of a Change for which the visibility is delegated to the change type, allowing special change-specific overrides.
boolean	matches(FreeColGameObject fcgo) Does this Change operate on the given object?
abstract org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a Change for a particular player.

Methods inherited from class java.lang.Object

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

Field Detail

see

protected final ChangeSet.See see

The visibility of the change.

Constructor Detail

Change

public Change(ChangeSet.See see)

Make a new Change.

Method Detail

matches

public boolean matches(FreeColGameObject fcgo)

Does this Change operate on the given object?

Parameters:

fcgo - The FreeColGameObject to check.

Returns:

True if the object is a subject of this change.

getPriority

public abstract int getPriority()

Gets the sort priority of a change, to be used by the changeComparator.

isNotifiable

public boolean isNotifiable(ServerPlayer serverPlayer)

Should a player be notified of this Change?

Parameters:

serverPlayer - The ServerPlayer to consider.

Returns:

True if this Change should be sent.

isPerhapsNotifiable

public boolean isPerhapsNotifiable(ServerPlayer serverPlayer)

Should a player be notified of a Change for which the visibility is delegated to the change type, allowing special change-specific overrides. This is false by default, subclasses should override when special case handling is required.

Parameters:

serverPlayer - The ServerPlayer to consider.

Returns:

False.

consequences

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

Are the secondary changes consequent to this Change?

Parameters:

serverPlayer - The ServerPlayer to consider.

Returns:

A list of secondary Changes or the empty list if there are none, which is usually the case.

convertsToElement

public boolean convertsToElement()

Can this Change be directly converted to an Element?

Returns:

True if this change can be directly converted to an Element.

toElement

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

Specialize a Change for a particular player.

Parameters:

serverPlayer - The ServerPlayer to update.

doc - The owner Document to build the element in.

Returns:

An Element encapsulating this change.

attachToElement

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

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

Parameters:

element - The Element to attach to.