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

Enum Class EmptyGroupedFluidInv

java.lang.Object

java.lang.Enum<EmptyGroupedFluidInv>

alexiil.mc.lib.attributes.fluid.impl.EmptyGroupedFluidInv

All Implemented Interfaces:

FluidExtractable, FluidInsertable, FluidTransferable, GroupedFluidInv, GroupedFluidInvView, LimitedConsumer<FluidVolume>, NullVariant, Serializable, Comparable<EmptyGroupedFluidInv>, Constable

public enum EmptyGroupedFluidInv
extends Enum<EmptyGroupedFluidInv>
implements GroupedFluidInv, NullVariant

GroupedFluidInvView for an empty inventory.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.fluid.GroupedFluidInvView

GroupedFluidInvView.FluidInvStatistic

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
ListenerToken	addListener_F(FluidInvAmountChangeListener_F listener, ListenerRemovalToken removalToken)	Adds the given listener to this inventory, such that the FluidInvAmountChangeListener.onChange(GroupedFluidInvView, FluidKey, int, int) will be called every time that this inventory changes.
FluidVolume	attemptExtraction(FluidFilter filter, int maxAmount, Simulation simulation)	Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.
FluidVolume	attemptInsertion(FluidVolume fluid, Simulation simulation)	Inserts the given stack into this insertable, and returns the excess.
GroupedFluidInvView	getGroupedView()
FluidExtractable	getPureExtractable()
FluidInsertable	getPureInsertable()
GroupedFluidInvView.FluidInvStatistic	getStatistics(FluidFilter filter)
Set<FluidKey>	getStoredFluids()
FluidAmount	getTotalCapacity_F()
static EmptyGroupedFluidInv	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmptyGroupedFluidInv[]	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, attemptExtraction, couldExtractAnything, extract, extract, extract, extract, extract, extract

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

getInsertionFilter, getMinimumAcceptedAmount, insert, offer, offer, wouldAccept

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

createLimitedGroupedInv, filtered

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

addListener, getAmount, getAmount, getAmount_F, getAmount_F, getCapacity, getCapacity_F, getSpace, getSpace_F, getStatistics, getTotalCapacity

Enum Constant Details

INSTANCE

public static final EmptyGroupedFluidInv INSTANCE

Method Details

values

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

getStatistics

public GroupedFluidInvView.FluidInvStatistic getStatistics(FluidFilter filter)

Specified by:

getStatistics in interface GroupedFluidInvView

Parameters:

filter - The filter to check on.

Returns:

Statistics about the currently stored amount, capacity, and space for everything that matches the given filter.

getStoredFluids

public Set<FluidKey> getStoredFluids()

Specified by:

getStoredFluids in interface GroupedFluidInvView

Returns:

a set containing all of the FluidKey's that are stored in the inventory.

getTotalCapacity_F

public FluidAmount getTotalCapacity_F()

Specified by:

getTotalCapacity_F in interface GroupedFluidInvView

Returns:

The total capacity for every FluidKey that can be stored in this inventory.

NOTE: This value might not be equal to the sum of GroupedFluidInvView.getCapacity(FluidKey) over GroupedFluidInvView.getStoredFluids()!

addListener_F

public ListenerToken addListener_F(FluidInvAmountChangeListener_F listener,
 ListenerRemovalToken removalToken)

Description copied from interface: GroupedFluidInvView

Adds the given listener to this inventory, such that the FluidInvAmountChangeListener.onChange(GroupedFluidInvView, FluidKey, int, int) will be called every time that this inventory changes. However if this inventory doesn't support listeners then this will return a null token.

Specified by:

addListener_F in interface GroupedFluidInvView

removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).

Returns:

A token that represents the listener, or null if the listener could not be added.

attemptInsertion

public FluidVolume attemptInsertion(FluidVolume fluid,
 Simulation simulation)

Description copied from interface: FluidInsertable

Inserts the given stack into this insertable, and returns the excess.

Specified by:

attemptInsertion in interface FluidInsertable

Parameters:

fluid - The incoming fluid. Must not be modified by this call.

simulation - If Simulation.SIMULATE then this shouldn't modify anything.

Returns:

the excess FluidVolume that wasn't accepted. This will be independent of this insertable, however it might be the given object instead of a completely new object.

attemptExtraction

public FluidVolume attemptExtraction(FluidFilter filter,
 int 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.

getGroupedView

public GroupedFluidInvView getGroupedView()

Specified by:

getGroupedView in interface GroupedFluidInvView

Returns:

A completely unmodifiable view of this GroupedItemInvView.

getPureInsertable

public FluidInsertable getPureInsertable()

Specified by:

getPureInsertable in interface FluidInsertable

Returns:

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

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.