buildcraft.lib.misc

Class StackUtil

java.lang.Object

buildcraft.lib.misc.StackUtil

public class StackUtil
extends java.lang.Object

Provides various utils for interacting with ItemStack, and multiples.

Field Summary

Fields

Modifier and Type	Field and Description
static net.minecraft.item.ItemStack	EMPTY A non-null version of ItemStack.EMPTY.

Constructor Summary

Constructors

Constructor and Description
StackUtil()

Method Summary

Modifier and Type	Method and Description
static <T> T	asNonNull(T obj) Takes a Nullable Object and checks to make sure that it is really Nonnull, like it is everywhere else in the codebase.
static net.minecraft.item.ItemStack	asNonNullSoft(net.minecraft.item.ItemStack stack)
static <T> T	asNonNullSoft(T obj, T fallback)
static boolean	canMerge(net.minecraft.item.ItemStack a, net.minecraft.item.ItemStack b) Checks to see if the two input stacks are equal in all but stack size.
static boolean	canStacksOrListsMerge(net.minecraft.item.ItemStack stack1, net.minecraft.item.ItemStack stack2)
static boolean	contains(IngredientStack ingredientStack, net.minecraft.item.ItemStack stack) Checks that passed stack meets stack definition requirements
static boolean	contains(IngredientStack ingredientStack, net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks) Checks that passed stack definition acceptable for stack collection
static boolean	contains(net.minecraft.item.ItemStack required, java.util.Collection<net.minecraft.item.ItemStack> containers) Checks to see if the given required stack is contained fully in a single stack in a list.
static boolean	contains(net.minecraft.item.ItemStack required, net.minecraft.item.ItemStack container) Checks to see if the given required stack is contained fully in the given container stack.
static boolean	contains(StackDefinition stackDefinition, net.minecraft.item.ItemStack stack) Checks that passed stack meets stack definition requirements
static boolean	contains(StackDefinition stackDefinition, net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks) Checks that passed stack definition acceptable for stack collection
static boolean	containsAll(java.util.Collection<net.minecraft.item.ItemStack> required, java.util.Collection<net.minecraft.item.ItemStack> containers) Checks to see if the given required stacks are all contained within the collection of containers.
static boolean	doesEitherStackMatch(net.minecraft.item.ItemStack stackA, net.minecraft.item.ItemStack stackB)
static boolean	doesStackNbtMatch(net.minecraft.item.ItemStack target, net.minecraft.item.ItemStack with)
static net.minecraft.item.ItemStack	getItemStackForState(net.minecraft.block.state.IBlockState state) Attempts to get an item stack that might place down the given blockstate.
static int	hash(net.minecraft.item.ItemStack stack) Computes a hash code for the given ItemStack.
static boolean	isCraftingEquivalent(int[] oreIDs, net.minecraft.item.ItemStack comparison)
static boolean	isCraftingEquivalent(net.minecraft.item.ItemStack base, net.minecraft.item.ItemStack comparison, boolean oreDictionary) Determines whether the given ItemStack should be considered equivalent for crafting purposes.
static boolean	isEqualItem(net.minecraft.item.ItemStack base, net.minecraft.item.ItemStack comparison) This variant also checks damage for damaged items.
static boolean	isMatchingItem(net.minecraft.item.ItemStack base, net.minecraft.item.ItemStack comparison) Compares item id, damage and NBT.
static boolean	isMatchingItem(net.minecraft.item.ItemStack base, net.minecraft.item.ItemStack comparison, boolean matchDamage, boolean matchNBT) Compares item id, and optionally damage and NBT.
static boolean	isMatchingItemOrList(net.minecraft.item.ItemStack base, net.minecraft.item.ItemStack comparison)
static boolean	isWildcard(int damage) Checks to see if the given ItemStack is considered to be a wildcard stack - that is any damage value on the stack will be considered the same as this for recipe purposes.
static boolean	isWildcard(net.minecraft.item.ItemStack stack) Checks to see if the given ItemStack is considered to be a wildcard stack - that is any damage value on the stack will be considered the same as this for recipe purposes.
static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	listOf()
static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	listOf(net.minecraft.item.ItemStack... stacks) Creates a NonNullList of ItemStack's with the elements given in the order that they are given.
static boolean	matchesStackOrList(net.minecraft.item.ItemStack filterOrList, net.minecraft.item.ItemStack test) This doesn't take into account stack sizes.
static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	mergeSameItems(java.util.List<net.minecraft.item.ItemStack> items)
static int	mergeStacks(net.minecraft.item.ItemStack mergeSource, net.minecraft.item.ItemStack mergeTarget, boolean doMerge) Merges mergeSource into mergeTarget
static <E> java.util.stream.Collector<E,?,net.minecraft.util.NonNullList<E>>	nonNullListCollector()
static net.minecraft.nbt.NBTTagCompound	stripNonFunctionNbt(net.minecraft.item.ItemStack from)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

