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

Class SimpleLimitedFixedFluidInv

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.DelegatingFixedFluidInv

alexiil.mc.lib.attributes.fluid.impl.SimpleLimitedFixedFluidInv

All Implemented Interfaces:

Convertible, FixedFluidInv, FixedFluidInvView, LimitedFixedFluidInv

public class SimpleLimitedFixedFluidInv
extends DelegatingFixedFluidInv
implements LimitedFixedFluidInv

Nested Class Summary

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.fluid.LimitedFixedFluidInv

LimitedFixedFluidInv.FluidTankLimitRule

Field Summary

Fields

Modifier and Type	Field	Description
protected final FluidFilter[]	insertionFilters
protected final FluidAmount[]	maxInsertionAmounts	Array of maximum amounts that can be inserted up to.
protected final FluidAmount[]	minimumAmounts	Array of minimum amounts that can be extracted down to.

Fields inherited from class alexiil.mc.lib.attributes.fluid.impl.DelegatingFixedFluidInv

delegate

Constructor Summary

Constructors

Constructor	Description
SimpleLimitedFixedFluidInv(FixedFluidInv delegate)

Method Summary

Modifier and Type	Method	Description
protected void	assertMutable()
LimitedFixedFluidInv	copy()	Creates a copy of this LimitedFixedItemInv (with the same backing inventory and the same rules).
FluidFilter	getFilterForTank(int tank)	Exposes FixedFluidInvView.isFluidValidForTank(int, FluidKey) as a (potentially) readable filter.
GroupedFluidInv	getGroupedInv()
FluidAmount	getMaxAmount_F(int tank)
LimitedFixedFluidInv.FluidTankLimitRule	getRule(int tank)
LimitedFixedFluidInv.FluidTankLimitRule	getSubRule(int from, int to)
boolean	isFluidValidForTank(int tank, FluidKey fluid)	Checks to see if the given fluid would be valid for this tank, ignoring current contents.
LimitedFixedFluidInv	markFinal()	Marks this object as final, and disallows any further changes to this.
boolean	setInvFluid(int tank, FluidVolume to, Simulation simulation)	Sets the fluid in the given tank to the given fluid.

Methods inherited from class alexiil.mc.lib.attributes.fluid.impl.DelegatingFixedFluidInv

addListener, getInvFluid, getMaxAmount, getTankCount

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

createLimitedFixedInv, extractFluid, forceSetInvFluid, getExtractable, getInsertable, getMappedInv, getSubInv, getTank, getTransferable, insertFluid, modifyTank, tankIterable

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

addListener, convertTo, fluidIterable, getFixedView, getInvFluid, getMaxAmount, getTankCount, offerSelfAsAttribute

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

asUnmodifiable, getAllRule, reset

Field Details

insertionFilters

protected final FluidFilter[] insertionFilters

maxInsertionAmounts

protected final FluidAmount[] maxInsertionAmounts

Array of maximum amounts that can be inserted up to. Null entries are (confusingly) equal to "MAX_VALUE", and not zero.

minimumAmounts

protected final FluidAmount[] minimumAmounts

Array of minimum amounts that can be extracted down to. Null entries are equal to zero.

Constructor Details

SimpleLimitedFixedFluidInv

public SimpleLimitedFixedFluidInv(FixedFluidInv delegate)

Method Details

markFinal

public LimitedFixedFluidInv markFinal()

Description copied from interface: LimitedFixedFluidInv

Marks this object as final, and disallows any further changes to this. If this is called then LimitedFixedFluidInv.asUnmodifiable() will return this object.

Specified by:

markFinal in interface LimitedFixedFluidInv

Returns:

this.

assertMutable

protected void assertMutable()

copy

public LimitedFixedFluidInv copy()

Description copied from interface: LimitedFixedFluidInv

Creates a copy of this LimitedFixedItemInv (with the same backing inventory and the same rules).

Specified by:

copy in interface LimitedFixedFluidInv

getGroupedInv

public GroupedFluidInv getGroupedInv()

Specified by:

getGroupedInv in interface FixedFluidInv

Specified by:

getGroupedInv in interface FixedFluidInvView

Returns:

A statistical view of this inventory.

isFluidValidForTank

public boolean isFluidValidForTank(int tank,
 FluidKey fluid)

Description copied from interface: FixedFluidInv

Checks to see if the given fluid would be valid for this tank, ignoring current contents. Note that this method should adhere to the requirements of FluidFilter.matches(FluidKey), so passing empty fluids will generally not return useful results.

Note that just because an FluidKey passes this validity test, and is mergable with the current fluid, does not mean that you can insert the fluid into this inventory.

Specified by:

isFluidValidForTank in interface FixedFluidInv

Specified by:

isFluidValidForTank in interface FixedFluidInvView

Overrides:

isFluidValidForTank in class DelegatingFixedFluidInv

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

getFilterForTank

public FluidFilter getFilterForTank(int tank)

Description copied from interface: FixedFluidInvView

Exposes FixedFluidInvView.isFluidValidForTank(int, FluidKey) as a (potentially) readable filter.

Specified by:

getFilterForTank in interface FixedFluidInvView

Overrides:

getFilterForTank in class DelegatingFixedFluidInv

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

An FluidFilter for this tank. If this tank is filtered by an FluidFilter internally then it is highly recommended that this be overridden to return that filter rather than the default opaque wrapper around FixedFluidInvView.isFluidValidForTank(int, FluidKey).

setInvFluid

public boolean setInvFluid(int tank,
 FluidVolume to,
 Simulation simulation)

Description copied from interface: FixedFluidInv

Sets the fluid in the given tank to the given fluid.

Specified by:

setInvFluid in interface FixedFluidInv

Overrides:

setInvFluid in class DelegatingFixedFluidInv

Returns:

True if the modification was allowed, false otherwise. (For example if the given stack doesn't pass the FixedFluidInvView.isFluidValidForTank(int, FluidKey) test).

getMaxAmount_F

public FluidAmount getMaxAmount_F(int tank)

Specified by:

getMaxAmount_F in interface FixedFluidInvView

Overrides:

getMaxAmount_F in class DelegatingFixedFluidInv

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

The maximum amount that the given tank can hold of the given fluid. This method will ignore the current stack in FixedFluidInvView.getInvFluid(int). Note that any setters that this object implements (like FixedFluidInv.setInvFluid(int, FluidVolume, Simulation) should reject stacks that are greater than this value. (and callers should only call this if they need to check the amounts separately. Note that it is meaningless to return values greater than the maximum amount an fluid can be stacked to here, and callers are free to throw an exception if this is violated. (Basically huge single-tank inventories shouldn't implement this interface).

getRule

public LimitedFixedFluidInv.FluidTankLimitRule getRule(int tank)

Specified by:

getRule in interface LimitedFixedFluidInv

Returns:

A rule for the single tank.

getSubRule

public LimitedFixedFluidInv.FluidTankLimitRule getSubRule(int from,
 int to)

Specified by:

getSubRule in interface LimitedFixedFluidInv

Parameters:

from - The first tank (inclusive)

to - The last tank (exclusive).

Returns:

A rule that applies to every tank between from and to.