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

Class CombinedFluidInsertable

java.lang.Object

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

alexiil.mc.lib.attributes.fluid.impl.CombinedFluidInsertable

All Implemented Interfaces:

FluidInsertable, Combined, LimitedConsumer<FluidVolume>

public final class CombinedFluidInsertable
extends AbstractCombined<FluidInsertable>
implements FluidInsertable

Field Summary

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

list

Constructor Summary

Constructors

Constructor	Description
CombinedFluidInsertable(java.util.List<? extends FluidInsertable> list)

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptInsertion(FluidVolume stack, 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.
FluidAmount	getMinimumAcceptedAmount()

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.FluidInsertable

filtered, getPureInsertable, insert, offer, offer, wouldAccept

Constructor Details

CombinedFluidInsertable

public CombinedFluidInsertable(java.util.List<? extends FluidInsertable> list)

Method Details

attemptInsertion

public FluidVolume attemptInsertion(FluidVolume stack, 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:

stack - 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.

getMinimumAcceptedAmount

public FluidAmount getMinimumAcceptedAmount()

Specified by:

getMinimumAcceptedAmount in interface FluidInsertable

Returns:

The minimum amount of fluid that FluidInsertable.attemptInsertion(FluidVolume, Simulation) will actually accept. Note that this only provides a guarantee that fluid volumes with an amount less than this will never be accepted.

A null return value indicates that there is no minimum value.