rails.game.correct
Class CashCorrectionAction

java.lang.Object
  rails.game.action.PossibleAction
      rails.game.correct.CorrectionAction
          rails.game.correct.CashCorrectionAction

All Implemented Interfaces:

java.io.Serializable

public class CashCorrectionAction
extends CorrectionAction

Correction action that changes the cash position of a cashholder.

Author:

Stefan Frey

See Also:

Serialized Form

Field Summary

static long

serialVersionUID The Constant serialVersionUID.

Fields inherited from class rails.game.correct.CorrectionAction

correctionName, correctionType

Fields inherited from class rails.game.action.PossibleAction

acted, gameManager, log, playerIndex, playerName

Constructor Summary

CashCorrectionAction(Player pl)
Instantiates a new correct cash

CashCorrectionAction(PublicCompanyI pc)
Instantiates a new correct cash

Method Summary

boolean	equalsAsAction(PossibleAction action) Compare the chosen actions of two action objects.
boolean	equalsAsOption(PossibleAction action) Compare the choice options of two action objects, without regard to whatever choice has been made, if any.
int	getAmount()
CashHolder	getCashHolder()
java.lang.String	getCashHolderName()
int	getMaximumNegative()
void	setAmount(int amount)
java.lang.String	toString()

Methods inherited from class rails.game.correct.CorrectionAction

getCorrectionName, getCorrectionType, setCorrectionType

Methods inherited from class rails.game.action.PossibleAction

getCompanyManager, getGameManager, getPlayerIndex, getPlayerName, hasActed, setActed, setPlayerName, toMenu

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

Constructor Detail

CashCorrectionAction

public CashCorrectionAction(Player pl)

Instantiates a new correct cash

Parameters:

pl - Player

CashCorrectionAction

public CashCorrectionAction(PublicCompanyI pc)

Instantiates a new correct cash

Parameters:

pc - Public Company

Method Detail

getCashHolder

public CashHolder getCashHolder()

getCashHolderName

public java.lang.String getCashHolderName()

getMaximumNegative

public int getMaximumNegative()

getAmount

public int getAmount()

setAmount

public void setAmount(int amount)

equalsAsOption

public boolean equalsAsOption(PossibleAction action)

Description copied from class: PossibleAction

Compare the choice options of two action objects, without regard to whatever choice has been made, if any. In other words: only the server-set (prior) attributes must be compared.

This method is used by the server (engine) to validate the incoming action that has actually been chosen in the client (GUI), but only for the purpose to check if the chosen option was really on offer, not to check if the chosen action is actually valid. These perspectives could give different results in cases where the PossibleAction does not fully restrict choices to valid values only (such as the blanket LayTile that does no restrict the hex to lay a tile on, or the SetDividend that will accept any revenue value).

Specified by:

equalsAsOption in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal choice options.

equalsAsAction

public boolean equalsAsAction(PossibleAction action)

Description copied from class: PossibleAction

Compare the chosen actions of two action objects. In other words: the client-set (posterior) attributes must be compared, in addition to those server-set (prior) attributes that sufficiently identify the action.

This method is used by the server (engine) to check if two action objects represent the same actual action, as is done when reloading a saved file (i.e. loading a later stage of the same game).

Specified by:

equalsAsAction in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal selected action values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object