net.sf.freecol.common.model

Class FreeColGameObjectType

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColGameObjectType

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildableType, Disaster, Effect, Event, FoundingFather, GoodsType, Limit, Nation, NationType, ResourceType, SettlementType, Specification.Source, TileImprovementType, TileType

public abstract class FreeColGameObjectType
extends FreeColObject
implements Named

The base class for all types defined by the specification. It can be instantiated in order to provide a source for modifiers and abilities that are provided by the code rather than defined in the specification, such as the "artillery in the open" penalty. In general, a FreeColGameObjectType does not need a reference to the specification. However, if it has attributes or children that are themselves FreeColGameObjectTypes, then the specification must be set before the type is de-serialized, otherwise the identifiers can not be resolved. FreeColGameObjectTypes can be abstract. Abstract types can be used to derive other types, but can not be instantiated. They will be removed from the Specification after it has loaded completely.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ABSTRACT_TAG
private boolean	abstractType Whether the type is abstract, or can be instantiated.
protected static java.lang.String	DELETE_TAG
static java.lang.String	EXTENDS_TAG
private FeatureContainer	featureContainer The features of this game object type.
private int	index The index imposes a total ordering consistent with equals on each class extending FreeColGameObjectType, but this ordering is nothing but the order in which the objects of the respective class were defined.
static java.lang.String	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

Modifier	Constructor and Description
protected	FreeColGameObjectType() Deliberately empty constructor.
	FreeColGameObjectType(Specification specification) Create a FreeColGameObjectType with a given specification but no object identifier.
	FreeColGameObjectType(java.lang.String id) Create a simple FreeColGameObjectType without a specification.
	FreeColGameObjectType(java.lang.String id, Specification specification) Create a FreeColGameObjectType with a given identifier and specification.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescriptionKey() Gets a string suitable for looking up the description of this object in Messages.
FeatureContainer	getFeatureContainer() Gets the feature container.
protected int	getIndex() Gets the index of this FreeColGameObjectType.
java.lang.String	getNameKey() Gets the name of this named object.
boolean	isAbstractType() Is this an abstract type?
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.
protected void	setIndex(int index) Sets the index of this FreeColGameObjectType.
java.lang.String	toString()
protected void	writeChildren(FreeColXMLWriter xw) Write the children of this object to a stream.

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, equals, 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, getXMLElementTagName, getXMLTagName, hasAbility, hasAbility, hasAbility, hashCode, 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, writeAttributes

Methods inherited from class java.lang.Object

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

Field Detail

abstractType

private boolean abstractType

Whether the type is abstract, or can be instantiated.

featureContainer

private FeatureContainer featureContainer

The features of this game object type. Feature containers are created on demand.

index

private int index

The index imposes a total ordering consistent with equals on each class extending FreeColGameObjectType, but this ordering is nothing but the order in which the objects of the respective class were defined. It is guaranteed to remain stable only for a particular revision of a particular specification.

ABSTRACT_TAG

private static final java.lang.String ABSTRACT_TAG

See Also:

Constant Field Values

DELETE_TAG

protected static final java.lang.String DELETE_TAG

See Also:

Constant Field Values

EXTENDS_TAG

public static final java.lang.String EXTENDS_TAG

See Also:

Constant Field Values

PRESERVE_TAG

public static final java.lang.String PRESERVE_TAG

See Also:

Constant Field Values

Constructor Detail

FreeColGameObjectType

protected FreeColGameObjectType()

Deliberately empty constructor.

FreeColGameObjectType

public FreeColGameObjectType(java.lang.String id)

Create a simple FreeColGameObjectType without a specification.

Parameters:

id - The object identifier.

FreeColGameObjectType

public FreeColGameObjectType(Specification specification)

Create a FreeColGameObjectType with a given specification but no object identifier.

Parameters:

specification - The Specification to refer to.

FreeColGameObjectType

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

Create a FreeColGameObjectType with a given identifier and specification.

Parameters:

id - The object identifier.

specification - The Specification to refer to.

Method Detail

getFeatureContainer

public final FeatureContainer getFeatureContainer()

Gets the feature container.

Overrides:

getFeatureContainer in class FreeColObject

Returns:

The FeatureContainer.

getIndex

protected int getIndex()

Gets the index of this FreeColGameObjectType. The index imposes a total ordering consistent with equals on each class extending FreeColGameObjectType, but this ordering is nothing but the order in which the objects of the respective class were defined. It is guaranteed to remain stable only for a particular revision of a particular specification.

Returns:

The game object index.

setIndex

protected final void setIndex(int index)

Sets the index of this FreeColGameObjectType.

Parameters:

index - The new index value.

getDescriptionKey

public final java.lang.String getDescriptionKey()

Gets a string suitable for looking up the description of this object in Messages.

Returns:

A description key.

isAbstractType

public final boolean isAbstractType()

Is this an abstract type?

Returns:

True if this is an abstract game object type.

getNameKey

public final java.lang.String getNameKey()

Gets the name of this named object. Try to avoid using this directly except in i18n-related routines or to implement itself in more complext objects.

Specified by:

getNameKey in interface Named

Returns:

The name of the Named.

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

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 FreeColObject

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 FreeColObject

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

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

toString

public java.lang.String toString()

Overrides:

toString in class FreeColObject