Class SingleVariantStorage

java.lang.Object

fr.robie.machineengine.api.transfer.SnapshotParticipant<SingleVariantStorage.Snapshot>

fr.robie.machineengine.api.transfer.storage.SingleVariantStorage

All Implemented Interfaces:

ResourceHandler

public class SingleVariantStorage
extends SnapshotParticipant<SingleVariantStorage.Snapshot>
implements ResourceHandler

One slot holding a single variant: a tank, a battery, an item slot. Different variants of the same type combine according to the category's MergePolicy.

Owned by one thread (§16); not thread-safe. Subclasses may override SnapshotParticipant.onFinalCommit() to react to committed changes (dirty marking, wake-ups).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleVariantStorage.Builder
static final record	SingleVariantStorage.Snapshot

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleVariantStorage(@NotNull SingleVariantStorage.Builder builder)

Method Summary

Modifier and Type	Method	Description
long	amount()
static @NotNull SingleVariantStorage.Builder	builder(long capacity)
long	capacity()	The most this storage holds; subclasses may change it at runtime (e.g.
protected @NotNull SingleVariantStorage.Snapshot	createSnapshot()
long	extract(@NotNull ResourceVariant requested, long maxAmount, @NotNull TransactionContext transaction)
long	insert(@NotNull ResourceVariant incoming, long maxAmount, @NotNull TransactionContext transaction)
boolean	isEmpty()
void	load(@Nullable ResourceVariant variant, long amount)	Replaces the contents outside of any transaction.
static @NotNull SingleVariantStorage	of(long capacity)
protected void	readSnapshot(@NotNull SingleVariantStorage.Snapshot snapshot)	Restores state captured by SnapshotParticipant.createSnapshot().
boolean	supportsExtraction()
boolean	supportsInsertion()
String	toString()
@Nullable ResourceVariant	variant()
@NotNull StorageView	view()
@NotNull List<StorageView>	views()

Methods inherited from class SnapshotParticipant

onFinalCommit, updateSnapshots

Methods inherited from class Object

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

Methods inherited from interface ResourceHandler

amountOf

Constructor Details

SingleVariantStorage

protected SingleVariantStorage(@NotNull
 @NotNull SingleVariantStorage.Builder builder)

Method Details

builder

@NotNull
public static @NotNull SingleVariantStorage.Builder builder(long capacity)

of

@NotNull
public static @NotNull SingleVariantStorage of(long capacity)

insert

public long insert(@NotNull
 @NotNull ResourceVariant incoming,
 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 requested,
 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

view

@NotNull
public @NotNull StorageView view()

supportsInsertion

public boolean supportsInsertion()

Specified by:

supportsInsertion in interface ResourceHandler

supportsExtraction

public boolean supportsExtraction()

Specified by:

supportsExtraction in interface ResourceHandler

variant

@Nullable
public @Nullable ResourceVariant variant()

amount

public long amount()

capacity

public long capacity()

The most this storage holds; subclasses may change it at runtime (e.g. upgrades).

isEmpty

public boolean isEmpty()

load

public void load(@Nullable
 @Nullable ResourceVariant variant,
 long amount)

Replaces the contents outside of any transaction. For loading persisted state only.

createSnapshot

@NotNull
protected @NotNull SingleVariantStorage.Snapshot createSnapshot()

Specified by:

createSnapshot in class SnapshotParticipant<SingleVariantStorage.Snapshot>

Returns:

an immutable copy of the current state

readSnapshot

protected void readSnapshot(@NotNull
 @NotNull SingleVariantStorage.Snapshot snapshot)

Description copied from class: SnapshotParticipant

Restores state captured by SnapshotParticipant.createSnapshot().

Specified by:

readSnapshot in class SnapshotParticipant<SingleVariantStorage.Snapshot>

toString

public String toString()

Overrides:

toString in class Object