Record Class TunableOption.Mutable

java.lang.Object
java.lang.Record
org.wpilib.tunable.TunableOption.Mutable
Record Components:
isMutable - whether the tunable is mutable
All Implemented Interfaces:
TunableOption
Enclosing interface:
TunableOption
public static record TunableOption.Mutable(boolean isMutable) extends Record implements TunableOption
By default, Tunables may be set by a remote source (e.g. a dashboard). Setting mutability to false makes the tunable immutable, meaning that the Tunable's set() function will not be called. This is useful for tunables that should only be changed locally, such as ones that represent a constant or a tunable that is only meant to be changed programmatically.

  • Constructor Details

    • Mutable

      public Mutable(boolean isMutable)
      Creates an instance of a Mutable record class.
      Parameters:
      isMutable - the value for the isMutable 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 the compare method from their corresponding wrapper classes.
      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.

    • isMutable

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