Package com.atlassian.jira.search

Record Class TextFieldValueLoader

java.lang.Object
java.lang.Record
com.atlassian.jira.search.TextFieldValueLoader
All Implemented Interfaces:
FieldValueLoader<String>
public record TextFieldValueLoader(String field) extends Record implements FieldValueLoader<String>
Since:
10.4

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextFieldValueLoader(String field)
    Creates an instance of a TextFieldValueLoader record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    field()
    Returns the value of the field record component.
    Comparator<String>
    getComparator()
    A comparator by which the resulting values should be ordered when multiple values are present.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    loadValue(String documentValue)
    Convert the document field back to the object that you wish to use to display it.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TextFieldValueLoader

      public TextFieldValueLoader(String field)
      Creates an instance of a TextFieldValueLoader record class.
      Parameters:
      field - the value for the field record component

  • Method Details

    • loadValue

      public String loadValue(@Nullable String documentValue)
      Description copied from interface: FieldValueLoader
      Convert the document field back to the object that you wish to use to display it.

      e.g. '1000' -> Version 1.

      For custom fields, the return value will be passed to CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)

      Specified by:
      loadValue in interface FieldValueLoader<String>
      Parameters:
      documentValue - The value of the field in the index or null if no values exist
      Returns:
      The value that will be passed to the display

    • getComparator

      public Comparator<String> getComparator()
      Description copied from interface: FieldValueLoader
      A comparator by which the resulting values should be ordered when multiple values are present.

      The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.

      Specified by:
      getComparator in interface FieldValueLoader<String>

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • field

      public String field()
      Returns the value of the field record component.
      Specified by:
      field in interface FieldValueLoader<String>
      Returns:
      the value of the field record component