net.sf.freecol.common.model
Class HighScore

java.lang.Object
  extended by net.sf.freecol.common.model.FreeColObject
      extended by net.sf.freecol.common.model.HighScore

public class HighScore
extends FreeColObject


Nested Class Summary
static class HighScore.Level
          On retirement, an object will be named in honour of the player.
 
Field Summary
 
Fields inherited from class net.sf.freecol.common.model.FreeColObject
ID_ATTRIBUTE_TAG
 
Constructor Summary
HighScore(org.w3c.dom.Element element)
           
HighScore(Player player, java.util.Date theDate)
           
HighScore(javax.xml.stream.XMLStreamReader in)
           
 
Method Summary
 int getColonies()
          Get the Colonies value.
 java.util.Date getDate()
          Get the Date value.
 java.lang.String getDifficulty()
          Get the Difficulty value.
 int getIndependenceTurn()
          Get the IndependenceTurn value.
 HighScore.Level getLevel()
          Get the Level value.
 java.lang.String getNationID()
          Get the NationID value.
 java.lang.String getNationName()
          Get the NationName value.
 java.lang.String getNationTypeID()
          Get the NationTypeID value.
 java.lang.String getNewLandName()
          Get the NewLandName value.
 java.lang.String getOldNationName()
          Get the Nation's localized name.
 java.lang.String getPlayerName()
          Get the PlayerName value.
 int getRetirementTurn()
          Get the RetirementTurn value.
 int getScore()
          Get the Score value.
 int getUnits()
          Get the Units value.
static java.lang.String getXMLElementTagName()
          Returns the tag name of the root element representing this object.
 void setColonies(int newColonies)
          Set the Colonies value.
 void setDate(java.util.Date newDate)
          Set the Date value.
 void setDifficulty(java.lang.String newDifficulty)
          Set the Difficulty value.
 void setIndependenceTurn(int newIndependenceTurn)
          Set the IndependenceTurn value.
 void setLevel(HighScore.Level newLevel)
          Set the Level value.
 void setNationID(java.lang.String newNationID)
          Set the NationID value.
 void setNationName(java.lang.String newNationName)
          Set the NationName value.
 void setNationTypeID(java.lang.String newNationTypeID)
          Set the NationTypeID value.
 void setNewLandName(java.lang.String newNewLandName)
          Set the NewLandName value.
 void setPlayerName(java.lang.String newPlayerName)
          Set the PlayerName value.
 void setRetirementTurn(int newRetirementTurn)
          Set the RetirementTurn value.
 void setScore(int newScore)
          Set the Score value.
 void setUnits(int newUnits)
          Set the Units value.
 
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, hasAbility, 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, toString, wait, wait, wait
 

Constructor Detail

HighScore

public HighScore(Player player,
                 java.util.Date theDate)

HighScore

public HighScore(javax.xml.stream.XMLStreamReader in)
          throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

HighScore

public HighScore(org.w3c.dom.Element element)
          throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException
Method Detail

getIndependenceTurn

public final int getIndependenceTurn()
Get the IndependenceTurn value.

Returns:
an int value

setIndependenceTurn

public final void setIndependenceTurn(int newIndependenceTurn)
Set the IndependenceTurn value.

Parameters:
newIndependenceTurn - The new IndependenceTurn value.

getRetirementTurn

public final int getRetirementTurn()
Get the RetirementTurn value.

Returns:
an int value

setRetirementTurn

public final void setRetirementTurn(int newRetirementTurn)
Set the RetirementTurn value.

Parameters:
newRetirementTurn - The new RetirementTurn value.

getPlayerName

public final java.lang.String getPlayerName()
Get the PlayerName value.

Returns:
a String value

setPlayerName

public final void setPlayerName(java.lang.String newPlayerName)
Set the PlayerName value.

Parameters:
newPlayerName - The new PlayerName value.

getNationID

public final java.lang.String getNationID()
Get the NationID value.

Returns:
a String value

setNationID

public final void setNationID(java.lang.String newNationID)
Set the NationID value.

Parameters:
newNationID - The new NationID value.

getNationTypeID

public final java.lang.String getNationTypeID()
Get the NationTypeID value.

Returns:
a String value

setNationTypeID

public final void setNationTypeID(java.lang.String newNationTypeID)
Set the NationTypeID value.

Parameters:
newNationTypeID - The new NationTypeID value.

getScore

public final int getScore()
Get the Score value.

Returns:
an int value

setScore

public final void setScore(int newScore)
Set the Score value.

Parameters:
newScore - The new Score value.

getLevel

public final HighScore.Level getLevel()
Get the Level value.

Returns:
a Level value

setLevel

public final void setLevel(HighScore.Level newLevel)
Set the Level value.

Parameters:
newLevel - The new Level value.

getOldNationName

public final java.lang.String getOldNationName()
Get the Nation's localized name.

Returns:
a String value

getNationName

public final java.lang.String getNationName()
Get the NationName value.

Returns:
a String value

setNationName

public final void setNationName(java.lang.String newNationName)
Set the NationName value.

Parameters:
newNationName - The new NationName value.

getNewLandName

public final java.lang.String getNewLandName()
Get the NewLandName value.

Returns:
a String value

setNewLandName

public final void setNewLandName(java.lang.String newNewLandName)
Set the NewLandName value.

Parameters:
newNewLandName - The new NewLandName value.

getDifficulty

public final java.lang.String getDifficulty()
Get the Difficulty value.

Returns:
a String value

setDifficulty

public final void setDifficulty(java.lang.String newDifficulty)
Set the Difficulty value.

Parameters:
newDifficulty - The new Difficulty value.

getUnits

public final int getUnits()
Get the Units value.

Returns:
an int value

setUnits

public final void setUnits(int newUnits)
Set the Units value.

Parameters:
newUnits - The new Units value.

getColonies

public final int getColonies()
Get the Colonies value.

Returns:
an int value

setColonies

public final void setColonies(int newColonies)
Set the Colonies value.

Parameters:
newColonies - The new Colonies value.

getDate

public final java.util.Date getDate()
Get the Date value.

Returns:
a Date value

setDate

public final void setDate(java.util.Date newDate)
Set the Date value.

Parameters:
newDate - The new Date value.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()
Returns the tag name of the root element representing this object.

Returns:
the tag name.