Record Class Trend

java.lang.Object
java.lang.Record
com.djrapitops.plan.delivery.rendering.json.Trend

public record Trend(Number text, String direction, boolean reversed) extends Record
Represents a trend in the data - used for JSON format.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    When a trend is reversed increase is "bad" (red) and decrease is "good" (green)
  • Constructor Summary

    Constructors
    Constructor
    Description
    Trend(double before, double after, boolean reversed)
     
    Trend(long before, long after, boolean reversed)
     
    Trend(Number text, String direction, boolean reversed)
    Creates an instance of a Trend record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the direction record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the reversed record component.
    Returns the value of the text record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • REVERSED

      public static final boolean REVERSED
      When a trend is reversed increase is "bad" (red) and decrease is "good" (green)
      See Also:
  • Constructor Details

    • Trend

      public Trend(long before, long after, boolean reversed)
    • Trend

      public Trend(double before, double after, boolean reversed)
    • Trend

      public Trend(Number text, String direction, boolean reversed)
      Creates an instance of a Trend record class.
      Parameters:
      text - the value for the text record component
      direction - the value for the direction record component
      reversed - the value for the reversed record component
  • Method Details

    • 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 the compare method from their corresponding wrapper classes.
      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.
    • text

      public Number text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component
    • direction

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

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