Package app.valuationcontrol.multimodule.library.records

Record Class ReviewResponse

java.lang.Object
java.lang.Record
app.valuationcontrol.multimodule.library.records.ReviewResponse
public record ReviewResponse(long variableId, int score, String explanation, String suggestion) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReviewResponse(long variableId, int score, String explanation, String suggestion)
    Creates an instance of a ReviewResponse 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
    explanation()
    Returns the value of the explanation record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    score()
    Returns the value of the score record component.
    String
    suggestion()
    Returns the value of the suggestion record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    variableId()
    Returns the value of the variableId record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReviewResponse

      public ReviewResponse(@JsonPropertyDescription("the id of the rated variable") long variableId, @JsonPropertyDescription("the score describing the reasonableness of the forecasted values. 1 is stable, 2 is volatile, 3 is abnormal") int score, @JsonPropertyDescription("the explanation for the score, no more than 20 words") String explanation, @JsonPropertyDescription("A suggested replacement for improving the modelling of the variable") String suggestion)
      Creates an instance of a ReviewResponse record class.
      Parameters:
      variableId - the value for the variableId record component
      score - the value for the score record component
      explanation - the value for the explanation record component
      suggestion - the value for the suggestion 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 '=='.
      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.

    • variableId

      @JsonPropertyDescription("the id of the rated variable") public long variableId()
      Returns the value of the variableId record component.
      Returns:
      the value of the variableId record component

    • score

      @JsonPropertyDescription("the score describing the reasonableness of the forecasted values. 1 is stable, 2 is volatile, 3 is abnormal") public int score()
      Returns the value of the score record component.
      Returns:
      the value of the score record component

    • explanation

      @JsonPropertyDescription("the explanation for the score, no more than 20 words") public String explanation()
      Returns the value of the explanation record component.
      Returns:
      the value of the explanation record component

    • suggestion

      @JsonPropertyDescription("A suggested replacement for improving the modelling of the variable") public String suggestion()
      Returns the value of the suggestion record component.
      Returns:
      the value of the suggestion record component