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

Class CombinedGroupedFluidInv

java.lang.Object

alexiil.mc.lib.attributes.misc.AbstractCombined<GroupedFluidInvView>

alexiil.mc.lib.attributes.fluid.impl.CombinedGroupedFluidInvView

alexiil.mc.lib.attributes.fluid.impl.CombinedGroupedFluidInv

All Implemented Interfaces:

FluidExtractable, FluidInsertable, FluidTransferable, GroupedFluidInv, GroupedFluidInvView, Combined, LimitedConsumer<FluidVolume>

public class CombinedGroupedFluidInv
extends CombinedGroupedFluidInvView
implements GroupedFluidInv

Nested Class Summary

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

GroupedFluidInvView.FluidInvStatistic

Field Summary

Fields inherited from class alexiil.mc.lib.attributes.fluid.impl.CombinedGroupedFluidInvView

inventories

Fields inherited from class alexiil.mc.lib.attributes.misc.AbstractCombined

list

Constructor Summary

Constructors

Constructor	Description
CombinedGroupedFluidInv(List<? extends GroupedFluidInv> inventories)

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptExtraction(FluidFilter filter, FluidAmount 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.
FluidFilter	getInsertionFilter()	Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid.

Methods inherited from class alexiil.mc.lib.attributes.fluid.impl.CombinedGroupedFluidInvView

addListener_F, getStatistics, getStoredFluids, getTotalCapacity_F

Methods inherited from class alexiil.mc.lib.attributes.misc.AbstractCombined

equals, getSubObject, getSubObjectCount, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, 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, getPureExtractable

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

getMinimumAcceptedAmount, getPureInsertable, 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, addListener_F, getAmount, getAmount, getAmount_F, getAmount_F, getCapacity, getCapacity_F, getGroupedView, getSpace, getSpace_F, getStatistics, getStatistics, getStoredFluids, getTotalCapacity, getTotalCapacity_F

Constructor Details

CombinedGroupedFluidInv

public CombinedGroupedFluidInv(List<? extends GroupedFluidInv> inventories)

Method Details

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.

getInsertionFilter

public FluidFilter getInsertionFilter()

Description copied from interface: FluidInsertable

Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid. The default implementation is to return ConstantFluidFilter.ANYTHING, and so it is recommended that custom insertables override this to return a more accurate filter.

Specified by:

getInsertionFilter in interface FluidInsertable

Returns:

A filter to determine if the given fluid could ever be inserted.

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.