RawComparable (Apache Hadoop Main 3.5.0 API)
Description: declaration: package: org.apache.hadoop.io.file.tfile, interface: RawComparable

Package org.apache.hadoop.io.file.tfile

# Interface RawComparable

@Public @Evolving public interface RawComparable
Interface for objects that can be compared through `RawComparator`. This is useful in places where we need a single object reference to specify a range of bytes in a byte array, such as `Comparable` or `Collections.binarySearch(java.util.List, Object, Comparator)` The actual comparison among RawComparable's requires an external RawComparator and it is applications' responsibility to ensure two RawComparable are supposed to be semantically comparable with the same RawComparator.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `byte[]`
  `buffer()`
  Get the underlying byte array.
  `int`
  `offset()`
  Get the offset of the first byte in the byte array.
  `int`
  `size()`
  Get the size of the byte range in the byte array.

- ## Method Details

  - ### buffer

    byte[] buffer()
    Get the underlying byte array.
    Returns:
      The underlying byte array.

  - ### offset

    int offset()
    Get the offset of the first byte in the byte array.
    Returns:
      The offset of the first byte in the byte array.

  - ### size

    int size()
    Get the size of the byte range in the byte array.
    Returns:
      The size of the byte range in the byte array.