@Nonnull
public static final net.minecraft.item.ItemStack EMPTY

A non-null version of ItemStack.EMPTY. When the original field adds an @Nonnull annotation this should be inlined.

Constructor Detail

StackUtil

public StackUtil()

Method Detail

canMerge

public static boolean canMerge(@Nonnull
                               net.minecraft.item.ItemStack a,
                               @Nonnull
                               net.minecraft.item.ItemStack b)

Checks to see if the two input stacks are equal in all but stack size. Note that this doesn't check anything todo with stack size, so if you pass in two stacks of 64 cobblestone this will return true. If you pass in null (at all) then this will only return true if both are null.

getItemStackForState

@Nonnull
public static net.minecraft.item.ItemStack getItemStackForState(net.minecraft.block.state.IBlockState state)

Attempts to get an item stack that might place down the given blockstate. Obviously this isn't perfect, and so cannot be relied on for anything more than simple blocks.

contains

public static boolean contains(@Nonnull
                               net.minecraft.item.ItemStack required,
                               @Nonnull
                               net.minecraft.item.ItemStack container)

Checks to see if the given required stack is contained fully in the given container stack.

contains

public static boolean contains(@Nonnull
                               net.minecraft.item.ItemStack required,
                               java.util.Collection<net.minecraft.item.ItemStack> containers)

Checks to see if the given required stack is contained fully in a single stack in a list.

contains

public static boolean contains(@Nonnull
                               StackDefinition stackDefinition,
                               @Nonnull
                               net.minecraft.item.ItemStack stack)

Checks that passed stack meets stack definition requirements

contains

public static boolean contains(@Nonnull
                               StackDefinition stackDefinition,
                               @Nonnull
                               net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks)

Checks that passed stack definition acceptable for stack collection

contains

public static boolean contains(@Nonnull
                               IngredientStack ingredientStack,
                               @Nonnull
                               net.minecraft.item.ItemStack stack)

Checks that passed stack meets stack definition requirements

contains

public static boolean contains(@Nonnull
                               IngredientStack ingredientStack,
                               @Nonnull
                               net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks)

Checks that passed stack definition acceptable for stack collection

containsAll

public static boolean containsAll(java.util.Collection<net.minecraft.item.ItemStack> required,
                                  java.util.Collection<net.minecraft.item.ItemStack> containers)

Checks to see if the given required stacks are all contained within the collection of containers. Note that this assumes that all of the required stacks are different.

stripNonFunctionNbt

public static net.minecraft.nbt.NBTTagCompound stripNonFunctionNbt(@Nonnull
                                                                   net.minecraft.item.ItemStack from)

doesStackNbtMatch

public static boolean doesStackNbtMatch(@Nonnull
                                        net.minecraft.item.ItemStack target,
                                        @Nonnull
                                        net.minecraft.item.ItemStack with)

doesEitherStackMatch

public static boolean doesEitherStackMatch(@Nonnull
                                           net.minecraft.item.ItemStack stackA,
                                           @Nonnull
                                           net.minecraft.item.ItemStack stackB)

canStacksOrListsMerge

public static boolean canStacksOrListsMerge(@Nonnull
                                            net.minecraft.item.ItemStack stack1,
                                            @Nonnull
                                            net.minecraft.item.ItemStack stack2)

matchesStackOrList

public static boolean matchesStackOrList(@Nonnull
                                         net.minecraft.item.ItemStack filterOrList,
                                         @Nonnull
                                         net.minecraft.item.ItemStack test)

This doesn't take into account stack sizes.

Parameters:

filterOrList - The exact itemstack to test, or an item that implements IList to test against.

test - The stack to test for equality

Returns:

True if they matched according to the above definitions, or false if theydidn't, or either was empty.

mergeStacks

public static int mergeStacks(@Nonnull
                              net.minecraft.item.ItemStack mergeSource,
                              @Nonnull
                              net.minecraft.item.ItemStack mergeTarget,
                              boolean doMerge)

