Package net.sf.freecol.common.model

Class TileTypeChange

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

All Implemented Interfaces:

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

public class TileTypeChange
extends FreeColSpecObjectType

A change in a tile type, including some bonus production when this occurs.

Field Summary

Fields

Modifier and Type	Field	Description
private TileType	from	The original tile type.
private static java.lang.String	FROM_TAG
private static java.lang.String	GOODS_TYPE_TAG
private AbstractGoods	production	The goods produced by the tile type change, e.g.
private static java.lang.String	PRODUCTION_TAG
static java.lang.String	TAG
private TileType	to	The destination tile type.
private static java.lang.String	TO_TAG
private static java.lang.String	VALUE_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

Constructor Summary

Constructors

Constructor	Description
TileTypeChange(FreeColXMLReader xr, Specification specification)	Creates a new TileTypeChange instance.
TileTypeChange(Specification specification)	Create a new tile type change.

Method Summary

Modifier and Type	Method	Description
<T extends FreeColObject> boolean	copyIn(T other)	Copy another FreeColObject into this one if it is compatible.
boolean	equals(java.lang.Object other)
TileType	getFrom()	Gets the original tile type.
AbstractGoods	getProduction()	Gets the production consequent to the type change.
TileType	getTo()	Gets the destination tile type.
java.lang.String	getXMLTagName()	Get the serialization tag for this object.
int	hashCode()
protected void	readAttributes(FreeColXMLReader xr)	Reads the attributes of this object from an XML stream.
protected void	readChildren(FreeColXMLReader xr)	Reads the children of this object from an XML stream.
protected void	writeAttributes(FreeColXMLWriter xw)	Write the attributes of this object to a stream.
protected void	writeChildren(FreeColXMLWriter xw)	Write the children 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, removeScope, setIndex, toString

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, 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, 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

private TileType from

The original tile type.

to

private TileType to

The destination tile type.

production

private AbstractGoods production

The goods produced by the tile type change, e.g. lumber when clearing a forest.

FROM_TAG

private static final java.lang.String FROM_TAG

See Also:

Constant Field Values

GOODS_TYPE_TAG

private static final java.lang.String GOODS_TYPE_TAG

See Also:

Constant Field Values

PRODUCTION_TAG

private static final java.lang.String PRODUCTION_TAG

See Also:

Constant Field Values

TO_TAG

private static final java.lang.String TO_TAG

See Also:

Constant Field Values

VALUE_TAG

private static final java.lang.String VALUE_TAG

See Also:

Constant Field Values

Constructor Detail

TileTypeChange

public TileTypeChange(Specification specification)

Create a new tile type change.

Parameters:

specification - The Specification to refer to.

TileTypeChange

public TileTypeChange(FreeColXMLReader xr,
                      Specification specification)
               throws javax.xml.stream.XMLStreamException

Creates a new TileTypeChange instance.

Parameters:

xr - The FreeColXMLReader to read from.

specification - The Specification to refer to.

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

Method Detail

getFrom

public final TileType getFrom()

Gets the original tile type.

Returns:

The original tile type.

getTo

public final TileType getTo()

Gets the destination tile type.

Returns:

The destination tile type.

getProduction

public final AbstractGoods getProduction()

Gets the production consequent to the type change.

Returns:

The consequent production.

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.

writeChildren

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

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

Overrides:

writeChildren in class FreeColSpecObjectType

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.

readChildren

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

Reads the children of this object from an XML stream.

Overrides:

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

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class FreeColObject

hashCode

public int hashCode()

Overrides:

hashCode in class FreeColObject