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

Class CombinedFluidExtractable

java.lang.Object

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

alexiil.mc.lib.attributes.fluid.impl.CombinedFluidExtractable

All Implemented Interfaces:

FluidExtractable, Combined

public final class CombinedFluidExtractable
extends AbstractCombined<FluidExtractable>
implements FluidExtractable

Field Summary

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

list

Constructor Summary

Constructors

Constructor	Description
CombinedFluidExtractable(List<? extends FluidExtractable> list)

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.

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

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

Constructor Details

CombinedFluidExtractable

public CombinedFluidExtractable(List<? extends FluidExtractable> list)

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.