TunableBoolean.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.function.BooleanSupplier;
import org.wpilib.util.function.BooleanConsumer;

public abstract class TunableBoolean extends TunableBase
    implements BooleanSupplier, BooleanConsumer {
  public static TunableBoolean create() {
    return create(false);
  }

  public static TunableBoolean create(boolean initialValue) {
    return createConfig(initialValue, null);
  }

  public static TunableBoolean create(BooleanSupplier getter, BooleanConsumer setter) {
    return createConfig(getter, setter, null);
  }

  public static TunableBoolean createConfig(TunableConfig config) {
    return createConfig(false, config);
  }

  public static TunableBoolean createConfig(boolean initialValue, TunableConfig config) {
    return new TunableBoolean(config, true) {
      @Override
      public void set(boolean value) {
        if (m_value == value) {
          return;
        }
        m_value = value;
        markChanged();
      }
 
      @Override
      public boolean get() {
        return m_value;
      }
 
      private boolean m_value = initialValue;
    };
  }

  public static TunableBoolean createConfig(
      BooleanSupplier getter, BooleanConsumer setter, TunableConfig config) {
    if (config == null) {
      config = TunableConfig.of(TunableOption.ALWAYS_GET);
    } else if (config.getPolling() == TunableConfig.Polling.DEFAULT) {
      config = config.withPolling(TunableConfig.Polling.ALWAYS_GET);
    }
    return new TunableBoolean(config, true) {
      @Override
      public void set(boolean value) {
        boolean changed = getter.getAsBoolean() != value;
        if (setter != null) {
          setter.accept(value);
        }
        if (changed) {
          markChanged();
        }
      }
 
      @Override
      public boolean get() {
        return getter.getAsBoolean();
      }
    };
  }

  protected TunableBoolean(TunableConfig config) {
    super(config);
  }

  protected TunableBoolean(TunableConfig config, boolean supportsChangeNotification) {
    super(config, supportsChangeNotification);
  }

  public abstract void set(boolean value);

  public abstract boolean get();
 
  @Override
  public boolean getAsBoolean() {
    return get();
  }
 
  @Override
  public void accept(boolean value) {
    set(value);
  }
}