Package net.sf.freecol.common.model

Class UnitTypeChange

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColSpecObject

net.sf.freecol.common.model.FreeColSpecObjectType

net.sf.freecol.common.model.UnitTypeChange

All Implemented Interfaces:

java.lang.Comparable<FreeColObject>, Named, ObjectWithId

public class UnitTypeChange
extends FreeColSpecObjectType

Simple container for individual type changes.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.concurrent.atomic.AtomicInteger	fakeIdIndex
UnitType	from	The unit type to change from.
private static java.lang.String	FROM_TAG
int	probability	The percentage chance of the change occurring.
private static java.lang.String	PROBABILITY_TAG
static java.lang.String	TAG
UnitType	to	The unit type to change to.
private static java.lang.String	TO_TAG
int	turns	The number of turns for the change to take, if not immediate.
private static java.lang.String	TURNS_TAG

Fields inherited from class net.sf.freecol.common.model.FreeColSpecObjectType

DELETE_TAG, EXTENDS_TAG, PRESERVE_TAG

Fields inherited from class net.sf.freecol.common.model.FreeColObject

ARRAY_SIZE_TAG, DEFAULT_CLASS_INDEX, fcoComparator, ID_ATTRIBUTE_TAG, logger, PARTIAL_ATTRIBUTE_TAG, VALUE_TAG

Constructor Summary

Constructors

Constructor	Description
UnitTypeChange(java.lang.String id, Specification specification)	Trivial constructor.
UnitTypeChange(FreeColXMLReader xr, Specification spec)	Read a unit change from a stream.

Method Summary

Modifier and Type	Method	Description
<T extends FreeColObject> boolean	copyIn(T other)	Copy another FreeColObject into this one if it is compatible.
java.lang.String	getXMLTagName()	Get the serialization tag for this object.
boolean	isAvailableTo(Player player)	Helper to check if a change is available to a player.
protected void	readAttributes(FreeColXMLReader xr)	Reads the attributes of this object from an XML stream.
java.lang.String	toString()
protected void	writeAttributes(FreeColXMLWriter xw)	Write the attributes of this object to a stream.

Methods inherited from class net.sf.freecol.common.model.FreeColSpecObjectType

addScope, appliesTo, copyScopes, getDescriptionKey, getFeatureContainer, getIndex, getNameKey, getScopeList, getScopes, isAbstractType, readChild, readChildren, removeScope, setIndex, writeChildren

Methods inherited from class net.sf.freecol.common.model.FreeColSpecObject

getSpecification, setSpecification

Methods inherited from class net.sf.freecol.common.model.FreeColObject

addAbility, addFeatures, addModifier, addPropertyChangeListener, addPropertyChangeListener, apply, apply, applyModifiers, applyModifiers, arrayKey, compareIds, compareTo, containsAbilityKey, containsModifierKey, copy, copy, copy, copy, copyInCast, dumpObject, equals, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAbilities, getAbilities, getAbilities, getAbilities, getClassIndex, getDefenceModifiers, getDisplayObject, getFreeColObjectClass, getFreeColObjectClassByName, getGame, getId, getIdNumber, getIdType, getIdTypeByName, getModifiers, getModifiers, getModifiers, getModifiers, getObjectClassIndex, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getSortedAbilities, getSortedModifiers, getSuffix, getSuffix, hasAbility, hasAbility, hasAbility, hashCode, hasListeners, hasModifier, hasModifier, hasModifier, idEquals, invokeMethod, logFreeColObjects, readFromXML, readFromXMLPartial, removeAbilities, removeAbility, removeFeatures, removeModifier, removeModifiers, removePropertyChangeListener, removePropertyChangeListener, save, save, save, save, serialize, serialize, serialize, serialize, setGame, setId, toXML, toXML, toXMLPartial, toXMLPartial

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

from

public UnitType from

The unit type to change from.

to

public UnitType to

The unit type to change to.

probability

public int probability

The percentage chance of the change occurring.

turns

public int turns

The number of turns for the change to take, if not immediate.

fakeIdIndex

private static java.util.concurrent.atomic.AtomicInteger fakeIdIndex

FROM_TAG

private static final java.lang.String FROM_TAG

See Also:

Constant Field Values

PROBABILITY_TAG

private static final java.lang.String PROBABILITY_TAG

See Also:

Constant Field Values

TO_TAG

private static final java.lang.String TO_TAG

See Also:

Constant Field Values

TURNS_TAG

private static final java.lang.String TURNS_TAG

See Also:

Constant Field Values

Constructor Detail

UnitTypeChange

public UnitTypeChange(java.lang.String id,
                      Specification specification)

Trivial constructor.

Parameters:

id - The object identifier.

specification - The Specification to use.

UnitTypeChange

public UnitTypeChange(FreeColXMLReader xr,
                      Specification spec)
               throws javax.xml.stream.XMLStreamException

Read a unit change from a stream.

Parameters:

xr - The FreeColXMLReader to read from.

spec - The Specification to read within.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem reading the stream.

Method Detail

isAvailableTo

public boolean isAvailableTo(Player player)

Helper to check if a change is available to a player. This is useful when the change involves a transfer of ownership.

Parameters:

player - The Player to test.

Returns:

True if the player can use the to-unit-type.

copyIn

public <T extends FreeColObject> boolean copyIn(T other)

Copy another FreeColObject into this one if it is compatible.

Overrides:

copyIn in class FreeColSpecObjectType

Type Parameters:

T - The FreeColObject subclass of the object to copy in.

Parameters:

other - The other object.

Returns:

True if the copy in is succesful.

writeAttributes

protected void writeAttributes(FreeColXMLWriter xw)
                        throws javax.xml.stream.XMLStreamException

Write the attributes of this object to a stream. To be overridden if required by any object that has attributes and uses the toXML(FreeColXMLWriter, String) call.

Overrides:

writeAttributes in class FreeColObject

Parameters:

xw - The FreeColXMLWriter to write to.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

readAttributes

protected void readAttributes(FreeColXMLReader xr)
                       throws javax.xml.stream.XMLStreamException

Reads the attributes of this object from an XML stream.

Overrides:

readAttributes in class FreeColSpecObjectType

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem reading the stream.

getXMLTagName

public java.lang.String getXMLTagName()

Get the serialization tag for this object.

Specified by:

getXMLTagName in class FreeColObject

Returns:

The tag.

toString

public java.lang.String toString()

Overrides:

toString in class FreeColSpecObjectType