Package alexiil.mc.lib.attributes.fluid

Class SingleFluidTank

java.lang.Object

alexiil.mc.lib.attributes.fluid.SingleFluidTankView

alexiil.mc.lib.attributes.fluid.SingleFluidTank

All Implemented Interfaces:

FluidExtractable, FluidInsertable, FluidTransferable, LimitedConsumer<FluidVolume>, Reference<FluidVolume>

public final class SingleFluidTank
extends SingleFluidTankView
implements FluidTransferable, Reference<FluidVolume>

A delegating accessor of a single slot in a FixedFluidInv.

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptExtraction(FluidFilter filter, int maxAmount, Simulation simulation)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by attemptExtraction(FluidFilter, FluidAmount, Simulation).
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.
final void	forceSet(FluidVolume to)	Sets the stack in the given slot to the given stack, or throws an exception if it was not permitted.
final FixedFluidInv	getBackingInv()
FluidFilter	getInsertionFilter()	Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid.
boolean	isValid(FluidVolume value)
final void	modify(Function<FluidVolume,FluidVolume> function)	Applies the given function to the stack held in the slot, and uses forceSet(FluidVolume) on the result (Which will throw an exception if the returned stack is not valid for this tank).
boolean	set(FluidVolume value)
final boolean	set(FluidVolume to, Simulation simulation)	Delegates to Reference.set(Object) if the simulation is Simulation.ACTION, otherwise it delegates to Reference.isValid(Object).

Methods inherited from class alexiil.mc.lib.attributes.fluid.SingleFluidTankView

addListener, get, getFilter, getIndex, getMaxAmount, getMaxAmount_F, getSpace, isValid

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

filtered

Methods inherited from interface alexiil.mc.lib.attributes.misc.Reference

asDestroyable, get

Method Details

getBackingInv

public final FixedFluidInv getBackingInv()

Overrides:

getBackingInv in class SingleFluidTankView

set

public final boolean set(FluidVolume to,
 Simulation simulation)

Description copied from interface: Reference

Delegates to Reference.set(Object) if the simulation is Simulation.ACTION, otherwise it delegates to Reference.isValid(Object).

Specified by:

set in interface Reference<FluidVolume>

forceSet

public final void forceSet(FluidVolume to)

Sets the stack in the given slot to the given stack, or throws an exception if it was not permitted.

modify

public final void modify(Function<FluidVolume,FluidVolume> function)

Applies the given function to the stack held in the slot, and uses forceSet(FluidVolume) on the result (Which will throw an exception if the returned stack is not valid for this tank).

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.

attemptExtraction

@Deprecated(since="0.6.0",
            forRemoval=true)
public FluidVolume attemptExtraction(FluidFilter filter,
 int maxAmount,
 Simulation simulation)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by attemptExtraction(FluidFilter, FluidAmount, 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.

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.

set

public boolean set(FluidVolume value)

Specified by:

set in interface Reference<FluidVolume>

Returns:

True if the new value was accepted, false otherwise.

isValid

public boolean isValid(FluidVolume value)

Specified by:

isValid in interface Reference<FluidVolume>

Returns:

True if Reference.set(Object) was called with the same value.