Package energy.eddie.api.agnostic

Record Class EddieApiError

java.lang.Object
java.lang.Record
energy.eddie.api.agnostic.EddieApiError
Record Components:
message - Message describing the occurred error.
public record EddieApiError(String message) extends Record
Record holding the description of an error that occurred when an API of EDDIE was called. Can be extended by more fields. It is intended that an API controller advice returns a List of these errors.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EddieApiError(String message)
    Creates an instance of a EddieApiError record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    message()
    Returns the value of the message record component.
    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

    • EddieApiError

      public EddieApiError(String message)
      Creates an instance of a EddieApiError record class.
      Parameters:
      message - the value for the message 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. 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.

    • message

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