Class CombinedResourceHandler

java.lang.Object

fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler

All Implemented Interfaces:

ResourceHandler

public class CombinedResourceHandler
extends Object
implements ResourceHandler

Several handlers seen as one, e.g. the slots of an inventory. Inserts fill parts that already hold something first, then empty parts, in order.

Constructor Summary

Constructors

Constructor	Description
CombinedResourceHandler(@NotNull List<? extends ResourceHandler> parts)

Method Summary

Modifier and Type	Method	Description
long	extract(@NotNull ResourceVariant variant, long maxAmount, @NotNull TransactionContext transaction)
long	insert(@NotNull ResourceVariant variant, long maxAmount, @NotNull TransactionContext transaction)
@NotNull List<ResourceHandler>	parts()
static @NotNull CombinedResourceHandler	slots(int count, long capacity)
boolean	supportsExtraction()
boolean	supportsInsertion()
@NotNull List<StorageView>	views()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ResourceHandler

amountOf

Constructor Details

CombinedResourceHandler

public CombinedResourceHandler(@NotNull
 @NotNull List<? extends ResourceHandler> parts)

Method Details

slots

@NotNull
public static @NotNull CombinedResourceHandler slots(int count,
 long capacity)

Returns:

count slots of capacity each

parts

@NotNull
public @NotNull List<ResourceHandler> parts()

insert

public long insert(@NotNull
 @NotNull ResourceVariant variant,
 long maxAmount,
 @NotNull
 @NotNull TransactionContext transaction)

Specified by:

insert in interface ResourceHandler

Parameters:

maxAmount - the most to insert; must not be negative

Returns:

how much was accepted, between 0 and maxAmount

extract

public long extract(@NotNull
 @NotNull ResourceVariant variant,
 long maxAmount,
 @NotNull
 @NotNull TransactionContext transaction)

Specified by:

extract in interface ResourceHandler

Parameters:

maxAmount - the most to extract; must not be negative

Returns:

how much was removed, between 0 and maxAmount

views

@NotNull
public @NotNull List<StorageView> views()

Specified by:

views in interface ResourceHandler

Returns:

a snapshot of the current contents, one view per slot

supportsInsertion

public boolean supportsInsertion()

Specified by:

supportsInsertion in interface ResourceHandler

supportsExtraction

public boolean supportsExtraction()

Specified by:

supportsExtraction in interface ResourceHandler