net.sf.freecol.common.model
Class IndianNationType

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

public class IndianNationType
extends NationType

Represents one of the Indian nations present in the game.


Nested Class Summary
static class IndianNationType.AggressionLevel
           
static class IndianNationType.SettlementNumber
           
 
Field Summary
 
Fields inherited from class net.sf.freecol.common.model.FreeColObject
ID_ATTRIBUTE_TAG
 
Constructor Summary
IndianNationType(int index)
          Sole constructor.
 
Method Summary
 IndianNationType.AggressionLevel getAggression()
          Get the Aggression value.
 IndianNationType.SettlementNumber getNumberOfSettlements()
          Get the NumberOfSettlements value.
 java.util.List<java.lang.String> getRegionNames()
          Returns the list of regions in which this tribe my settle.
 java.lang.String getSettlementTypeAsString()
          Describe getSettlementTypeAsString method here.
 java.util.List<RandomChoice<UnitType>> getSkills()
          Returns a list of this Nation's skills.
 Settlement.SettlementType getTypeOfSettlement()
          Get the TypeOfSettlement value.
 boolean isEuropean()
          Returns false.
 boolean isREF()
          Returns false.
 void readAttributes(javax.xml.stream.XMLStreamReader in, Specification specification)
           
 void readChildren(javax.xml.stream.XMLStreamReader in, Specification specification)
           
 void setAggression(IndianNationType.AggressionLevel newAggression)
          Set the Aggression value.
 void setNumberOfSettlements(IndianNationType.SettlementNumber newNumberOfSettlements)
          Set the NumberOfSettlements value.
 void setTypeOfSettlement(Settlement.SettlementType newTypeOfSettlement)
          Set the TypeOfSettlement 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

IndianNationType

public IndianNationType(int index)
Sole constructor.

Method Detail

isEuropean

public boolean isEuropean()
Returns false.

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

isREF

public boolean isREF()
Returns false.

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

getNumberOfSettlements

public final IndianNationType.SettlementNumber getNumberOfSettlements()
Get the NumberOfSettlements value.

Returns:
a SettlementNumber value

setNumberOfSettlements

public final void setNumberOfSettlements(IndianNationType.SettlementNumber newNumberOfSettlements)
Set the NumberOfSettlements value.

Parameters:
newNumberOfSettlements - The new NumberOfSettlements value.

getAggression

public final IndianNationType.AggressionLevel getAggression()
Get the Aggression value.

Returns:
an AggressionLevel value

setAggression

public final void setAggression(IndianNationType.AggressionLevel newAggression)
Set the Aggression value.

Parameters:
newAggression - The new Aggression value.

getTypeOfSettlement

public final Settlement.SettlementType getTypeOfSettlement()
Get the TypeOfSettlement value.

Returns:
an SettlementType value

getSettlementTypeAsString

public final java.lang.String getSettlementTypeAsString()
Describe getSettlementTypeAsString method here.

Returns:
a String value

setTypeOfSettlement

public final void setTypeOfSettlement(Settlement.SettlementType newTypeOfSettlement)
Set the TypeOfSettlement value.

Parameters:
newTypeOfSettlement - The new TypeOfSettlement value.

getRegionNames

public java.util.List<java.lang.String> getRegionNames()
Returns the list of regions in which this tribe my settle.

Returns:
the list of regions in which this tribe my settle.

getSkills

public java.util.List<RandomChoice<UnitType>> getSkills()
Returns a list of this Nation's skills.

Returns:
a list of this Nation's skills.

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