Package dev.digiried.wattpilot.commands

Record Class CommandResponse

java.lang.Object
java.lang.Record
dev.digiried.wattpilot.commands.CommandResponse
Record Components:
success - whether the command was successful
status - The partial status received. Contains only the new values of the changed parameters.
public record CommandResponse(boolean success, PartialStatus status) extends Record
Record for the response of a Command.
Author:
Florian Hotze - Initial contribution

  • Constructor Details

    • CommandResponse

      public CommandResponse(boolean success, PartialStatus status)
      Creates an instance of a CommandResponse record class.
      Parameters:
      success - the value for the success record component
      status - the value for the status 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.

    • success

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

    • status

      public PartialStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component