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

Class FilteredFluidTransferable

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.FilteredFluidTransferable

All Implemented Interfaces:

FluidExtractable, FluidInsertable, FluidTransferable, LimitedConsumer<FluidVolume>

public final class FilteredFluidTransferable
extends Object
implements FluidTransferable

Field Summary

Fields

Modifier and Type	Field	Description
FluidFilter	filter

Constructor Summary

Constructors

Constructor	Description
FilteredFluidTransferable(FluidTransferable real, FluidFilter filter)

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.
FluidTransferable	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.FluidExtractable

attemptAnyExtraction, attemptAnyExtraction, attemptExtraction, couldExtractAnything, extract, extract, extract, extract, extract, extract, getPureExtractable

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

getPureInsertable, insert, offer, offer, wouldAccept

Field Details

filter

public final FluidFilter filter

Constructor Details

FilteredFluidTransferable

public FilteredFluidTransferable(FluidTransferable real,
 FluidFilter filter)

Method Details

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.

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 FluidTransferable filtered(FluidFilter filter)

Specified by:

filtered in interface FluidExtractable

Specified by:

filtered in interface FluidInsertable

Specified by:

filtered in interface FluidTransferable

Returns:

A new FluidTransferable that has an additional filter applied to the fluid extracted from it or inserted into it.