Record Class TunableOption.OnTune

java.lang.Object
java.lang.Record
org.wpilib.tunable.TunableOption.OnTune
Record Components:
callback - the callback to call when the tunable is modified
All Implemented Interfaces:
TunableOption
Enclosing interface:
TunableOption
public static record TunableOption.OnTune(Runnable callback) extends Record implements TunableOption
Callback to call when the tunable is modified via tune(). This is called immediately after the tunable's tune() function is called. The callback will be called by TunableRegistry.update() and must not throw.

  • Constructor Details

    • OnTune

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

    • callback

      public Runnable callback()
      Returns the value of the callback record component.
      Returns:
      the value of the callback record component