Record Class TunableOption.Polling

java.lang.Object

java.lang.Record

org.wpilib.tunable.TunableOption.Polling

Record Components:

polling - polling behavior

All Implemented Interfaces:

TunableOption

Enclosing interface:

TunableOption

public static record TunableOption.Polling(TunableConfig.Polling polling)
extends Record
implements TunableOption

Defines when the backend should poll the tunable's local value.

Nested Class Summary

Nested classes/interfaces inherited from interface TunableOption

TunableOption.Mutable, TunableOption.OnTune, TunableOption.Polling, TunableOption.Property, TunableOption.Robust, TunableOption.TypeString

Field Summary

Fields inherited from interface TunableOption

ALWAYS_GET, GET_ON_CHANGE, IMMUTABLE, MUTABLE, NOT_ROBUST, ROBUST

Constructor Summary

Constructors

Constructor	Description
Polling(TunableConfig.Polling polling)	Creates a polling option.

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.
TunableConfig.Polling	polling()	Returns the value of the polling record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Polling

public Polling(TunableConfig.Polling polling)

Creates a polling option.

Parameters:

polling - polling behavior

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.

polling

public TunableConfig.Polling polling()

Returns the value of the polling record component.

Returns:

the value of the polling record component