Package it.polimi.ingsw.Controller.Actions

Class EndTurnOfActionPhase

java.lang.Object

it.polimi.ingsw.Controller.Actions.PlayerAction

it.polimi.ingsw.Controller.Actions.EndTurnOfActionPhase

All Implemented Interfaces:

Serializable

public class EndTurnOfActionPhase
extends PlayerAction

The Action phase is a lengthy one and its length cannot be determined. This PlayerAction enables the caller to end an Action phase on its own accord.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
EndTurnOfActionPhase(int playerBoardId)	Create a new instance of this class with the following inputs:

Method Summary

Modifier and Type	Method	Description
protected OptionalValue<InputValidationException>	customValidation(List<PlayerAction> history, Model ctx)	This function is used by PlayerAction.validate(List, Model) to check whether or not the declared PlayerAction is possible. This function will check for the following requirements:
void	unsafeExecute(Model ctx)	Every class extending PlayerAction must implement the following method, which takes a Model reference and applies the concrete effect of the action.

Methods inherited from class it.polimi.ingsw.Controller.Actions.PlayerAction

getPlayerBoardID, validate

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

EndTurnOfActionPhase

public EndTurnOfActionPhase(int playerBoardId)

Create a new instance of this class with the following inputs:

Parameters:

playerBoardId - the ID of the current PlayerBoard

Method Details

customValidation

protected OptionalValue<InputValidationException> customValidation(List<PlayerAction> history,
 Model ctx)

This function is used by PlayerAction.validate(List, Model) to check whether or not the declared PlayerAction is possible.
This function will check for the following requirements:

• This action can be called only after having called one and only one ChooseCloudTile action
• The previous PlayerActions must be either ChooseCloudTile or PlayCharacterCard

Specified by:

customValidation in class PlayerAction

Parameters:

history - the controller stores a List of previous PlayerActions related to the player taking the current turn (at every new turn, the history is cleared). Some actions may use this List to check for duplicates.

ctx - a reference to Model. Some actions may use this reference to check for consistency between what the actions declares and what the Model offers.

Returns:

An empty OptionalValue in case of a successful validation. Otherwise the returned OptionalValue contains the related InputValidationException

unsafeExecute

public void unsafeExecute(Model ctx)
                   throws Exception

Description copied from class: PlayerAction

Every class extending PlayerAction must implement the following method, which takes a Model reference and applies the concrete effect of the action.
Warning: this function, as implied by the name, is unsafe. it should never be called by called outside the scope of the class Controller, which takes adequate precautions in order to guarantee a coherent execution of the method.

Specified by:

unsafeExecute in class PlayerAction

Parameters:

ctx - the Model reference, once the method finishes running the game state will be altered.

Throws:

Exception - Should an error occur during the execution of the method, such error will be reported through the thrown Exception. Note that any PlayerAction inheritor should guarantee the absence of Exceptions for any positive return value yielded by PlayerAction.validate(List, Model)