net.sf.freecol.common.model
Class EuropeanNationType

java.lang.Object
  extended by net.sf.freecol.common.model.FreeColObject
      extended by net.sf.freecol.common.model.FreeColGameObjectType
          extended by net.sf.freecol.common.model.NationType
              extended by net.sf.freecol.common.model.EuropeanNationType

public class EuropeanNationType
extends NationType

Represents one of the European nations present in the game, i.e. both REFs and possible human players.


Field Summary
 
Fields inherited from class net.sf.freecol.common.model.FreeColObject
ID_ATTRIBUTE_TAG
 
Constructor Summary
EuropeanNationType(int index)
          Constructor.
 
Method Summary
 java.lang.String getEuropeName()
          Returns the name of this Nation's Home Port.
 java.lang.String getREFName()
          Returns the name of this Nation's REF.
 java.util.List<AbstractUnit> getStartingUnits()
          Returns a list of this Nation's starting units.
 boolean isEuropean()
          Returns true.
 boolean isREF()
          Get the REF value.
 void readAttributes(javax.xml.stream.XMLStreamReader in, Specification specification)
           
 void readChildren(javax.xml.stream.XMLStreamReader in, Specification specification)
           
 void setREF(boolean newREF)
          Set the REF value.
 
Methods inherited from class net.sf.freecol.common.model.NationType
getCapitalRadius, getSettlementRadius, setCapitalRadius, setSettlementRadius
 
Methods inherited from class net.sf.freecol.common.model.FreeColGameObjectType
addAbility, addModifier, getFeatureContainer, getIndex, getModifierSet, hasAbility, hasAbility, readFromXML, setFeatureContainer, setIndex, toString
 
Methods inherited from class net.sf.freecol.common.model.FreeColObject
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAttribute, getAttribute, getAttribute, getAttribute, getId, getPropertyChangeListeners, getPropertyChangeListeners, getXMLElementTagName, hasAttribute, hasListeners, readFromXML, readFromXMLElement, removePropertyChangeListener, removePropertyChangeListener, toXML, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, writeAttribute, writeFreeColGameObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EuropeanNationType

public EuropeanNationType(int index)
Constructor.

Method Detail

getEuropeName

public java.lang.String getEuropeName()
Returns the name of this Nation's Home Port.

Returns:
a String value

getREFName

public java.lang.String getREFName()
Returns the name of this Nation's REF.

Returns:
a String value

isREF

public final boolean isREF()
Get the REF value.

Specified by:
isREF in class NationType
Returns:
a boolean value

setREF

public final void setREF(boolean newREF)
Set the REF value.

Parameters:
newREF - The new REF value.

isEuropean

public boolean isEuropean()
Returns true.

Specified by:
isEuropean in class NationType
Returns:
a boolean value

getStartingUnits

public java.util.List<AbstractUnit> getStartingUnits()
Returns a list of this Nation's starting units.

Returns:
a list of this Nation's starting units.

readAttributes

public void readAttributes(javax.xml.stream.XMLStreamReader in,
                           Specification specification)
                    throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

readChildren

public void readChildren(javax.xml.stream.XMLStreamReader in,
                         Specification specification)
                  throws javax.xml.stream.XMLStreamException
Overrides:
readChildren in class FreeColGameObjectType
Throws:
javax.xml.stream.XMLStreamException