Package com.reduxrobotics.canand

Record Class CanandSettingsManager.SettingResult

java.lang.Object
java.lang.Record
com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Record Components:
value - the setting value, as a long
result - the result code associated with the operation.
Enclosing class:
CanandSettingsManager<T extends CanandSettings>
public static record CanandSettingsManager.SettingResult(long value, CanandSettingsManager.ResultCode result) extends Record
Record of setting results.

  • Field Details

  • Constructor Details

    • SettingResult

      public SettingResult(long value, CanandSettingsManager.ResultCode result)
      Creates an instance of a SettingResult record class.
      Parameters:
      value - the value for the value record component
      result - the value for the result record component

  • Method Details

    • toByteArray

      public void toByteArray(byte[] out)
      Copies the long-backed value to a byte array.
      Parameters:
      out - byte array

    • isValid

      public boolean isValid()
      Returns true if the result is valid.
      Returns:
      true on valid, false on invalid.

    • 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 long value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • result

      public CanandSettingsManager.ResultCode result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component