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

Class FilteredFluidInsertable

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.FilteredFluidInsertable

All Implemented Interfaces:

FluidInsertable, LimitedConsumer<FluidVolume>

public final class FilteredFluidInsertable
extends java.lang.Object
implements FluidInsertable

A FluidInsertable that delegates to another FluidInsertable, but has an additional filter as to what can be inserted.

Field Summary

Fields

Modifier and Type	Field	Description
FluidFilter	filter

Constructor Summary

Constructors

Constructor	Description
FilteredFluidInsertable(FluidInsertable real, FluidFilter filter)

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptInsertion(FluidVolume fluid, Simulation simulation)	Inserts the given stack into this insertable, and returns the excess.
FluidInsertable	filtered(FluidFilter filter)
FluidFilter	getInsertionFilter()	Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid.
FluidAmount	getMinimumAcceptedAmount()

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

getPureInsertable, insert, offer, offer, wouldAccept

Field Details

filter

public final FluidFilter filter

Constructor Details

FilteredFluidInsertable

public FilteredFluidInsertable(FluidInsertable real, FluidFilter filter)

Method Details

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.

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.

filtered

public FluidInsertable filtered(FluidFilter filter)

Specified by:

filtered in interface FluidInsertable

Returns:

A new FluidInsertable that has an additional filter applied to the fluid inserted into it.