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

Enum EmptyItemTransferable

java.lang.Object

java.lang.Enum<EmptyItemTransferable>

alexiil.mc.lib.attributes.item.impl.EmptyItemTransferable

All Implemented Interfaces:

ItemExtractable, ItemInsertable, ItemTransferable, LimitedConsumer<net.minecraft.item.ItemStack>, NullVariant, java.io.Serializable, java.lang.Comparable<EmptyItemTransferable>, java.lang.constant.Constable

public enum EmptyItemTransferable
extends java.lang.Enum<EmptyItemTransferable>
implements ItemTransferable, NullVariant

An ItemTransferable that never returns any items from attemptExtraction(ItemFilter, int, Simulation), nor accepts any items in attemptInsertion(ItemStack, Simulation).

Nested Class Summary

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

java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROLLER	An ItemTransferable that informs callers that it will interact with a nearby ItemTransferable, ItemExtractable, or ItemInsertable but doesn't expose any other item based attributes.
NULL	An ItemTransferable that should be treated as equal to null in all circumstances - that is any checks that depend on an object being transferable should be considered FALSE for this instance.

Method Summary

Modifier and Type	Method	Description
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.
ItemFilter	getInsertionFilter()	Returns an ItemFilter to determine if ItemInsertable.attemptInsertion(ItemStack, Simulation) will accept a stack.
ItemExtractable	getPureExtractable()
ItemInsertable	getPureInsertable()
java.lang.String	toString()
static EmptyItemTransferable	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static EmptyItemTransferable[]	values()	Returns an array containing the constants of this enum type, 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.ItemExtractable

attemptAnyExtraction, couldExtractAnything, extract, extract, extract

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

insert, offer, offer, wouldAccept, wouldPartiallyAccept

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

filtered

Enum Constant Details

NULL

public static final EmptyItemTransferable NULL

An ItemTransferable that should be treated as equal to null in all circumstances - that is any checks that depend on an object being transferable should be considered FALSE for this instance.

CONTROLLER

public static final EmptyItemTransferable CONTROLLER

An ItemTransferable that informs callers that it will interact with a nearby ItemTransferable, ItemExtractable, or ItemInsertable but doesn't expose any other item based attributes.

Method Details

values

public static EmptyItemTransferable[] values()

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

Returns:

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

valueOf

public static EmptyItemTransferable valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

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.

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.

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.

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 java.lang.String toString()

Overrides:

toString in class java.lang.Enum<EmptyItemTransferable>