TunableOption.java

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
package org.wpilib.tunable;
 
import java.util.Objects;

public sealed interface TunableOption {
  record Robust(boolean value) implements TunableOption {}

  record Property(String key, String value) implements TunableOption {}

  record TypeString(String typeString) implements TunableOption {}

  record Mutable(boolean isMutable) implements TunableOption {}

  record OnTune(Runnable callback) implements TunableOption {}

  record Polling(TunableConfig.Polling polling) implements TunableOption {
    public Polling {
      Objects.requireNonNull(polling, "polling");
    }
  }

  TunableOption ROBUST = new Robust(true);

  TunableOption NOT_ROBUST = new Robust(false);

  TunableOption MUTABLE = new Mutable(true);

  TunableOption IMMUTABLE = new Mutable(false);

  TunableOption GET_ON_CHANGE = new Polling(TunableConfig.Polling.GET_ON_CHANGE);

  TunableOption ALWAYS_GET = new Polling(TunableConfig.Polling.ALWAYS_GET);

  static TunableOption property(String key, String value) {
    return new Property(key, value);
  }

  static TunableOption typeString(String typeString) {
    return new TypeString(typeString);
  }

  static TunableOption onTune(Runnable callback) {
    return new OnTune(callback);
  }

  static TunableOption polling(TunableConfig.Polling polling) {
    return new Polling(polling);
  }
}