core/org.gnit.lucenekmp.util/BytesRef

BytesRef

Represents byte[], as a slice (offset + length) into an existing byte[]. The bytes property should never be null; use EMPTY_BYTES if necessary.

Important note: Unless otherwise noted, Lucene uses this class to represent terms that are encoded as UTF8 bytes in the index. To convert them to a String, use utf8ToString.

BytesRef implements Comparable. The underlying byte arrays are sorted lexicographically, numerically treating elements as unsigned.

Constructors

BytesRef

constructor()

Create a BytesRef with EMPTY_BYTES

constructor(bytes: ByteArray, offset: Int, length: Int)

This instance will directly reference bytes w/o making a copy. bytes should not be null.

constructor(bytes: ByteArray)

This instance will directly reference bytes w/o making a copy. bytes should not be null

constructor(capacity: Int)

Create a BytesRef pointing to a new array of size capacity. Offset and length will both be zero.

constructor(text: CharSequence)

Initialize the byte[] from the UTF8 bytes for the provided String.

Types

Companion

object Companion

Properties

bytes

var bytes: ByteArray

The contents of the BytesRef. Should never be null.

length

var length: Int

Length of used bytes.

offset

var offset: Int

Offset of first valid byte.

Functions

bytesEquals

fun bytesEquals(other: BytesRef): Boolean

Expert: compares the bytes against another BytesRef, returning true if the bytes are equal.

clone

fun clone(): BytesRef

Returns a shallow clone of this instance (the underlying bytes are not copied and will be shared by both the returned object and this object.

compareTo

open operator override fun compareTo(other: BytesRef): Int

Unsigned byte order comparison

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

Calculates the hash code.

isValid

fun isValid(): Boolean

Performs internal consistency checks. Always returns true (or throws exception)

toString

open override fun toString(): String

Returns hex encoded bytes, e.g. "6c 75 63 65 6e 65"

utf8ToString

fun utf8ToString(): String

Interprets stored bytes as UTF-8 bytes, returning the resulting string.