Package net.sf.freecol.common.model

Class ResourceType

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

All Implemented Interfaces:

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

public final class ResourceType
extends FreeColSpecObjectType

The types of resources (e.g. fish bonus) found on a tile.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	MAXIMUM_VALUE_TAG
private int	maxValue	Maximum and minimum values for this resource type.
private static java.lang.String	MINIMUM_VALUE_TAG
private int	minValue	Maximum and minimum values for this resource type.
static java.lang.String	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
ResourceType(java.lang.String id, Specification specification)	Creates a new resource type.

Method Summary

Modifier and Type	Method	Description
<T extends FreeColObject> boolean	copyIn(T other)	Copy another FreeColObject into this one if it is compatible.
GoodsType	getBestGoodsType()	Get the best goods type to make with this resource type.
int	getMaxValue()	Gets the maximum value for this resource.
int	getMinValue()	Gets the minimum value for this resource.
java.lang.String	getXMLTagName()	Get the serialization tag for this object.
protected void	readAttributes(FreeColXMLReader xr)	Reads the attributes of this object from an XML stream.
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, toString, 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

maxValue

private int maxValue

Maximum and minimum values for this resource type.

minValue

private int minValue

Maximum and minimum values for this resource type.

MAXIMUM_VALUE_TAG

private static final java.lang.String MAXIMUM_VALUE_TAG

See Also:

Constant Field Values

MINIMUM_VALUE_TAG

private static final java.lang.String MINIMUM_VALUE_TAG

See Also:

Constant Field Values

Constructor Detail

ResourceType

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

Creates a new resource type.

Parameters:

id - The object identifier.

specification - The Specification to refer to.

Method Detail

getMaxValue

public int getMaxValue()

Gets the maximum value for this resource.

Returns:

The maximum value.

getMinValue

public int getMinValue()

Gets the minimum value for this resource.

Returns:

The minimum value.

getBestGoodsType

public GoodsType getBestGoodsType()

Get the best goods type to make with this resource type.

Returns:

The best GoodsType.

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.