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

Class SimpleLimitedGroupedFluidInv

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.DelegatingGroupedFluidInv

alexiil.mc.lib.attributes.fluid.impl.SimpleLimitedGroupedFluidInv

All Implemented Interfaces:

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

public class SimpleLimitedGroupedFluidInv
extends DelegatingGroupedFluidInv
implements LimitedGroupedFluidInv

Nested Class Summary

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

GroupedFluidInvView.FluidInvStatistic

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

LimitedGroupedFluidInv.FluidLimitRule

Field Summary

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

delegate

Constructor Summary

Constructors

Constructor	Description
SimpleLimitedGroupedFluidInv(GroupedFluidInv delegate)

Method Summary

Modifier and Type	Method	Description
protected void	assertMutable()
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.
LimitedGroupedFluidInv	copy()	Creates a copy of this LimitedGroupedFluidInv (with the same backing inventory and the same rules), but not marked as final.
FluidFilter	getInsertionFilter()	Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid.
LimitedGroupedFluidInv.FluidLimitRule	getRule(FluidFilter filter)
LimitedGroupedFluidInv	markFinal()	Marks this object as final, and disallows any further changes to this.

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

addListener_F, attemptAnyExtraction, getStatistics, getStoredFluids, getTotalCapacity_F

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

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

asUnmodifiable, getAllRule, getRule, reset

Constructor Details

SimpleLimitedGroupedFluidInv

public SimpleLimitedGroupedFluidInv(GroupedFluidInv delegate)

Method Details

markFinal

public LimitedGroupedFluidInv markFinal()

Description copied from interface: LimitedGroupedFluidInv

Marks this object as final, and disallows any further changes to this. If this is called then LimitedGroupedFluidInv.asUnmodifiable() will return this object.

Specified by:

markFinal in interface LimitedGroupedFluidInv

Returns:

this.

assertMutable

protected void assertMutable()

copy

public LimitedGroupedFluidInv copy()

Description copied from interface: LimitedGroupedFluidInv

Creates a copy of this LimitedGroupedFluidInv (with the same backing inventory and the same rules), but not marked as final.

Specified by:

copy in interface LimitedGroupedFluidInv

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

Overrides:

attemptExtraction in class DelegatingGroupedFluidInv

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.

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

Overrides:

attemptInsertion in class DelegatingGroupedFluidInv

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

Overrides:

getInsertionFilter in class DelegatingGroupedFluidInv

Returns:

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

getRule

public LimitedGroupedFluidInv.FluidLimitRule getRule(FluidFilter filter)

Specified by:

getRule in interface LimitedGroupedFluidInv

Returns:

An LimitedGroupedFluidInv.FluidLimitRule that applies to every fluid that matches the given filter.