Package org.progettoedids.util

Class Inventory

java.lang.Object

org.progettoedids.util.Inventory

public class Inventory
extends Object

The Inventory class is essentially a container of Item(s) with a maximum capacity.

Some methods are provided to add, get or remove Item(s) from the Inventory. It's not allowed to add an Item whose weight will cause the Inventory's held weight of all the Item(s) to exceed the maximum capacity.

Constructor Summary

Constructors

Constructor	Description
Inventory(int maxWeight)	Initializes an Inventory.

Method Summary

Modifier and Type	Method	Description
void	addItem(Item item)	Adds the specified Item to the Inventory, if its addition doesn't exceed maximum capacity.
boolean	canAdd(Item item)	Checks whether it's possible to add an Item based on the current weight held in the Inventory and the weight of the Item specified.
Item	exchange(Item itemToReceive, UUID itemToGiveUUID)
Item	getItem(UUID itemUUID)	Returns the Item matching the specified UUID
Item	getItemByName(String itemName)
Item[]	getItems()	Returns an array of Item(s) held in the Inventory
<T> Item[]	getItems(Class<T> itemClass)
int	getMaxWeight()
int	getWeightOfAllItems()	Returns the sum of the weight of all the Item(s) held in the Inventory
boolean	hasItem(UUID itemUUID)	Check whether the Item with the specified UUID is present in the Inventory
boolean	isEmpty()
void	printInventory()
<T> void	printInventory(Class<T> itemClass)
Item	removeItem(UUID itemUUID)	Removes an Item from the Inventory

Methods inherited from class java.lang.Object

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

Constructor Details

Inventory

public Inventory(int maxWeight)

Initializes an Inventory.

Parameters:

maxWeight - an integer representing the maximum allowed weight. Must be positive or zero

Throws:

IllegalArgumentException - if the maximum weight is negative

Method Details

getItem

public Item getItem(UUID itemUUID)

Returns the Item matching the specified UUID

Parameters:

itemUUID - the UUID of the Item to lookup. Must not be null

Returns:

the Item matching the UUID or null if not found

getItemByName

public Item getItemByName(String itemName)

getItems

public Item[] getItems()

Returns an array of Item(s) held in the Inventory

Returns:

an array of Item, can be empty

getItems

public <T> Item[] getItems(Class<T> itemClass)

canAdd

public boolean canAdd(Item item)

Checks whether it's possible to add an Item based on the current weight held in the Inventory and the weight of the Item specified.

If the weight of the Item plus the current held weight exceeds the maximum capacity false will be returned.

Parameters:

item - an Item. Must not be null

Returns:

true if the Item can fit in the Inventory, false otherwise

addItem

public void addItem(Item item)

Adds the specified Item to the Inventory, if its addition doesn't exceed maximum capacity.

Parameters:

item - an Item. Must not be null

removeItem

public Item removeItem(UUID itemUUID)

Removes an Item from the Inventory

Parameters:

itemUUID - the UUID of an Item to remove. Must not be null

Returns:

the removed Item if present, null otherwise

hasItem

public boolean hasItem(UUID itemUUID)

Check whether the Item with the specified UUID is present in the Inventory

Parameters:

itemUUID - the UUID of an Item. Must not be null

Returns:

true if the UUID was found in the Inventory, false otherwise

getWeightOfAllItems

public int getWeightOfAllItems()

Returns the sum of the weight of all the Item(s) held in the Inventory

Returns:

an integer representing the weight of all the Item(s) held

getMaxWeight

public int getMaxWeight()

exchange

public Item exchange(Item itemToReceive,
 UUID itemToGiveUUID)

isEmpty

public boolean isEmpty()

printInventory

public void printInventory()

printInventory

public <T> void printInventory(Class<T> itemClass)