net.sf.freecol.common.model

Class EquipmentType

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColGameObjectType

net.sf.freecol.common.model.BuildableType

net.sf.freecol.common.model.EquipmentType

All Implemented Interfaces:

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

public class EquipmentType
extends BuildableType

This whole class is now @compat 0.10.x. We no longer use equipment types. EquipmentTypes are now subsumed by roles. Delete this whole file in due course. A type of equipment. Equipment differs from goods (although it is often derived from it) in that it must be attached to a unit.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BY_INDIANS_TAG
private static java.lang.String	CAPTURE_EQUIPMENT_TAG
private boolean	captureEquipmentByIndians
private java.lang.String	captureEquipmentId What this equipment type becomes if it is captured by Indians (if captureEquipmentByIndians is true) or Europeans (otherwise).
private static java.lang.String	COMBAT_LOSS_PRIORITY_TAG
private int	combatLossPriority Determines which type of Equipment will be lost first if the Unit carrying it is defeated.
private static java.lang.String	COMPATIBLE_EQUIPMENT_TAG
private java.util.List<java.lang.String>	compatibleEquipment A list containing the object identifiers of equipment types compatible with this one.
private static java.lang.String	MAXIMUM_COUNT_TAG
private int	maximumCount The maximum number of equipment items that can be combined.
private boolean	militaryEquipment Is this military equipment?
static EquipmentType[]	NO_EQUIPMENT
private static java.lang.String	REQUIRED_LOCATION_ABILITY_TAG
private Role	role The default Role of the Unit carrying this type of Equipment.
private static java.lang.String	ROLE_TAG

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

REQUIRED_POPULATION_TAG

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

DELETE_TAG, EXTENDS_TAG, PRESERVE_TAG

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

ARRAY_SIZE_TAG, ID_ATTRIBUTE, ID_ATTRIBUTE_TAG, INFINITY, logger, UNDEFINED, VALUE_TAG

Constructor Summary

Constructors

Constructor and Description
EquipmentType(java.lang.String id, Specification specification) Simple constructor.

Method Summary

Modifier and Type	Method and Description
private void	addCompatibleEquipment(java.lang.String equipmentId) Add a compatible equipment identifier.
boolean	canBeCaptured() Can this equipment type be captured in combat?
boolean	equals(java.lang.Object obj)
EquipmentType	getCaptureEquipment(boolean byIndians) Get the type of equipment to capture, handling the case where Europeans and Indians use different EquipmentTypes for the same underlying goods.
int	getCombatLossPriority() Get the combat loss priority.
int	getMaximumCount() Get the maximum combinable amount of this equipment type.
Role	getRole() Get the role for this equipment type.
static java.lang.String	getXMLElementTagName() Gets the tag name of the root element representing this object.
java.lang.String	getXMLTagName() Gets the tag name used to serialize this object, generally the class name starting with a lower case letter.
int	hashCode()
boolean	isCompatibleWith(EquipmentType otherType) Is this type of equipment compatible with the given type of equipment?
boolean	isMilitaryEquipment() Is this military equiment? (True if it grants an offensive or defensive bonus)
protected void	readAttributes(FreeColXMLReader xr) Reads the attributes of this object from an XML stream.
protected void	readChild(FreeColXMLReader xr) Reads a single child object.
protected void	readChildren(FreeColXMLReader xr) Reads the children of this object from an XML stream.
void	setRole(Role role) Set the role for this equipment type.
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.BuildableType

getCurrentlyBuildingLabel, getLimits, getRequiredAbilities, getRequiredAmountOf, getRequiredGoods, getRequiredPopulation, isAvailableTo, needsGoodsToBuild, requiresAbility, setLimits, setRequiredAbilities, setRequiredPopulation

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

getDescriptionKey, getFeatureContainer, getIndex, getNameKey, isAbstractType, setIndex, toString

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

addAbility, addFeatures, addModifier, addPropertyChangeListener, addPropertyChangeListener, applyModifiers, applyModifiers, applyModifiers, compareIds, compareTo, containsAbilityKey, containsModifierKey, copy, dumpCollection, dumpObject, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAbilities, getAbilities, getAbilities, getAbilities, getDefenceModifiers, getId, getIdNumber, getIdType, getIdType, getModifiers, getModifiers, getModifiers, getModifiers, getPropertyChangeListeners, getPropertyChangeListeners, getSortedAbilities, getSortedCopy, getSortedModifiers, getSpecification, getSuffix, getSuffix, hasAbility, hasAbility, hasAbility, hasListeners, hasModifier, hasModifier, hasModifier, internId, invokeMethod, logFreeColObjects, readFromXML, readFromXMLElement, readFromXMLPartial, readId, removeAbilities, removeAbility, removeFeatures, removeModifier, removeModifiers, removePropertyChangeListener, removePropertyChangeListener, save, save, save, save, serialize, serialize, setId, setSpecification, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, toXMLPartial

