buildcraft.lib.inventory.filter

Enum StackFilter

java.lang.Object

java.lang.Enum<StackFilter>

buildcraft.lib.inventory.filter.StackFilter

All Implemented Interfaces:

IStackFilter, java.io.Serializable, java.lang.Comparable<StackFilter>

public enum StackFilter
extends java.lang.Enum<StackFilter>
implements IStackFilter

This interface is used with several of the functions in IItemTransfer to provide a convenient means of dealing with entire classes of items without having to specify each item individually.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
FUEL

Method Summary

Modifier and Type	Method and Description
abstract boolean	matches(net.minecraft.item.ItemStack stack) Check to see if a given stack matches this filter.
static StackFilter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StackFilter[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface buildcraft.api.core.IStackFilter

and, getExamples

Enum Constant Detail

ALL

public static final StackFilter ALL

FUEL

public static final StackFilter FUEL

Method Detail

values

public static StackFilter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StackFilter c : StackFilter.values())
    System.out.println(c);

Returns:

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

valueOf

public static StackFilter 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

matches

public abstract boolean matches(@Nonnull
                                net.minecraft.item.ItemStack stack)

Description copied from interface: IStackFilter

Check to see if a given stack matches this filter.

Specified by:

matches in interface IStackFilter

Parameters:

stack - The stack to test. stack.isEmpty will always return false.

Returns:

True if it does match, false otherwise.