Package io.fusionauth.http.util

Record Class WeightedString

java.lang.Object
java.lang.Record
io.fusionauth.http.util.WeightedString
All Implemented Interfaces:
Comparable<WeightedString>
public record WeightedString(String value, double weight, int position) extends Record implements Comparable<WeightedString>
A simple weighted string class that allows weighted headers and other values to be sorted.
Author:
Brian Pontarelli

  • Constructor Summary

    Constructors
    Constructor
    Description
    WeightedString(String value, double weight, int position)
    Creates an instance of a WeightedString record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(WeightedString o)
     
    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.
    int
    position()
    Returns the value of the position record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    Returns the value of the value record component.
    double
    weight()
    Returns the value of the weight record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WeightedString

      public WeightedString(String value, double weight, int position)
      Creates an instance of a WeightedString record class.
      Parameters:
      value - the value for the value record component
      weight - the value for the weight record component
      position - the value for the position record component

  • Method Details

    • compareTo

      public int compareTo(WeightedString o)
      Specified by:
      compareTo in interface Comparable<WeightedString>

    • 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.

    • value

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

    • weight

      public double weight()
      Returns the value of the weight record component.
      Returns:
      the value of the weight record component

    • position

      public int position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component