BytesRefArray.SortState (Lucene 10.5.1 core API)
Description: declaration: package: org.apache.lucene.util, class: BytesRefArray, class: SortState

Package org.apache.lucene.util

# Class BytesRefArray.SortState

java.lang.Object
org.apache.lucene.util.BytesRefArray.SortState

All Implemented Interfaces:
  `Accountable`

Enclosing class:
  `BytesRefArray`

public static final class BytesRefArray.SortState extends Object implements Accountable
Used to iterate the elements of an array in a given order.

- ## Field Summary

  ### Fields inherited from interface org.apache.lucene.util.Accountable

  `NULL_ACCOUNTABLE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `long`
  `ramBytesUsed()`
  Returns an estimate of the JVM heap memory used by this object in bytes.

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface org.apache.lucene.util.Accountable

  `getChildResources`

- ## Method Details

  - ### ramBytesUsed

    public long ramBytesUsed()
    Description copied from interface: `Accountable`
    Returns an estimate of the JVM heap memory used by this object in bytes. The method name uses "ram" for historical reasons; only JVM heap memory should be reported. Off-heap resources such as memory-mapped files or native direct buffers should not be included. Negative values are illegal.
    Specified by:
      `ramBytesUsed` in interface `Accountable`