Package alexiil.mc.lib.attributes.fluid.impl

Enum Class EmptyFluidExtractable

java.lang.Object

java.lang.Enum<EmptyFluidExtractable>

alexiil.mc.lib.attributes.fluid.impl.EmptyFluidExtractable

All Implemented Interfaces:

FluidExtractable, NullVariant, Serializable, Comparable<EmptyFluidExtractable>, Constable

public enum EmptyFluidExtractable
extends Enum<EmptyFluidExtractable>
implements FluidExtractable, NullVariant

A FluidExtractable that never returns any fluid from attemptExtraction(FluidFilter, int, Simulation).

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NULL	A FluidExtractable that should be treated as equal to null in all circumstances - that is any checks that depend on an object being extractable should be considered FALSE for this instance.
SUPPLIER	A FluidExtractable that informs callers that it will push fluid into a nearby FluidInsertable, but doesn't expose any other fluid based attributes.

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptExtraction(FluidFilter filter, int maxAmount, Simulation simulation)	Deprecated, for removal: This API element is subject to removal in a future version.
FluidVolume	attemptExtraction(FluidFilter filter, FluidAmount maxAmount, Simulation simulation)	Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.
FluidExtractable	getPureExtractable()
static EmptyFluidExtractable	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmptyFluidExtractable[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface alexiil.mc.lib.attributes.fluid.FluidExtractable

attemptAnyExtraction, attemptAnyExtraction, couldExtractAnything, extract, extract, extract, extract, extract, extract, filtered

Enum Constant Details

NULL

public static final EmptyFluidExtractable NULL

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

SUPPLIER

public static final EmptyFluidExtractable SUPPLIER

A FluidExtractable that informs callers that it will push fluid into a nearby FluidInsertable, but doesn't expose any other fluid based attributes.

The buildcraft quarry is a good example of an item version of this - it doesn't have any inventory storage itself and it pushes items out of it as it mines them from the world, but item pipes should still connect to it so that it can insert into them.

Method Details

values

public static EmptyFluidExtractable[] 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 EmptyFluidExtractable 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

attemptExtraction

@Deprecated(since="0.6.0",
            forRemoval=true)
public FluidVolume attemptExtraction(FluidFilter filter,
 int maxAmount,
 Simulation simulation)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: FluidExtractable

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

Specified by:

attemptExtraction in interface FluidExtractable

maxAmount - The maximum amount of fluid that can be extracted. Negative numbers throw an exception.

simulation - If Simulation.SIMULATE then this should return the same result that the exact same call with Simulation.ACTION would do, except that the filter can be made more specific between calls if the previously simulated extracted fluid is used as a filter.

For example the following code snippet should never throw an exception:

FluidExtractable from = // Some extractable
FluidVolume attempted = from.attemptAnyExtraction(Integer.MAX_VALUE, Simulation.SIMULATE);
if (attempted.isEmpty()) return;
FluidVolume extracted = from.extract(attempted.getFluidKey(), attempted.getAmount());
assert !extracted.isEmpty;
assert attempted.getAmount() == extracted.getAmount();
assert attempted.getFluidKet() == extracted.getFluidKet();
assert attempted.equals(extracted);

Returns:

A new, independent FluidVolume that was extracted.

attemptExtraction

public FluidVolume attemptExtraction(FluidFilter filter,
 FluidAmount maxAmount,
 Simulation simulation)

Description copied from interface: FluidExtractable

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

Specified by:

attemptExtraction in interface FluidExtractable

maxAmount - The maximum amount of fluid that can be extracted. Negative numbers throw an exception.

simulation - If Simulation.SIMULATE then this should return the same result that the exact same call with Simulation.ACTION would do, except that the filter can be made more specific between calls if the previously simulated extracted fluid is used as a filter.

For example the following code snippet should never throw an exception:

FluidExtractable from = // Some extractable
FluidVolume attempted = from.attemptAnyExtraction(Integer.MAX_VALUE, Simulation.SIMULATE);
if (attempted.isEmpty()) return;
FluidVolume extracted = from.extract(attempted.getFluidKey(), attempted.getAmount());
assert !extracted.isEmpty;
assert attempted.getAmount() == extracted.getAmount();
assert attempted.getFluidKet() == extracted.getFluidKet();
assert attempted.equals(extracted);

Returns:

A new, independent FluidVolume that was extracted.

getPureExtractable

public FluidExtractable getPureExtractable()

Specified by:

getPureExtractable in interface FluidExtractable

Returns:

An object that only implements FluidExtractable, and does not expose any of the other modification methods that sibling or subclasses offer (like FluidInsertable or GroupedFluidInv.