Package org.cyclops.cyclopscore.ingredient.storage

Class IngredientComponentStorageSlottedCollectionWrapper<T,M>

java.lang.Object
org.cyclops.cyclopscore.ingredient.storage.IngredientComponentStorageSlottedCollectionWrapper<T,M>
Type Parameters:
T - The instance type.
M - The matching condition parameter.
All Implemented Interfaces:
Iterable<T>, IIngredientComponentStorage<T,M>, IIngredientComponentStorageSlotted<T,M>
public class IngredientComponentStorageSlottedCollectionWrapper<T,M> extends Object implements IIngredientComponentStorageSlotted<T,M>
An implementation of IIngredientComponentStorageSlotted that internally uses a IIngredientListMutable to store instances.

  • Constructor Details

    • IngredientComponentStorageSlottedCollectionWrapper

      public IngredientComponentStorageSlottedCollectionWrapper(IIngredientListMutable<T,M> ingredientCollection, long maxSlotQuantity, long rateLimit)

  • Method Details

    • getSlots

      public int getSlots()
      Specified by:
      getSlots in interface IIngredientComponentStorageSlotted<T,M>
      Returns:
      The number of available slots.

    • getSlotContents

      public T getSlotContents(int slot)
      Description copied from interface: IIngredientComponentStorageSlotted
      Get the ingredient that is contained in the given slot. Note: The returned ingredient MUST NOT not be modified by the caller.
      Specified by:
      getSlotContents in interface IIngredientComponentStorageSlotted<T,M>
      Parameters:
      slot - A slot number.
      Returns:
      The contained ingredient.

    • getMaxQuantity

      public long getMaxQuantity(int slot)
      Description copied from interface: IIngredientComponentStorageSlotted
      Get the maximum allowed quantity in the given slot.
      Specified by:
      getMaxQuantity in interface IIngredientComponentStorageSlotted<T,M>
      Parameters:
      slot - A slot number.
      Returns:
      The maximum allowed in the given slot.

    • insert

      public T insert(int slot, @Nonnull T ingredient, boolean simulate)
      Description copied from interface: IIngredientComponentStorageSlotted
      Inserts an ingredient into the storage in the given slot and return the remainder. The ingredient should not be modified in this function!
      Specified by:
      insert in interface IIngredientComponentStorageSlotted<T,M>
      Parameters:
      slot - A slot number to insert to.
      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 T extract(int slot, long maxQuantity, boolean simulate)
      Description copied from interface: IIngredientComponentStorageSlotted
      Extract the at most the given quantity from the ingredient from the given slot in the storage.
      Specified by:
      extract in interface IIngredientComponentStorageSlotted<T,M>
      Parameters:
      slot - A slot number to extract from.
      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

    • getComponent

      public IngredientComponent<T,M> getComponent()
      Specified by:
      getComponent in interface IIngredientComponentStorage<T,M>
      Returns:
      The ingredient component type this storage applies to.

    • iterator

      public Iterator<T> iterator()
      Description copied from interface: IIngredientComponentStorage
      Get all ingredients in this storage.
      Specified by:
      iterator in interface IIngredientComponentStorage<T,M>
      Specified by:
      iterator in interface Iterable<T>
      Returns:
      An iterator over all available ingredients in this storage.

    • iterator

      public Iterator<T> iterator(@Nonnull T prototype, M matchCondition)
      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<T,M>
      Parameters:
      prototype - The ingredient to search for.
      matchCondition - 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<T,M>
      Returns:
      The maximum allowed quantity over all instances.

    • insert

      public T insert(@Nonnull T 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<T,M>
      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 T extract(@Nonnull T prototype, M matchCondition, 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<T,M>
      Parameters:
      prototype - The ingredient to search for.
      matchCondition - 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 T 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<T,M>
      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