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

Class FilteredFluidExtractable

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.FilteredFluidExtractable

All Implemented Interfaces:

FluidExtractable

public final class FilteredFluidExtractable
extends java.lang.Object
implements FluidExtractable

Field Summary

Fields

Modifier and Type	Field	Description
FluidFilter	filter

Constructor Summary

Constructors

Constructor	Description
FilteredFluidExtractable(FluidExtractable 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.
FluidExtractable	filtered(FluidFilter filter)

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

Field Details

filter

public final FluidFilter filter

Constructor Details

FilteredFluidExtractable

public FilteredFluidExtractable(FluidExtractable 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.

filtered

public FluidExtractable filtered(FluidFilter filter)

Specified by:

filtered in interface FluidExtractable

Returns:

A new FluidExtractable that has an additional filter applied to limit the fluid extracted from it.