Module org.elasticsearch.server
Package org.elasticsearch.common

Record Class Strings.TruncatedString

java.lang.Object
java.lang.Record
org.elasticsearch.common.Strings.TruncatedString
Record Components:
string - The string value.
truncated - true if the string was truncated, false otherwise.
Enclosing class:
Strings
public static record Strings.TruncatedString(String string, boolean truncated) extends Record
A small value class that represents a String that might be truncated.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TruncatedString(String string, boolean truncated)
    Creates an instance of a TruncatedString record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    appendIfTruncated(String suffix)
    Appends a given suffix and returns the result if the value if string was truncated; or the unchanged string otherwise.
    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.
    String
    string()
    Returns the value of the string record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    truncated()
    Returns the value of the truncated record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TruncatedString

      public TruncatedString(String string, boolean truncated)
      Creates an instance of a TruncatedString record class.
      Parameters:
      string - the value for the string record component
      truncated - the value for the truncated record component

  • Method Details

    • appendIfTruncated

      public String appendIfTruncated(String suffix)
      Appends a given suffix and returns the result if the value if string was truncated; or the unchanged string otherwise.
      Parameters:
      suffix - Suffix to append.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • string

      public String string()
      Returns the value of the string record component.
      Returns:
      the value of the string record component

    • truncated

      public boolean truncated()
      Returns the value of the truncated record component.
      Returns:
      the value of the truncated record component