Module edu.ntnu.idatt2001.paths

Package edu.ntnu.idatt2001.paths.models.actions

Class InventoryRemoveAllAction

java.lang.Object

edu.ntnu.idatt2001.paths.models.actions.InventoryRemoveAllAction

All Implemented Interfaces:

Action<String>

public class InventoryRemoveAllAction
extends Object
implements Action<String>

InventoryRemoveAllAction class. Removes items of a player's inventory when executed. Which items to remove is defined when instantiated. All instances of the item are removed. If the item does not exist in the player's inventory, nothing happens.

Version:

0.5 - 29.04.2023

Author:

Carl G. Callum G.

Constructor Summary

Constructors

Constructor	Description
InventoryRemoveAllAction(String item)	Instantiates a new Inventory remove all action and sets the item to remove from the player's inventory.

Method Summary

Modifier and Type	Method	Description
void	execute(Player player)	Executes an action on a player.
String	getValue()	Get method for the action's value.

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryRemoveAllAction

public InventoryRemoveAllAction(String item)
                         throws NullPointerException,
IllegalArgumentException

Instantiates a new Inventory remove all action and sets the item to remove from the player's inventory.

Parameters:

item - String - a non-null and non-empty string representing the item to remove

Throws:

NullPointerException - thrown if the item is null

IllegalArgumentException - thrown if the item is null or only whitespace

Method Details

execute

public void execute(Player player)
             throws NullPointerException

Executes an action on a player. Calls the removeFromInventory method on the player with a set item.

Specified by:

execute in interface Action<String>

Parameters:

player - Player - the player to execute the action on

Throws:

NullPointerException - if player is null

See Also:

• Action.execute(Player)

getValue

public String getValue()

Get method for the action's value.

Specified by:

getValue in interface Action<String>

Returns:

String - the item of the action

See Also:

• Action.getValue()