Package alexiil.mc.lib.attributes.fluid

Interface FluidExtractable

All Known Subinterfaces:

FluidTransferable, GroupedFluidInv, LimitedGroupedFluidInv

All Known Implementing Classes:

CombinedFluidExtractable, CombinedGroupedFluidInv, DelegatingGroupedFluidInv, EmptyFluidExtractable, EmptyFluidTransferable, EmptyGroupedFluidInv, FilteredFluidExtractable, FilteredFluidTransferable, GroupedFluidInvFixedWrapper, ItemBasedSingleFluidInv, JumboFixedFluidInv, SimpleFixedFluidInv, SimpleFixedFluidInvExtractable, SimpleLimitedGroupedFluidInv, SingleFluidTank

public interface FluidExtractable

Defines an object that can have fluids extracted from it.

As of 0.6 implementations must override either attemptExtraction(FluidFilter, FluidAmount, Simulation) or attemptExtraction(FluidFilter, int, Simulation), as both implementations call each other by default.

Method Summary

Modifier and Type	Method	Description
default FluidVolume	attemptAnyExtraction(int maxAmount, Simulation simulation)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by attemptAnyExtraction(FluidAmount, Simulation)
default FluidVolume	attemptAnyExtraction(FluidAmount maxAmount, Simulation simulation)	Calls attemptExtraction() with an FluidFilter of ConstantFluidFilter.ANYTHING.
default FluidVolume	attemptExtraction(FluidFilter filter, int maxAmount, Simulation simulation)	Deprecated. Replaced by attemptExtraction(FluidFilter, FluidAmount, Simulation).
default FluidVolume	attemptExtraction(FluidFilter filter, FluidAmount maxAmount, Simulation simulation)	Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.
default boolean	couldExtractAnything()
default FluidVolume	extract(int maxAmount)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by extract(FluidAmount)
default FluidVolume	extract(FluidAmount maxAmount)	Attempt to extract *any* FluidVolume from this.
default FluidVolume	extract(FluidFilter filter, int maxAmount)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by extract(FluidFilter, FluidAmount).
default FluidVolume	extract(FluidFilter filter, FluidAmount maxAmount)	Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.
default FluidVolume	extract(FluidKey filter, int maxAmount)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by extract(FluidKey, FluidAmount)
default FluidVolume	extract(FluidKey filter, FluidAmount maxAmount)	Attempt to extract *any* FluidVolume from this that is equalto the given ItemStack.
default FluidExtractable	filtered(FluidFilter filter)
default FluidExtractable	getPureExtractable()
static void	validateFluidExtractable(FluidExtractable instance)

Method Details

attemptExtraction

default FluidVolume attemptExtraction(FluidFilter filter,
 int maxAmount,
 Simulation simulation)

Deprecated.

Replaced by attemptExtraction(FluidFilter, FluidAmount, Simulation).

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

Parameters:

filter -

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

default FluidVolume attemptExtraction(FluidFilter filter,
 FluidAmount maxAmount,
 Simulation simulation)

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

Parameters:

filter -

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.

attemptAnyExtraction

@Deprecated(since="0.6.0",
            forRemoval=true)
default FluidVolume attemptAnyExtraction(int maxAmount,
 Simulation simulation)

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

Replaced by attemptAnyExtraction(FluidAmount, Simulation)

Calls attemptExtraction() with an FluidFilter of ConstantFluidFilter.ANYTHING.

attemptAnyExtraction

default FluidVolume attemptAnyExtraction(FluidAmount maxAmount,
 Simulation simulation)

Calls attemptExtraction() with an FluidFilter of ConstantFluidFilter.ANYTHING.

extract

@Deprecated(since="0.6.0",
            forRemoval=true)
default FluidVolume extract(FluidFilter filter,
 int maxAmount)

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

Replaced by extract(FluidFilter, FluidAmount).

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

extract

default FluidVolume extract(FluidFilter filter,
 FluidAmount maxAmount)

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

extract

@Deprecated(since="0.6.0",
            forRemoval=true)
default FluidVolume extract(FluidKey filter,
 int maxAmount)

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

Replaced by extract(FluidKey, FluidAmount)

Attempt to extract *any* FluidVolume from this that is equalto the given ItemStack.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with an FluidFilter parameter of ExactFluidFilter and a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

extract

default FluidVolume extract(FluidKey filter,
 FluidAmount maxAmount)

Attempt to extract *any* FluidVolume from this that is equalto the given ItemStack.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with an FluidFilter parameter of ExactFluidFilter and a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

extract

@Deprecated(since="0.6.0",
            forRemoval=true)
default FluidVolume extract(int maxAmount)

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

Replaced by extract(FluidAmount)

Attempt to extract *any* FluidVolume from this.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with an FluidFilter parameter of ConstantFluidFilter.ANYTHING and a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

extract

default FluidVolume extract(FluidAmount maxAmount)

Attempt to extract *any* FluidVolume from this.

This is equivalent to calling attemptExtraction(FluidFilter, int, Simulation) with an FluidFilter parameter of ConstantFluidFilter.ANYTHING and a Simulation parameter of ACTION.

Parameters:

maxAmount - The maximum number of items that can be extracted. Negative numbers throw an exception.

Returns:

A new, independent ItemStack that was extracted.

couldExtractAnything

default boolean couldExtractAnything()

Returns:

True if attemptAnyExtraction(FluidAmount.ONE, SIMULATE) returns a non-empty FluidVolume.

validateFluidExtractable

static void validateFluidExtractable(FluidExtractable instance)

filtered

default FluidExtractable filtered(FluidFilter filter)

Returns:

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

getPureExtractable

default FluidExtractable getPureExtractable()

Returns:

An object that only implements FluidExtractable, and does not expose any of the other modification methods that sibling or subclasses offer (like FluidInsertable or GroupedFluidInv.