Methods inherited from class java.lang.Object

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

Field Detail

NO_EQUIPMENT

public static final EquipmentType[] NO_EQUIPMENT

maximumCount

private int maximumCount

The maximum number of equipment items that can be combined.

combatLossPriority

private int combatLossPriority

Determines which type of Equipment will be lost first if the Unit carrying it is defeated. Horses should be lost before Muskets, for example.

captureEquipmentId

private java.lang.String captureEquipmentId

What this equipment type becomes if it is captured by Indians (if captureEquipmentByIndians is true) or Europeans (otherwise).

captureEquipmentByIndians

private boolean captureEquipmentByIndians

role

private Role role

The default Role of the Unit carrying this type of Equipment.

militaryEquipment

private boolean militaryEquipment

Is this military equipment?

compatibleEquipment

private java.util.List<java.lang.String> compatibleEquipment

A list containing the object identifiers of equipment types compatible with this one.

BY_INDIANS_TAG

private static final java.lang.String BY_INDIANS_TAG

See Also:

Constant Field Values

CAPTURE_EQUIPMENT_TAG

private static final java.lang.String CAPTURE_EQUIPMENT_TAG

See Also:

Constant Field Values

COMBAT_LOSS_PRIORITY_TAG

private static final java.lang.String COMBAT_LOSS_PRIORITY_TAG

See Also:

Constant Field Values

COMPATIBLE_EQUIPMENT_TAG

private static final java.lang.String COMPATIBLE_EQUIPMENT_TAG

See Also:

Constant Field Values

MAXIMUM_COUNT_TAG

private static final java.lang.String MAXIMUM_COUNT_TAG

See Also:

Constant Field Values

ROLE_TAG

private static final java.lang.String ROLE_TAG

See Also:

Constant Field Values

REQUIRED_LOCATION_ABILITY_TAG

private static final java.lang.String REQUIRED_LOCATION_ABILITY_TAG

See Also:

Constant Field Values

Constructor Detail

EquipmentType

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

Simple constructor.

Parameters:

id - The object identifier.

specification - The Specification to refer to.

Method Detail

getMaximumCount

public final int getMaximumCount()

Get the maximum combinable amount of this equipment type.

Returns:

The maximum combinable count.

getCombatLossPriority

public final int getCombatLossPriority()

Get the combat loss priority.

Returns:

The combat loss priority.

canBeCaptured

public boolean canBeCaptured()

Can this equipment type be captured in combat?

Returns:

True if this equipment can be captured.

getCaptureEquipment

public EquipmentType getCaptureEquipment(boolean byIndians)

Get the type of equipment to capture, handling the case where Europeans and Indians use different EquipmentTypes for the same underlying goods.

Parameters:

byIndians - Is the capture by the Indians?

Returns:

The captured EquipmentType.

isCompatibleWith

public boolean isCompatibleWith(EquipmentType otherType)

Is this type of equipment compatible with the given type of equipment?

Parameters:

otherType - The other EquipmentType.

Returns:

True if the equipment is compatible.

addCompatibleEquipment

private void addCompatibleEquipment(java.lang.String equipmentId)

Add a compatible equipment identifier.

Parameters:

equipmentId - The equipment identifier.

getRole

public final Role getRole()

Get the role for this equipment type.

Returns:

The equipment related role.

setRole

public void setRole(Role role)

Set the role for this equipment type.

Parameters:

role - The new equipment related Role.

isMilitaryEquipment

public final boolean isMilitaryEquipment()

Is this military equiment? (True if it grants an offensive or defensive bonus)

Returns:

True if this is military equipment.

hashCode

public int hashCode()

Overrides:

hashCode in class FreeColObject

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class FreeColObject

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 BuildableType

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 BuildableType

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 BuildableType

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 BuildableType

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

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

readChild

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

Reads a single child object. Subclasses must override to read their enclosed elements. This particular instance of the routine always throws XMLStreamException because we should never arrive here. However it is very useful to always call super.readChild() when an unexpected tag is encountered, as the exception thrown here provides some useful debugging context.

Overrides:

readChild in class BuildableType

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

Gets the tag name used to serialize this object, generally the class name starting with a lower case letter.

Specified by:

getXMLTagName in class FreeColObject

Returns:

The tag name for this object.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

Gets the tag name of the root element representing this object.

Returns:

"equipment-type".