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

Class DelegatingFixedFluidInv

java.lang.Object

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

All Implemented Interfaces:

Convertible, FixedFluidInv, FixedFluidInvView

Direct Known Subclasses:

SimpleLimitedFixedFluidInv

public class DelegatingFixedFluidInv
extends java.lang.Object
implements FixedFluidInv

A simple delegate base class for FixedFluidInv.

Field Summary

Fields

Modifier and Type	Field	Description
protected FixedFluidInv	delegate

Constructor Summary

Constructors

Constructor	Description
DelegatingFixedFluidInv(FixedFluidInv delegate)

Method Summary

Modifier and Type	Method	Description
ListenerToken	addListener(FluidInvTankChangeListener listener, ListenerRemovalToken removalToken)	Adds the given listener to this inventory, such that the FluidInvTankChangeListener.onChange(FixedFluidInvView, int, FluidVolume, FluidVolume) will be called every time that this inventory changes.
FluidFilter	getFilterForTank(int tank)	Exposes FixedFluidInvView.isFluidValidForTank(int, FluidKey) as a (potentially) readable filter.
FluidVolume	getInvFluid(int tank)
int	getMaxAmount(int tank)	Deprecated.
FluidAmount	getMaxAmount_F(int tank)
int	getTankCount()
boolean	isFluidValidForTank(int tank, FluidKey fluid)	Checks to see if the given fluid would be valid for this tank, ignoring current contents.
boolean	setInvFluid(int tank, FluidVolume to, Simulation simulation)	Sets the fluid in the given tank to the given fluid.

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, getGroupedInv, getInsertable, getMappedInv, getSubInv, getTank, getTransferable, insertFluid, modifyTank, tankIterable

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

convertTo, fluidIterable, getFixedView, offerSelfAsAttribute

Field Details

delegate

protected final FixedFluidInv delegate

Constructor Details

DelegatingFixedFluidInv

public DelegatingFixedFluidInv(FixedFluidInv delegate)

Method Details

getTankCount

public int getTankCount()

Specified by:

getTankCount in interface FixedFluidInvView

Returns:

The number of tanks in this inventory.

getInvFluid

public FluidVolume getInvFluid(int tank)

Specified by:

getInvFluid in interface FixedFluidInvView

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 FluidVolume that is held in the tank at the moment. The returned volume must never be modified!

getMaxAmount

@Deprecated public int getMaxAmount(int tank)

Deprecated.

Specified by:

getMaxAmount in interface FixedFluidInvView

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

getMaxAmount_F

public FluidAmount getMaxAmount_F(int tank)

Specified by:

getMaxAmount_F in interface FixedFluidInvView

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

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

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

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

addListener

public ListenerToken addListener(FluidInvTankChangeListener listener, ListenerRemovalToken removalToken)

Description copied from interface: FixedFluidInvView

Adds the given listener to this inventory, such that the FluidInvTankChangeListener.onChange(FixedFluidInvView, int, FluidVolume, FluidVolume) will be called every time that this inventory changes. However if this inventory doesn't support listeners then this will return a null token.

Specified by:

addListener in interface FixedFluidInvView

removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).

Returns:

A token that represents the listener, or null if the listener could not be added.

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

Returns:

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