ToStringUtils (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.util, class: ToStringUtils

Package org.apache.lucene.util

# Class ToStringUtils

java.lang.Object
org.apache.lucene.util.ToStringUtils

public final class ToStringUtils extends Object
Helper methods to ease implementing `Object.toString()`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static void`
  `byteArray(StringBuilder buffer, byte[] bytes)`
  `static String`
  `bytesRefToString(byte[] b)`
  `static String`
  `bytesRefToString(BytesRef b)`
  Builds a String with both textual representation of the `BytesRef` data and the bytes hex values.
  `static String`
  `bytesRefToString(BytesRefBuilder b)`
  `static String`
  `longHex(long x)`
  Unlike `Long.toHexString(long)` returns a String with a "0x" prefix and all the leading zeros.

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

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

- ## Method Details

  - ### byteArray

    public static void byteArray(StringBuilder buffer, byte[] bytes)

  - ### longHex

    public static String longHex(long x)
    Unlike `Long.toHexString(long)` returns a String with a "0x" prefix and all the leading zeros.

  - ### bytesRefToString

    public static String bytesRefToString(BytesRef b)
    Builds a String with both textual representation of the `BytesRef` data and the bytes hex values. For example: `"hello [68 65 6c 6c 6f]"`. If the content is not a valid UTF-8 sequence, only the bytes hex values are returned, as per `BytesRef.toString()`.

  - ### bytesRefToString

    public static String bytesRefToString(BytesRefBuilder b)

  - ### bytesRefToString

    public static String bytesRefToString(byte[] b)