Merges mergeSource into mergeTarget

Parameters:

mergeSource - - The stack to merge into mergeTarget, this stack is not modified

mergeTarget - - The target merge, this stack is modified if doMerge is set

doMerge - - To actually do the merge

Returns:

The number of items that was successfully merged.

isCraftingEquivalent

public static boolean isCraftingEquivalent(@Nonnull
                                           net.minecraft.item.ItemStack base,
                                           @Nonnull
                                           net.minecraft.item.ItemStack comparison,
                                           boolean oreDictionary)

Determines whether the given ItemStack should be considered equivalent for crafting purposes.

Parameters:

base - The stack to compare to.

comparison - The stack to compare.

oreDictionary - true to take the Forge OreDictionary into account.

Returns:

true if comparison should be considered a crafting equivalent for base.

isCraftingEquivalent

public static boolean isCraftingEquivalent(int[] oreIDs,
                                           net.minecraft.item.ItemStack comparison)

isMatchingItemOrList

public static boolean isMatchingItemOrList(net.minecraft.item.ItemStack base,
                                           net.minecraft.item.ItemStack comparison)

isMatchingItem

public static boolean isMatchingItem(@Nonnull
                                     net.minecraft.item.ItemStack base,
                                     @Nonnull
                                     net.minecraft.item.ItemStack comparison)

Compares item id, damage and NBT. Accepts wildcard damage. Ignores damage entirely if the item doesn't have subtypes.

Parameters:

base - The stack to compare to.

comparison - The stack to compare.

Returns:

true if id, damage and NBT match.

isEqualItem

public static boolean isEqualItem(@Nonnull
                                  net.minecraft.item.ItemStack base,
                                  @Nonnull
                                  net.minecraft.item.ItemStack comparison)

This variant also checks damage for damaged items.

isMatchingItem

public static boolean isMatchingItem(@Nonnull
                                     net.minecraft.item.ItemStack base,
                                     @Nonnull
                                     net.minecraft.item.ItemStack comparison,
                                     boolean matchDamage,
                                     boolean matchNBT)

Compares item id, and optionally damage and NBT. Accepts wildcard damage. Ignores damage entirely if the item doesn't have subtypes.

Parameters:

base - ItemStack

comparison - ItemStack

matchDamage -

matchNBT -

Returns:

true if matches

isWildcard

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

Checks to see if the given ItemStack is considered to be a wildcard stack - that is any damage value on the stack will be considered the same as this for recipe purposes.

Parameters:

stack - The stack to check

Returns:

True if the stack is a wildcard, false if not.

isWildcard

public static boolean isWildcard(int damage)

Checks to see if the given ItemStack is considered to be a wildcard stack - that is any damage value on the stack will be considered the same as this for recipe purposes.

Parameters:

damage - The damage to check

Returns:

True if the damage does specify a wildcard, false if not.

listOf

public static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> listOf()

Returns:

An empty, nonnull list that cannot be modified (as it cannot be expanded and it has a size of 0)

listOf

public static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> listOf(net.minecraft.item.ItemStack... stacks)

Creates a NonNullList of ItemStack's with the elements given in the order that they are given.

Parameters:

stacks - The stacks to put into a list

Returns:

A NonNullList of all the given items. Note that the returned list of of a specified size, and cannot be expanded.

asNonNull

@Nonnull
public static <T> T asNonNull(@Nullable
                                       T obj)

Takes a Nullable Object and checks to make sure that it is really Nonnull, like it is everywhere else in the codebase. This is only required if some classes do not use the Nonnull annotation on return values.

Parameters:

obj - The (potentially) null object.

Returns:

A Nonnull object, which will be the input object

Throws:

java.lang.NullPointerException - if the input object was actually null (Although this should never happen, this is more to catch bugs in dev.)

asNonNullSoft

@Nonnull
public static <T> T asNonNullSoft(@Nullable
                                           T obj,
                                           @Nonnull
                                           T fallback)

asNonNullSoft

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

nonNullListCollector

public static <E> java.util.stream.Collector<E,?,net.minecraft.util.NonNullList<E>> nonNullListCollector()

Returns:

A Collector that will collect the input elements into a NonNullList

hash

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

Computes a hash code for the given ItemStack. This is based off of ItemStack.serializeNBT(), except if ItemStack.isEmpty() returns true, in which case the hash will be 0.

mergeSameItems

public static net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> mergeSameItems(java.util.List<net.minecraft.item.ItemStack> items)