Package alexiil.mc.lib.attributes.item.impl

Enum Class EmptyGroupedItemInv

java.lang.Object

java.lang.Enum<EmptyGroupedItemInv>

alexiil.mc.lib.attributes.item.impl.EmptyGroupedItemInv

All Implemented Interfaces:

AbstractItemInvView, GroupedItemInv, GroupedItemInvView, ItemExtractable, ItemInsertable, ItemTransferable, LimitedConsumer<net.minecraft.item.ItemStack>, NullVariant, Serializable, Comparable<EmptyGroupedItemInv>, Constable

public enum EmptyGroupedItemInv
extends Enum<EmptyGroupedItemInv>
implements GroupedItemInv, NullVariant

GroupedItemInvView for an empty inventory.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.item.AbstractItemInvView

AbstractItemInvView.DefaultChangeTracker

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.item.GroupedItemInvView

GroupedItemInvView.ItemInvStatistic

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
ListenerToken	addListener(InvMarkDirtyListener listener, ListenerRemovalToken removalToken)	Adds the given listener to this inventory, such that InvMarkDirtyListener.onMarkDirty(AbstractItemInvView) will be called every time that any stored stack is changed (either from FixedItemInv.setInvStack(int, ItemStack, Simulation) or FixedItemInv.ModifiableFixedItemInv.markDirty()).
ListenerToken	addListener(ItemInvAmountChangeListener listener, ListenerRemovalToken removalToken)	Adds the given listener to this inventory, such that the ItemInvAmountChangeListener.onChange(GroupedItemInvView, ItemStack, int, int) will be called every time that this inventory changes.
net.minecraft.item.ItemStack	attemptAnyExtraction(int maxAmount, Simulation simulation)	Calls attemptExtraction() with an ItemFilter of ConstantItemFilter.ANYTHING.
net.minecraft.item.ItemStack	attemptExtraction(ItemFilter filter, int maxAmount, Simulation simulation)	Attempt to extract *any* ItemStack from this that matches the given ItemFilter.
net.minecraft.item.ItemStack	attemptInsertion(net.minecraft.item.ItemStack stack, Simulation simulation)	Inserts the given stack into this insertable, and returns the excess.
int	getAmount(ItemFilter filter)
int	getAmount(net.minecraft.item.ItemStack stack)
int	getCapacity(net.minecraft.item.ItemStack stack)
int	getChangeValue()
GroupedItemInvView	getGroupedView()
ItemFilter	getInsertionFilter()	Returns an ItemFilter to determine if ItemInsertable.attemptInsertion(ItemStack, Simulation) will accept a stack.
ItemExtractable	getPureExtractable()
ItemInsertable	getPureInsertable()
int	getSpace(net.minecraft.item.ItemStack stack)
GroupedItemInvView.ItemInvStatistic	getStatistics(ItemFilter filter)
Set<net.minecraft.item.ItemStack>	getStoredStacks()
int	getTotalCapacity()
String	toString()
static EmptyGroupedItemInv	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmptyGroupedItemInv[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface alexiil.mc.lib.attributes.item.GroupedItemInv

createLimitedGroupedInv, filtered

Methods inherited from interface alexiil.mc.lib.attributes.item.GroupedItemInvView

getStatistics, isEmpty

Methods inherited from interface alexiil.mc.lib.attributes.item.ItemExtractable

couldExtractAnything, extract, extract, extract

Methods inherited from interface alexiil.mc.lib.attributes.item.ItemInsertable

insert, offer, offer, wouldAccept, wouldPartiallyAccept

Enum Constant Details

INSTANCE

public static final EmptyGroupedItemInv INSTANCE

Method Details

values

public static EmptyGroupedItemInv[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EmptyGroupedItemInv valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getStatistics

public GroupedItemInvView.ItemInvStatistic getStatistics(ItemFilter filter)

Specified by:

getStatistics in interface GroupedItemInvView

Parameters:

filter - The filter to check on.

Returns:

Statistics about the currently stored amount, capacity, and space for everything that matches the given filter.

getStoredStacks

public Set<net.minecraft.item.ItemStack> getStoredStacks()

Specified by:

getStoredStacks in interface GroupedItemInvView

Returns:

a set containing all of the ItemStack's that are stored in the inventory. NOTE: This must return a set using one of the Hash.Strategy's in ItemStackCollections otherwise comparison methods won't work correctly!

getAmount

public int getAmount(ItemFilter filter)

Specified by:

getAmount in interface GroupedItemInvView

Returns:

A count of all the ItemStack's that match the given filter.

getAmount

public int getAmount(net.minecraft.item.ItemStack stack)

Specified by:

getAmount in interface GroupedItemInvView

Parameters:

stack - The stack to check for. Cannot be empty.

Returns:

The total amount of the given stack that is stored in this inventory.

getCapacity

public int getCapacity(net.minecraft.item.ItemStack stack)

Specified by:

getCapacity in interface GroupedItemInvView

Parameters:

stack - The stack to check for. Must not be empty.

Returns:

The total space that is available (right now!) to store the given stack.

getSpace

public int getSpace(net.minecraft.item.ItemStack stack)

Specified by:

getSpace in interface GroupedItemInvView

Returns:

The total space that could store the given stack, not including space that is currently taken up by the stack (so this should change with GroupedItemInvView.getAmount(ItemFilter)).

getTotalCapacity

public int getTotalCapacity()

Specified by:

getTotalCapacity in interface GroupedItemInvView

Returns:

The total capacity for every ItemStack that can be stored in this inventory.

NOTE: This value might not be equal to the sum of GroupedItemInvView.getCapacity(ItemStack) over GroupedItemInvView.getStoredStacks()!

getInsertionFilter

public ItemFilter getInsertionFilter()

Description copied from interface: ItemInsertable

Returns an ItemFilter to determine if ItemInsertable.attemptInsertion(ItemStack, Simulation) will accept a stack. The default implementation is a call to attemptInsertion(stack, Simulation.SIMULATE), and it is only useful to override this if the resulting filter contains information that might be usable by the caller.

Specified by:

getInsertionFilter in interface ItemInsertable

Returns:

A filter to determine if ItemInsertable.attemptInsertion(ItemStack, Simulation) will accept the entirety of a given stack.

attemptInsertion

public net.minecraft.item.ItemStack attemptInsertion(net.minecraft.item.ItemStack stack,
 Simulation simulation)

Description copied from interface: ItemInsertable

Inserts the given stack into this insertable, and returns the excess.

Specified by:

attemptInsertion in interface ItemInsertable

Parameters:

stack - The incoming stack. Must not be modified by this call.

simulation - If Simulation.SIMULATE then this shouldn't modify anything.

Returns:

the excess ItemStack that wasn't accepted. This will be independent of this insertable, however it might be the given stack instead of a completely new object.

attemptAnyExtraction

public net.minecraft.item.ItemStack attemptAnyExtraction(int maxAmount,
 Simulation simulation)

Description copied from interface: ItemExtractable

Calls attemptExtraction() with an ItemFilter of ConstantItemFilter.ANYTHING.

Specified by:

attemptAnyExtraction in interface ItemExtractable

attemptExtraction

public net.minecraft.item.ItemStack attemptExtraction(ItemFilter filter,
 int maxAmount,
 Simulation simulation)

Description copied from interface: ItemExtractable

Attempt to extract *any* ItemStack from this that matches the given ItemFilter.

Specified by:

attemptExtraction in interface ItemExtractable

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

simulation - If Simulation.SIMULATE then this should return the same result that a call with Simulation.ACTION would do, but without modifying anything else.

Returns:

A new, independent ItemStack that was extracted.

addListener

public ListenerToken addListener(ItemInvAmountChangeListener listener,
 ListenerRemovalToken removalToken)

Description copied from interface: GroupedItemInvView

Adds the given listener to this inventory, such that the ItemInvAmountChangeListener.onChange(GroupedItemInvView, ItemStack, int, int) will be called every time that this inventory changes. However if this inventory doesn't support listeners then this will return a null token.

The default implementation refuses to accept any listeners, but implementations are highly encouraged to override this if they are able to!

Specified by:

addListener in interface GroupedItemInvView

removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).

Returns:

A token that represents the listener, or null if the listener could not be added.

getChangeValue

public int getChangeValue()

Specified by:

getChangeValue in interface AbstractItemInvView

Returns:

A value that indicates whether an inventory might have changed if it differs from the last value returned. This number doesn't have to start at 0, but it must change every time that the inventory is changed, although it can change even without any observable changes to this inventory.

Inventories that don't support this might increment the change number every time that this is called - so you should never write a loop that depends on the returned value settling down on a particular value.

Inventories that support listeners highly encouraged to support this - by definition if an inventory knows when it changed then it should be able to count the number of changes. It is also implied that any changes to this value will also invoke every registered InvMarkDirtyListener.

The default implementation returns an ever-increasing value.

addListener

public ListenerToken addListener(InvMarkDirtyListener listener,
 ListenerRemovalToken removalToken)

Description copied from interface: AbstractItemInvView

Adds the given listener to this inventory, such that InvMarkDirtyListener.onMarkDirty(AbstractItemInvView) will be called every time that any stored stack is changed (either from FixedItemInv.setInvStack(int, ItemStack, Simulation) or FixedItemInv.ModifiableFixedItemInv.markDirty()).

If the listener is registered (and thus this returns null) then it implies that AbstractItemInvView.getChangeValue() will change every time that the given listener is invoked, always just-before it is invoked.

The default implementation refuses to accept any listeners, but implementations are highly encouraged to override this if they are able to!

Specified by:

addListener in interface AbstractItemInvView

Specified by:

addListener in interface GroupedItemInvView

removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).

Returns:

A token that represents the listener, or null if the listener could not be added.

getGroupedView

public GroupedItemInvView getGroupedView()

Specified by:

getGroupedView in interface GroupedItemInvView

Returns:

A completely unmodifiable view of this GroupedItemInvView.

getPureInsertable

public ItemInsertable getPureInsertable()

Specified by:

getPureInsertable in interface ItemInsertable

Returns:

An object that only implements ItemInsertable, and does not expose any of the other modification methods that sibling or subclasses offer (like ItemExtractable or GroupedItemInv.

getPureExtractable

public ItemExtractable getPureExtractable()

Specified by:

getPureExtractable in interface ItemExtractable

Returns:

An object that only implements ItemExtractable, and does not expose any of the other modification methods that sibling or subclasses offer (like ItemInsertable or GroupedItemInv.

toString

public String toString()

Overrides:

toString in class Enum<EmptyGroupedItemInv>