net.sf.freecol.common.model
Class Nation

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

public class Nation
extends FreeColGameObjectType

Represents one of the nations present in the game.


Field Summary
static java.lang.String UNKNOWN_NATION_ID
           
 
Fields inherited from class net.sf.freecol.common.model.FreeColObject
ID_ATTRIBUTE_TAG
 
Constructor Summary
Nation()
           
 
Method Summary
 java.lang.String getAnthem()
          Get the Anthem value.
 java.awt.Color getColor()
          Get the Color value.
 Nation getRefNation()
          Get the RefNation value.
 java.lang.String getRulerName()
          Get the RulerName value.
 NationType getType()
          Get the Type value.
 boolean isSelectable()
          Get the Selectable value.
 void readAttributes(javax.xml.stream.XMLStreamReader in, Specification specification)
           
 void setAnthem(java.lang.String newAnthem)
          Set the Anthem value.
 void setColor(java.awt.Color newColor)
          Set the Color value.
 void setRefNation(Nation newRefNation)
          Set the RefNation value.
 void setSelectable(boolean newSelectable)
          Set the Selectable value.
 void setType(NationType newType)
          Set the Type value.
 
Methods inherited from class net.sf.freecol.common.model.FreeColGameObjectType
addAbility, addModifier, getFeatureContainer, getIndex, getModifierSet, hasAbility, hasAbility, readChildren, 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
 

Field Detail

UNKNOWN_NATION_ID

public static java.lang.String UNKNOWN_NATION_ID
Constructor Detail

Nation

public Nation()
Method Detail

getColor

public final java.awt.Color getColor()
Get the Color value.

Returns:
a Color value

setColor

public final void setColor(java.awt.Color newColor)
Set the Color value.

Parameters:
newColor - The new Color value.

getAnthem

public final java.lang.String getAnthem()
Get the Anthem value.

Returns:
a String value

setAnthem

public final void setAnthem(java.lang.String newAnthem)
Set the Anthem value.

Parameters:
newAnthem - The new Anthem value.

getType

public final NationType getType()
Get the Type value.

Returns:
a NationType value

setType

public final void setType(NationType newType)
Set the Type value.

Parameters:
newType - The new Type value.

getRulerName

public final java.lang.String getRulerName()
Get the RulerName value.

Returns:
a String value

isSelectable

public final boolean isSelectable()
Get the Selectable value.

Returns:
a boolean value

getRefNation

public final Nation getRefNation()
Get the RefNation value.

Returns:
a Nation value

setRefNation

public final void setRefNation(Nation newRefNation)
Set the RefNation value.

Parameters:
newRefNation - The new RefNation value.

setSelectable

public final void setSelectable(boolean newSelectable)
Set the Selectable value.

Parameters:
newSelectable - The new Selectable value.

readAttributes

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