Package net.sf.freecol.server.ai

Class GoodsWish

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.server.ai.AIObject

net.sf.freecol.server.ai.ValuedAIObject

net.sf.freecol.server.ai.Wish

net.sf.freecol.server.ai.GoodsWish

All Implemented Interfaces:

java.lang.Comparable<FreeColObject>, ObjectWithId

public final class GoodsWish
extends Wish

Represents the need for goods within a Colony.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	AMOUNT_REQUESTED_TAG
private int	amountRequested	The amount of goods required.
private static java.lang.String	GOODS_TYPE_TAG
private GoodsType	goodsType	The type of goods required.
private static java.util.logging.Logger	logger
static java.lang.String	TAG
private static java.lang.String	TRANSPORTABLE_TAG

Fields inherited from class net.sf.freecol.server.ai.Wish

destination, transportable

Fields inherited from class net.sf.freecol.server.ai.ValuedAIObject

ascendingValueComparator, descendingValueComparator

Fields inherited from class net.sf.freecol.server.ai.AIObject

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
GoodsWish(AIMain aiMain, java.lang.String id)	Creates a new uninitialized GoodsWish.
GoodsWish(AIMain aiMain, FreeColXMLReader xr)	Creates a new GoodsWish from the given XML-representation.
GoodsWish(AIMain aiMain, Location destination, int value, int amountRequested, GoodsType goodsType)	Creates a new GoodsWish.

Method Summary

Modifier and Type	Method	Description
Constants.IntegrityType	checkIntegrity(boolean fix, LogBuilder lb)	AIObjects need integrity checking too.
boolean	equals(java.lang.Object o)
int	getGoodsAmount()	Gets the amount of goods wished for.
GoodsType	getGoodsType()	Gets the type of goods wished for.
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.
boolean	satisfiedBy(Unit unit)	Does a specified unit satisfy this wish?
<T extends AbstractGoods> boolean	satisfiedBy(T goods)	Does some specified goods satisfy this wish?
void	setGoodsAmount(int amount)	Sets the amount of goods wished for.
void	setInitialized()	Set the initialized flag in this object.
boolean	shouldBeStored()	Checks if this Wish needs to be stored in a savegame.
java.lang.String	toString()
void	update(GoodsType goodsType, int amount, int value)	Updates this GoodsWish with the given attributes.
protected void	writeAttributes(FreeColXMLWriter xw)	Write the attributes of this object to a stream.

Methods inherited from class net.sf.freecol.server.ai.Wish

dispose, getDestination, getDestinationAIColony, getTransportable, setTransportable

Methods inherited from class net.sf.freecol.server.ai.ValuedAIObject

getValue, setValue

Methods inherited from class net.sf.freecol.server.ai.AIObject

addAIObjectWithId, checkIntegrity, copyIn, getAIMain, getGame, getSpecification, isDisposed, 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, getClassIndex, 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, readFromXML, 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

logger

private static final java.util.logging.Logger logger

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

goodsType

private GoodsType goodsType

The type of goods required.

amountRequested

private int amountRequested

The amount of goods required.

AMOUNT_REQUESTED_TAG

private static final java.lang.String AMOUNT_REQUESTED_TAG

See Also:

Constant Field Values

GOODS_TYPE_TAG

private static final java.lang.String GOODS_TYPE_TAG

See Also:

Constant Field Values

TRANSPORTABLE_TAG

private static final java.lang.String TRANSPORTABLE_TAG

See Also:

Constant Field Values

Constructor Detail

GoodsWish

public GoodsWish(AIMain aiMain,
                 java.lang.String id)

Creates a new uninitialized GoodsWish.

Parameters:

aiMain - The main AI-object.

id - The object identifier.

GoodsWish

public GoodsWish(AIMain aiMain,
                 Location destination,
                 int value,
                 int amountRequested,
                 GoodsType goodsType)

Creates a new GoodsWish.

Parameters:

aiMain - The main AI-object.

destination - The Location in which the transportable assigned to this GoodsWish will have to reach.

value - The value identifying the importance of this Wish.

amountRequested - The amount requested.

goodsType - The type of goods needed for releasing this wish completly.

GoodsWish

public GoodsWish(AIMain aiMain,
                 FreeColXMLReader xr)
          throws javax.xml.stream.XMLStreamException

Creates a new GoodsWish from the given XML-representation.

Parameters:

aiMain - The main AI-object.

xr - The input stream containing the XML.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

Method Detail

setInitialized

public void setInitialized()

Set the initialized flag in this object. To be implemented by leaf classes, and called in their constructors plus the special case in readChild below where we resolve forward references.

Specified by:

setInitialized in class AIObject

update

public void update(GoodsType goodsType,
                   int amount,
                   int value)

Updates this GoodsWish with the given attributes.

Parameters:

goodsType - The GoodsType to wish for.

amount - The amount of goods.

value - The urgency of the wish.

shouldBeStored

public boolean shouldBeStored()

Checks if this Wish needs to be stored in a savegame.

Overrides:

shouldBeStored in class Wish

Returns:

True. We always store goods wishes.

getGoodsType

public GoodsType getGoodsType()

Gets the type of goods wished for.

Returns:

The type of goods wished for.

getGoodsAmount

public int getGoodsAmount()

Gets the amount of goods wished for.

Returns:

The amount of goods wished for.

setGoodsAmount

public void setGoodsAmount(int amount)

Sets the amount of goods wished for. Called in AIColony when the colony needs to change the required goods amount.

Parameters:

amount - The new amount of goods wished for.

satisfiedBy

public boolean satisfiedBy(Unit unit)

Does a specified unit satisfy this wish?

Specified by:

satisfiedBy in class Wish

Parameters:

unit - The Unit to test.

Returns:

True if the unit either matches exactly if expertRequired, or at least matches in a land/naval sense if not.

satisfiedBy

public <T extends AbstractGoods> boolean satisfiedBy(T goods)

Does some specified goods satisfy this wish?

Specified by:

satisfiedBy in class Wish

Type Parameters:

T - The base type of the goods.

Parameters:

goods - The goods to test.

Returns:

True if the goods type matches and amount is not less than that requested.

checkIntegrity

public Constants.IntegrityType checkIntegrity(boolean fix,
                                              LogBuilder lb)

AIObjects need integrity checking too.

Overrides:

checkIntegrity in class Wish

Parameters:

fix - If true, fix problems if possible.

lb - A LogBuilder to log to.

Returns:

-1 if there are problems remaining, zero if problems were fixed, +1 if no problems found at all.

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 Wish

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 Wish

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 o)

Overrides:

equals in class Wish

hashCode

public int hashCode()

Overrides:

hashCode in class Wish

toString

public java.lang.String toString()

Overrides:

toString in class FreeColObject