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

Interface SingleSlotStorage<T>

Type Parameters:

T - The type of the stored resource. Experimental feature, we reserve the right to remove or change it without further notice. The transfer API is a complex addition, and we want to be able to correct possible design mistakes.

All Superinterfaces:

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

All Known Implementing Classes:

FullItemFluidStorage, SingleFluidStorage, SingleItemStorage, SingleStackStorage, SingleVariantItemStorage, SingleVariantStorage

@Experimental
public interface SingleSlotStorage<T>
extends Storage<T>, StorageView<T>

A storage that is also its only storage view. It can be used in APIs for storages that are wrappers around a single "slot", or for slightly more convenient implementation.

Method Summary

Modifier and Type	Method	Description
default Iterator<StorageView<T>>	iterator()	Iterate through the contents of this storage.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

exactView, exactView, extract, getVersion, insert, simulateExtract, simulateInsert, supportsExtraction, supportsInsertion

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

extract, getAmount, getCapacity, getResource, getUnderlyingView, isResourceBlank

Method Details

iterator

default Iterator<StorageView<T>> iterator()

Description copied from interface: Storage

Iterate through the contents of this storage. Every visited StorageView represents a stored resource and an amount. The iterator doesn't guarantee that a single resource only occurs once during an iteration. Calling remove on the iterator is not allowed.

Storage.insert(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) and Storage.extract(T, long, net.fabricmc.fabric.api.transfer.v1.transaction.TransactionContext) may be called safely during iteration. Extractions should be visible to an open iterator, but insertions are not required to. In particular, inventories with a fixed amount of slots may wish to make insertions visible to iterators, but inventories with a dynamic or very large amount of slots should not do that to ensure timely termination of the iteration.

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Storage<T>

Returns:

An iterator over the contents of this storage. Calling remove on the iterator is not allowed.