Package org.cyclops.commoncapabilities.ingredient.storage

Class IngredientComponentStorageWrapperHandlerEnergyStorage.ComponentStorageWrapper

java.lang.Object

org.cyclops.commoncapabilities.ingredient.storage.IngredientComponentStorageWrapperHandlerEnergyStorage.ComponentStorageWrapper

All Implemented Interfaces:

Iterable<Long>, IIngredientComponentStorage<Long,Boolean>

Enclosing class:

IngredientComponentStorageWrapperHandlerEnergyStorage<C>

public static class IngredientComponentStorageWrapperHandlerEnergyStorage.ComponentStorageWrapper
extends Object
implements IIngredientComponentStorage<Long,Boolean>

Constructor Summary

Constructors

Constructor	Description
ComponentStorageWrapper(IngredientComponent<Long,Boolean> ingredientComponent, net.neoforged.neoforge.energy.IEnergyStorage storage)

Method Summary

Modifier and Type	Method	Description
Long	extract(long maxQuantity, boolean simulate)	Extract any ingredient, but the given maximum amount from the storage.
Long	extract(Long prototype, Boolean matchFlags, boolean simulate)	Extract an ingredient matching the given prototype from the storage.
IngredientComponent<Long,Boolean>	getComponent()
long	getMaxQuantity()
Long	insert(Long ingredient, boolean simulate)	Inserts an ingredient into the storage and return the remainder.
Iterator<Long>	iterator()	Get all ingredients in this storage.
Iterator<Long>	iterator(Long prototype, Boolean matchFlags)	Find all ingredients matching the given prototype from the storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ComponentStorageWrapper

public ComponentStorageWrapper(IngredientComponent<Long,Boolean> ingredientComponent,
 net.neoforged.neoforge.energy.IEnergyStorage storage)

Method Details

getComponent

public IngredientComponent<Long,Boolean> getComponent()

Specified by:

getComponent in interface IIngredientComponentStorage<Long,Boolean>

Returns:

The ingredient component type this storage applies to.

iterator

public Iterator<Long> iterator()

Description copied from interface: IIngredientComponentStorage

Get all ingredients in this storage.

Specified by:

iterator in interface IIngredientComponentStorage<Long,Boolean>

Specified by:

iterator in interface Iterable<Long>

Returns:

An iterator over all available ingredients in this storage.

iterator

public Iterator<Long> iterator(@Nonnull
 Long prototype,
 Boolean matchFlags)

Description copied from interface: IIngredientComponentStorage

Find all ingredients matching the given prototype from the storage. Calling this method will not modify the storage in any way. Results from this method MUST NOT be modified.

Specified by:

iterator in interface IIngredientComponentStorage<Long,Boolean>

Parameters:

prototype - The ingredient to search for.

matchFlags - The flags to compare the given prototype by according to IngredientComponent.getMatcher().

Returns:

An iterator over ingredients that match the given prototype, which may potentially be empty.

getMaxQuantity

public long getMaxQuantity()

Specified by:

getMaxQuantity in interface IIngredientComponentStorage<Long,Boolean>

Returns:

The maximum allowed quantity over all instances.

insert

public Long insert(@Nonnull
 Long ingredient,
 boolean simulate)

Description copied from interface: IIngredientComponentStorage

Inserts an ingredient into the storage and return the remainder. The ingredient should not be modified in this function!

Specified by:

insert in interface IIngredientComponentStorage<Long,Boolean>

Parameters:

ingredient - Ingredient to insert.

simulate - If true, the insertion is only simulated.

Returns:

The remaining ingredient that was not inserted (if the entire ingredient is accepted, then return IIngredientMatcher.getEmptyInstance()). May be the same as the input ingredient if unchanged, otherwise a new ingredient.

extract

public Long extract(@Nonnull
 Long prototype,
 Boolean matchFlags,
 boolean simulate)

Description copied from interface: IIngredientComponentStorage

Extract an ingredient matching the given prototype from the storage. Note that only the extracted ingredient must match the prototype under the given condition. Internally, ingredients can be combined and matched in any way. For example, an exact match could be produced by combining several ingredients. If the primary quantifier (as identified by IngredientComponent.getPrimaryQuantifier()) IS NOT part of the match condition, then the quantity of the given prototype MUST be interpreted as the maximum quantity that must be extracted. If the primary quantifier (as identified by IngredientComponent.getPrimaryQuantifier()) IS part of the match condition, then the quantity of the given prototype MUST be interpreted as the exact quantity that must be extracted. If the storage has a HIGHER OR EQUAL available quantity, then the storage MUST allow the given quantity to be extracted. If the storage on the other hand has a LOWER available quantity, then extraction is not allowed.

Specified by:

extract in interface IIngredientComponentStorage<Long,Boolean>

Parameters:

prototype - The ingredient to search for.

matchFlags - The flags to compare the given prototype by according to IngredientComponent.getMatcher().

simulate - If true, the insertion is only simulated

Returns:

Ingredient extracted from the slot, must be IIngredientMatcher.getEmptyInstance(), if nothing can be extracted

extract

public Long extract(long maxQuantity,
 boolean simulate)

Description copied from interface: IIngredientComponentStorage

Extract any ingredient, but the given maximum amount from the storage.

Specified by:

extract in interface IIngredientComponentStorage<Long,Boolean>

Parameters:

maxQuantity - The maximum amount to extract.

simulate - If true, the insertion is only simulated

Returns:

Ingredient extracted from the slot, must be IIngredientMatcher.getEmptyInstance(), if nothing can be extracted