buildcraft.lib.inventory

Class AbstractInvItemTransactor

java.lang.Object

buildcraft.lib.inventory.AbstractInvItemTransactor

All Implemented Interfaces:

IItemTransactor

Direct Known Subclasses:

InventoryWrapper, ItemHandlerSimple, ItemHandlerWrapper, SidedInventoryWrapper

public abstract class AbstractInvItemTransactor
extends java.lang.Object
implements IItemTransactor

Designates an IItemTransactor that is backed by a simple, static, array based inventory.

Nested Class Summary

Nested classes/interfaces inherited from interface buildcraft.api.inventory.IItemTransactor

IItemTransactor.IItemExtractable, IItemTransactor.IItemInsertable

Constructor Summary

Constructors

Constructor and Description
AbstractInvItemTransactor()

Method Summary

Modifier and Type	Method and Description
static net.minecraft.item.ItemStack	asValid(net.minecraft.item.ItemStack stack) Returns ItemStack.EMPTY if it was empty, or the input stack if it was not.
protected abstract net.minecraft.item.ItemStack	extract(int slot, IStackFilter filter, int min, int max, boolean simulate)
net.minecraft.item.ItemStack	extract(IStackFilter filter, int min, int max, boolean simulate) Extracts a number of items that match the given filter
protected abstract int	getSlots()
protected abstract net.minecraft.item.ItemStack	insert(int slot, net.minecraft.item.ItemStack stack, boolean simulate)
net.minecraft.item.ItemStack	insert(net.minecraft.item.ItemStack stack, boolean allAtOnce, boolean simulate)
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	insert(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks, boolean simulate) Similar to IItemTransactor.insert(ItemStack, boolean, boolean) but probably be more efficient at inserting lots of items.
protected abstract boolean	isEmpty(int slot)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.inventory.IItemTransactor

canFullyAccept, canPartiallyAccept

Constructor Detail

AbstractInvItemTransactor

public AbstractInvItemTransactor()

Method Detail

asValid

@Nonnull
public static net.minecraft.item.ItemStack asValid(@Nonnull
                                                            net.minecraft.item.ItemStack stack)

Returns ItemStack.EMPTY if it was empty, or the input stack if it was not.

insert

@Nonnull
protected abstract net.minecraft.item.ItemStack insert(int slot,
                                                                @Nonnull
                                                                net.minecraft.item.ItemStack stack,
                                                                boolean simulate)

extract

@Nonnull
protected abstract net.minecraft.item.ItemStack extract(int slot,
                                                                 IStackFilter filter,
                                                                 int min,
                                                                 int max,
                                                                 boolean simulate)

getSlots

protected abstract int getSlots()

isEmpty

protected abstract boolean isEmpty(int slot)

insert

@Nonnull
public net.minecraft.item.ItemStack insert(@Nonnull
                                                    net.minecraft.item.ItemStack stack,
                                                    boolean allAtOnce,
                                                    boolean simulate)

Specified by:

insert in interface IItemTransactor

Parameters:

stack - The stack to insert. Must not be null!

allAtOnce - If true then either the entire stack will be used or none of it.

simulate - If true then the in-world state of this will not be changed.

Returns:

The overflow stack. Will be ItemStack.EMPTY if all of it was accepted.

insert

public net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> insert(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks,
                                                                           boolean simulate)

Description copied from interface: IItemTransactor

Similar to IItemTransactor.insert(ItemStack, boolean, boolean) but probably be more efficient at inserting lots of items.

Specified by:

insert in interface IItemTransactor

Parameters:

stacks - The stacks to insert. Must not be null!

simulate - If true then the in-world state of this will not be changed.

Returns:

The overflow stacks. Will be an empty list if all of it was accepted.

extract

@Nonnull
public net.minecraft.item.ItemStack extract(IStackFilter filter,
                                                     int min,
                                                     int max,
                                                     boolean simulate)

Description copied from interface: IItemTransactor

Extracts a number of items that match the given filter

Specified by:

extract in interface IItemTransactor

Parameters:

filter - The filter that MUST be met by the extracted stack. Null means no filter - it can be any item.

min - The minimum number of items to extract, or 0 if not enough items can be extracted

max - The maximum number of items to extract.

simulate - If true then the in-world state of this will not be changed.

Returns:

The stack that was extracted, or ItemStack.EMPTY if it could not be.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object