Record Class StorageInfo

java.lang.Object
java.lang.Record
com.refinedmods.refinedstorage.common.api.storage.StorageInfo
@API(status=STABLE, since="2.0.0-milestone.1.2") public record StorageInfo(long stored, long capacity) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final StorageInfo
    UNKNOWN
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    StorageInfo(long stored, long capacity)
    Creates an instance of a StorageInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    capacity()
    Returns the value of the capacity record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static StorageInfo
    of(Storage storage)
     
    long
    stored()
    Returns the value of the stored record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • StorageInfo

      public StorageInfo(long stored, long capacity)
      Creates an instance of a StorageInfo record class.
      Parameters:
      stored - the value for the stored record component
      capacity - the value for the capacity record component

  • Method Details

    • of

      public static StorageInfo of(Storage storage)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • stored

      public long stored()
      Returns the value of the stored record component.
      Returns:
      the value of the stored record component

    • capacity

      public long capacity()
      Returns the value of the capacity record component.
      Returns:
      the value of the capacity record component