Package net.fabricmc.fabric.api.transfer.v1.storage.base

Interface ExtractionOnlyStorage<T>

All Superinterfaces:

Iterable<StorageView<T>>, Storage<T>

All Known Implementing Classes:

FullItemFluidStorage

public interface ExtractionOnlyStorage<T>
extends Storage<T>

A Storage that supports extraction, and not insertion.

Method Summary

Modifier and Type	Method	Description
default long	insert(T resource, long maxAmount, TransactionContext transaction)	Try to insert up to some amount of a resource into this storage.
default boolean	supportsInsertion()	Return false if calling Storage.insert(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) will absolutely always return 0, or true otherwise or in doubt.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.Storage

extract, getVersion, iterator, nonEmptyIterator, nonEmptyViews, supportsExtraction

Method Details

supportsInsertion

default boolean supportsInsertion()

Description copied from interface: Storage

Return false if calling Storage.insert(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) will absolutely always return 0, or true otherwise or in doubt.

Note: This function is meant to be used by pipes or other devices that can transfer resources to know if they should interact with this storage at all.

Specified by:

supportsInsertion in interface Storage<T>

insert

default long insert(T resource,
 long maxAmount,
 TransactionContext transaction)

Description copied from interface: Storage

Try to insert up to some amount of a resource into this storage.

Specified by:

insert in interface Storage<T>

Parameters:

resource - The resource to insert. May not be blank.

maxAmount - The maximum amount of resource to insert. May not be negative.

transaction - The transaction this operation is part of.

Returns:

A non-negative integer not greater than maxAmount: the amount that was inserted.