Package net.sf.freecol.common.model

Class UnitTradeItem

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColGameObject

net.sf.freecol.common.model.TradeItem

net.sf.freecol.common.model.UnitTradeItem

All Implemented Interfaces:

java.lang.Comparable<FreeColObject>, ObjectWithId

public class UnitTradeItem
extends TradeItem

A trade item consisting of a unit.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TAG
private Unit	unit	The unit to change hands.
private static java.lang.String	UNIT_TAG

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

INVALID_TRADE_ITEM

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

initialized

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

ARRAY_SIZE_TAG, DEFAULT_CLASS_INDEX, fcoComparator, ID_ATTRIBUTE_TAG, PARTIAL_ATTRIBUTE_TAG, VALUE_TAG

Constructor Summary

Constructors

Constructor	Description
UnitTradeItem(Game game, FreeColXMLReader xr)	Creates a new UnitTradeItem instance.
UnitTradeItem(Game game, Player source, Player destination, Unit unit)	Creates a new UnitTradeItem instance.

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)
int	evaluateFor(Player player)	Evaluate this trade item for a given player.
StringTemplate	getLabel()	Get a label for this item.
Unit	getUnit()	Get the unit to trade.
java.lang.String	getXMLTagName()	Get the serialization tag for this object.
int	hashCode()
boolean	isUnique()	Is this trade item unique? This is true for the StanceTradeItem and the GoldTradeItem, and false for all others.
boolean	isValid()	Is this trade item valid? That is, is the request well formed.
protected void	readAttributes(FreeColXMLReader xr)	Reads the attributes of this object from an XML stream.
void	setUnit(Unit unit)	Set the unit to trade.
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.TradeItem

getColony, getDestination, getGold, getGoods, getOther, getSource, getStance, getVictim, isInternable, setDestination, setGold, setGoods, setSource, setStance

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

checkIntegrity, dispose, disposeResources, fundamentalDispose, getClassIndex, getDisposables, getGame, getLinkTarget, getSpecification, intern, internId, isDisposed, isInitialized, readFromXML, setGame, 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, getDefenceModifiers, getDisplayObject, getFeatureContainer, getFreeColObjectClass, getFreeColObjectClassByName, 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, readChild, readChildren, readFromXMLPartial, removeAbilities, removeAbility, removeFeatures, removeModifier, removeModifiers, removePropertyChangeListener, removePropertyChangeListener, save, save, save, save, serialize, serialize, serialize, serialize, setId, toXML, toXML, toXMLPartial, toXMLPartial, writeChildren

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

unit

private Unit unit

The unit to change hands.

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

UnitTradeItem

public UnitTradeItem(Game game,
                     Player source,
                     Player destination,
                     Unit unit)

Creates a new UnitTradeItem instance.

Parameters:

game - The enclosing Game.

source - The source Player.

destination - The destination Player.

unit - The Unit to trade.

UnitTradeItem

public UnitTradeItem(Game game,
                     FreeColXMLReader xr)
              throws javax.xml.stream.XMLStreamException

Creates a new UnitTradeItem instance.

Parameters:

game - The enclosing Game.

xr - The FreeColXMLReader to read from.

Throws:

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

Method Detail

isValid

public boolean isValid()

Is this trade item valid? That is, is the request well formed.

Specified by:

isValid in class TradeItem

Returns:

True if the item is valid.

isUnique

public boolean isUnique()

Is this trade item unique? This is true for the StanceTradeItem and the GoldTradeItem, and false for all others.

Specified by:

isUnique in class TradeItem

Returns:

True if the item is unique.

getLabel

public StringTemplate getLabel()

Get a label for this item.

Specified by:

getLabel in class TradeItem

Returns:

A StringTemplate describing this item.

getUnit

public Unit getUnit()

Get the unit to trade.

Overrides:

getUnit in class TradeItem

Returns:

The Unit to trade.

setUnit

public void setUnit(Unit unit)

Set the unit to trade.

Overrides:

setUnit in class TradeItem

Parameters:

unit - The new Unit to trade.

evaluateFor

public int evaluateFor(Player player)

Evaluate this trade item for a given player.

Specified by:

evaluateFor in class TradeItem

Parameters:

player - The Player to evaluate for.

Returns:

A value for the player, INVALID_TRADE_ITEM for invalid.

copyIn

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

Copy another FreeColObject into this one if it is compatible.

Overrides:

copyIn in class TradeItem

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 TradeItem

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 TradeItem

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 TradeItem

hashCode

public int hashCode()

Overrides:

hashCode in class TradeItem

toString

public java.lang.String toString()

Overrides:

toString in class FreeColObject