Package sc.fiji.snt

Record Class SNTUtils.HeapInfo

java.lang.Object
java.lang.Record
sc.fiji.snt.SNTUtils.HeapInfo
Record Components:
maxMB - the -Xmx ceiling
totalMB - the current heap size
usedMB - totalMB minus current free memory
availableMB - maxMB - usedMB, i.e., how much more can still be allocated
Enclosing class:
SNTUtils
public static record SNTUtils.HeapInfo(long maxMB, long totalMB, long usedMB, long availableMB) extends Record
Snapshot of JVM heap usage in MB, derived from a single Runtime read.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HeapInfo(long maxMB, long totalMB, long usedMB, long availableMB)
    Creates an instance of a HeapInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    availableMB()
    Returns the value of the availableMB 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.
    long
    maxMB()
    Returns the value of the maxMB record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalMB()
    Returns the value of the totalMB record component.
    long
    usedMB()
    Returns the value of the usedMB record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HeapInfo

      public HeapInfo(long maxMB, long totalMB, long usedMB, long availableMB)
      Creates an instance of a HeapInfo record class.
      Parameters:
      maxMB - the value for the maxMB record component
      totalMB - the value for the totalMB record component
      usedMB - the value for the usedMB record component
      availableMB - the value for the availableMB record component

  • Method Details

    • 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 '=='.
      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.

    • maxMB

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

    • totalMB

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

    • usedMB

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

    • availableMB

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