net.sf.freecol.common.model
Class Tension

java.lang.Object
  extended by net.sf.freecol.common.model.Tension

public class Tension
extends java.lang.Object


Nested Class Summary
static class Tension.Level
          Constants for describing alarm levels.
 
Field Summary
static int ALLIANCE_MODIFIER
           
static int CEASE_FIRE_MODIFIER
           
static int CONTACT_MODIFIER
           
static int DELTA
           
static int DROP_ALLIANCE_MODIFIER
           
static int PEACE_TREATY_MODIFIER
           
static int RESUME_WAR_MODIFIER
           
static int SURRENDERED
          Tension level to set when surrendering.
static int TENSION_ADD_CAPITAL_ATTACKED
           
static int TENSION_ADD_LAND_TAKEN
           
static int TENSION_ADD_MAJOR
           
static int TENSION_ADD_MINOR
           
static int TENSION_ADD_NORMAL
           
static int TENSION_ADD_SETTLEMENT_ATTACKED
           
static int TENSION_ADD_UNIT_DESTROYED
           
static int TENSION_ADD_WAR_INCITER
           
static int TENSION_MAX
           
static int TENSION_MIN
           
private  int value
           
static int WAR_MODIFIER
           
 
Constructor Summary
Tension()
          Constructor.
Tension(int newTension)
           
 
Method Summary
 java.lang.String getKey()
          Gets a string suitable for use in a message id.
 Tension.Level getLevel()
          Get the current tension level.
 int getValue()
          Get the current tension value.
 void modify(int newTension)
          Modify the tension by the given amount.
 void setValue(int newValue)
          Sets the current tension value.
 java.lang.String toString()
          Returns the current tension level as a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TENSION_MIN

public static final int TENSION_MIN
See Also:
Constant Field Values

TENSION_MAX

public static final int TENSION_MAX

DELTA

public static final int DELTA
See Also:
Constant Field Values

TENSION_ADD_MINOR

public static final int TENSION_ADD_MINOR
See Also:
Constant Field Values

TENSION_ADD_NORMAL

public static final int TENSION_ADD_NORMAL
See Also:
Constant Field Values

TENSION_ADD_MAJOR

public static final int TENSION_ADD_MAJOR
See Also:
Constant Field Values

TENSION_ADD_LAND_TAKEN

public static final int TENSION_ADD_LAND_TAKEN
See Also:
Constant Field Values

TENSION_ADD_UNIT_DESTROYED

public static final int TENSION_ADD_UNIT_DESTROYED
See Also:
Constant Field Values

TENSION_ADD_SETTLEMENT_ATTACKED

public static final int TENSION_ADD_SETTLEMENT_ATTACKED
See Also:
Constant Field Values

TENSION_ADD_CAPITAL_ATTACKED

public static final int TENSION_ADD_CAPITAL_ATTACKED
See Also:
Constant Field Values

TENSION_ADD_WAR_INCITER

public static final int TENSION_ADD_WAR_INCITER
See Also:
Constant Field Values

CONTACT_MODIFIER

public static final int CONTACT_MODIFIER
See Also:
Constant Field Values

ALLIANCE_MODIFIER

public static final int ALLIANCE_MODIFIER
See Also:
Constant Field Values

DROP_ALLIANCE_MODIFIER

public static final int DROP_ALLIANCE_MODIFIER
See Also:
Constant Field Values

PEACE_TREATY_MODIFIER

public static final int PEACE_TREATY_MODIFIER
See Also:
Constant Field Values

CEASE_FIRE_MODIFIER

public static final int CEASE_FIRE_MODIFIER
See Also:
Constant Field Values

WAR_MODIFIER

public static final int WAR_MODIFIER

RESUME_WAR_MODIFIER

public static final int RESUME_WAR_MODIFIER
See Also:
Constant Field Values

SURRENDERED

public static final int SURRENDERED
Tension level to set when surrendering.


value

private int value
Constructor Detail

Tension

public Tension()
Constructor.


Tension

public Tension(int newTension)
Method Detail

getValue

public int getValue()
Get the current tension value.

Returns:
The value of this Tension.

setValue

public void setValue(int newValue)
Sets the current tension value.

Parameters:
newValue - The new value of the tension.

getLevel

public Tension.Level getLevel()
Get the current tension level.

Returns:
The current level.

modify

public void modify(int newTension)
Modify the tension by the given amount.

Parameters:
newTension - The amount to modify tension by.

getKey

public java.lang.String getKey()
Gets a string suitable for use in a message id.

Returns:
A message id string.

toString

public java.lang.String toString()
Returns the current tension level as a string.

Overrides:
toString in class java.lang.Object
Returns:
A String-representation of the current tension level.