Package it.polimi.ingsw.Model

Class CharacterCardInput

java.lang.Object

it.polimi.ingsw.Model.CharacterCardInput

All Implemented Interfaces:

Serializable

public class CharacterCardInput
extends Object
implements Serializable

Each CharacterCard can use many input parameters. This class serves as a way to group all possible inputs and edit them in a safe, coherent way.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final PlayerBoard	caller
private static final long	serialVersionUID
private Island	targetIsland
private PawnColour	targetPawn
private List<Pair<PawnColour,PawnColour>>	targetPawnPairs

Constructor Summary

Constructors

Constructor	Description
CharacterCardInput(PlayerBoard caller)	Constructor for the base input of the card.

Method Summary

Modifier and Type	Method	Description
PlayerBoard	getCaller()
OptionalValue<Island>	getTargetIsland()
OptionalValue<PawnColour>	getTargetPawn()
OptionalValue<List<Pair<PawnColour,PawnColour>>>	getTargetPawnPairs()
void	setTargetIsland(Island targetIsland)
void	setTargetPawn(PawnColour targetPawn)
void	setTargetPawnPairs(List<Pair<PawnColour,PawnColour>> targetPawnPairs)	Note: the convention of the Pair is to be verified through the card that requires the input.

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

caller

private final PlayerBoard caller

targetIsland

private Island targetIsland

targetPawn

private PawnColour targetPawn

targetPawnPairs

private List<Pair<PawnColour,PawnColour>> targetPawnPairs

Constructor Details

CharacterCardInput

public CharacterCardInput(PlayerBoard caller)

Constructor for the base input of the card.

Parameters:

caller - each card requires the caller's PlayerBoard as an input.

Method Details

getCaller

public PlayerBoard getCaller()

Returns:

the caller's PlayerBoard

getTargetIsland

public OptionalValue<Island> getTargetIsland()

Returns:

the Island set as a target. The value is wrapped in a OptionalValue, as the related input is not compulsory

setTargetIsland

public void setTargetIsland(Island targetIsland)

Parameters:

targetIsland - the Island to set as a target

getTargetPawn

public OptionalValue<PawnColour> getTargetPawn()

Returns:

the PawnColour set as a target. The value is wrapped in a OptionalValue, as the related input is not compulsory

setTargetPawn

public void setTargetPawn(PawnColour targetPawn)

Parameters:

targetPawn - the PawnColour to set as a target

getTargetPawnPairs

public OptionalValue<List<Pair<PawnColour,PawnColour>>> getTargetPawnPairs()

Returns:

the the List of Pairs of PawnColour set as a target. The value is wrapped in a OptionalValue, as the related input is not compulsory

setTargetPawnPairs

public void setTargetPawnPairs(List<Pair<PawnColour,PawnColour>> targetPawnPairs)

Note: the convention of the Pair is to be verified through the card that requires the input.

Parameters:

targetPawnPairs - the List of Pairs of PawnColour to set as a target.