Package net.neoforged.neoforge.transfer

Class InfiniteResourceHandler<T extends Resource>

java.lang.Object
net.neoforged.neoforge.transfer.InfiniteResourceHandler<T>
Type Parameters:
T - The type of resource that this handler can accept.
All Implemented Interfaces:
ResourceHandler<T>
public class InfiniteResourceHandler<T extends Resource> extends Object implements ResourceHandler<T>
A ResourceHandler that allows insertion and extraction of an unlimited amount of a specified resource.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final T
    infiniteResource
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    InfiniteResourceHandler(T infiniteResource)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    extract(int index, T resource, int amount, TransactionContext transaction)
    Extracts up to the given amount of a resource from the handler at the given index.
    long
    getAmountAsLong(int index)
    Returns the amount of the currently stored resource at the given index, as a long.
    long
    getCapacityAsLong(int index, T resource)
    Returns the capacity of the handler at the given index and for the given resource, irrespective of the current amount or resource currently at that index, as a long.
    T
    getResource(int index)
    Returns the resource at the given index, which may be empty.
    int
    insert(int index, T resource, int amount, TransactionContext transaction)
    Inserts up to the given amount of a resource into the handler at the given index.
    boolean
    isValid(int index, T resource)
    Returns whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index.
    int
    size()
    Returns the current number of indices in this resource handler.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.neoforged.neoforge.transfer.ResourceHandler

    extract, getAmountAsInt, getCapacityAsInt, insert

  • Field Details

    • infiniteResource

      protected final T extends Resource infiniteResource

  • Constructor Details

    • InfiniteResourceHandler

      public InfiniteResourceHandler(T infiniteResource)
      Parameters:
      infiniteResource - The resource to be treated as infinite.

  • Method Details

    • size

      public int size()
      Description copied from interface: ResourceHandler
      Returns the current number of indices in this resource handler.

      This size provides a bound on the valid indices for this handler, see the documentation of ResourceHandler.

      Specified by:
      size in interface ResourceHandler<T extends Resource>
      Returns:
      The size of the resource handler. Can be 0 if the handler currently has no indices.

    • insert

      public int insert(int index, T resource, int amount, TransactionContext transaction)
      Description copied from interface: ResourceHandler
      Inserts up to the given amount of a resource into the handler at the given index.

      Changes to the handler are made in the context of a transaction.

      Specified by:
      insert in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to insert the resource into.
      resource - The resource to insert. Must be non-empty.
      amount - The maximum amount of the resource to insert. Must be non-negative.
      transaction - The transaction that this operation is part of.
      Returns:
      The amount that was inserted. Between 0 (inclusive, nothing was inserted) and amount (inclusive, everything was inserted).
      See Also:

    • extract

      public int extract(int index, T resource, int amount, TransactionContext transaction)
      Description copied from interface: ResourceHandler
      Extracts up to the given amount of a resource from the handler at the given index.

      Changes to the handler are made in the context of a transaction.

      Specified by:
      extract in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to extract the resource from.
      resource - The resource to extract. Must be non-empty.
      amount - The maximum amount of the resource to extract. Must be non-negative.
      transaction - The transaction that this operation is part of.
      Returns:
      The amount that was extracted. Between 0 (inclusive, nothing was extracted) and amount (inclusive, everything was extracted).
      See Also:

    • getResource

      public T getResource(int index)
      Description copied from interface: ResourceHandler
      Returns the resource at the given index, which may be empty.

      If the resource is empty, the stored amount must be 0.

      Specified by:
      getResource in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to get the resource from.
      Returns:
      the resource at the given index, which may be empty

    • getAmountAsLong

      public long getAmountAsLong(int index)
      Description copied from interface: ResourceHandler
      Returns the amount of the currently stored resource at the given index, as a long.

      In general, resource handlers can report long amounts. However, if the handler is known to only support amounts up to Integer.MAX_VALUE, or if the caller prefers to deal in ints only, the int-returning overload can be used instead.

      The returned amount must be non-negative. If the stored resource is empty, the amount must be 0.

      Specified by:
      getAmountAsLong in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to get the amount from.
      Returns:
      the amount at the given index, as a long
      See Also:

    • getCapacityAsLong

      public long getCapacityAsLong(int index, T resource)
      Description copied from interface: ResourceHandler
      Returns the capacity of the handler at the given index and for the given resource, irrespective of the current amount or resource currently at that index, as a long.

      In general, resource handlers can report long capacities. However, if the handler is known to only support capacities up to Integer.MAX_VALUE, or if the caller prefers to deal in ints only, the int-returning overload can be used instead.

      This function serves as a hint on the maximum amount the resource handler might contain, for example the handler can be considered full if amount >= capacity. Note that the returned capacity may overestimate the actual allowed amount, and it might be smaller than the current amount. The only way to know if a handler will accept a resource, is to try to insert it.

      Specified by:
      getCapacityAsLong in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to get the capacity for.
      resource - The resource to get the capacity for. May be empty to get the general capacity at the index.
      Returns:
      the capacity at the given index, as a long
      See Also:

    • isValid

      public boolean isValid(int index, T resource)
      Description copied from interface: ResourceHandler
      Returns whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index.

      This function serves as a hint on whether the resource handler can contain the resource or not. The only way to know if a handler will accept a resource, is to try to insert it.

      Specified by:
      isValid in interface ResourceHandler<T extends Resource>
      Parameters:
      index - The index to check.
      resource - The resource to check. Must be non-empty.
      Returns:
      whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index