com.codelanx.codelanxlib.inventory

Class InventoryState

java.lang.Object

com.codelanx.codelanxlib.inventory.InventoryState

Direct Known Subclasses:

PlayerInventoryState

public class InventoryState
extends Object

An immutable class that represents the state of an Inventory

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
InventoryState(Inventory i) Constructor.

Method Summary

Modifier and Type	Method and Description
ItemStack[]	getContents() Deprecated. Returns an array copy, should not be used heavily
ItemStack	getItem(int index) Returns the ItemStack in the given inventory slot
void	setContents(InventoryHolder holder) Sets the contents of this state into an InventoryHolder
int	size() Returns the length of the underlying ItemStack array

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryState

public InventoryState(Inventory i)

Constructor. Copies the contents of the passed inventory

Parameters:

i - The Inventory to copy

Since:

0.1.0

Method Detail

getContents

public ItemStack[] getContents()

Deprecated. Returns an array copy, should not be used heavily

Returns a copy of the underlying array from the inventory contents.

Returns:

A copy of the inventory contents

Since:

0.1.0

getItem

public ItemStack getItem(int index)

Returns the ItemStack in the given inventory slot

Parameters:

index - The index or "slot" to retrieve from

Returns:

The ItemStack in the relevant index

Throws:

ArrayIndexOutOfBoundsException - 0 <= index < size()

Since:

0.1.0

size

public int size()

Returns the length of the underlying ItemStack array

Returns:

The length of the underlying contents array

Since:

0.1.0

setContents

public void setContents(InventoryHolder holder)

Sets the contents of this state into an InventoryHolder

Parameters:

holder - The InventoryHolder to set the contents of

Since:

0.1.0