refactor Brightness and Color into optional characteristics on base Lightbulb

maintaining compatibility with the now-deprecated DimmableLightbulb and
ColorfulLightbulb interfaces

Author: ccutrer

src/main/java/com/beowulfe/hap/accessories/ColorfulLightbulb.java

@@ -1,65 +1,18 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import java.util.concurrent.CompletableFuture;
+import com.beowulfe.hap.accessories.characteristics.Color;
+import java.util.Optional;
 
 /**
- * Extends {@link Lightbulb} with color settings. This will usually be implemented along with {@link
- * DimmableLightbulb}, but not necessarily so.
+ * Extends {@link com.beowulfe.hap.accessories.Lightbulb} with color settings. This will usually be
+ * implemented along with {@link DimmableLightbulb}, but not necessarily so.
  *
  * @author Andy Lintner
  */
-public interface ColorfulLightbulb extends Lightbulb {
-
-  /**
-   * Retrieves the current hue of the light.
-   *
-   * @return a future that will contain the hue, expressed in arc degrees from 0 to 360.
-   */
-  CompletableFuture<Double> getHue();
-
-  /**
-   * Sets the current hue of the light
-   *
-   * @param value the hue to set, expressed in arc degrees from 0 to 360.
-   * @return a future that completes when the hue is changed
-   * @throws Exception when the hue cannot be changed.
-   */
-  CompletableFuture<Void> setHue(Double value) throws Exception;
-
-  /**
-   * Subscribes to changes in the hue of the light.
-   *
-   * @param callback the function to call when the state changes.
-   */
-  void subscribeHue(HomekitCharacteristicChangeCallback callback);
-
-  /** Unsubscribes from changes in the hue of the light. */
-  void unsubscribeHue();
-
-  /**
-   * Retrieves the saturation of the light.
-   *
-   * @return a future that will contain the saturation, expressed as a value between 0 and 100.
-   */
-  CompletableFuture<Double> getSaturation();
-
-  /**
-   * Sets the saturation of the light.
-   *
-   * @param value the saturation to set, expressed as a value between 0 and 100.
-   * @return a future that completes when the saturation is changed.
-   * @throws Exception when the saturation cannot be set.
-   */
-  CompletableFuture<Void> setSaturation(Double value) throws Exception;
-
-  /**
-   * Subscribes to changes in the saturation of the light.
-   *
-   * @param callback the function to call when the state changes.
-   */
-  void subscribeSaturation(HomekitCharacteristicChangeCallback callback);
-
-  /** Unsubscribes from changes in the saturation of the light. */
-  void unsubscribeSaturation();
+@Deprecated
+public interface ColorfulLightbulb extends Lightbulb, Color {
+  @Override
+  default Optional<Color> getColorCharacteristics() {
+    return Optional.of(this);
+  }
 }

src/main/java/com/beowulfe/hap/accessories/DimmableLightbulb.java

@@ -1,38 +1,17 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import java.util.concurrent.CompletableFuture;
+import com.beowulfe.hap.accessories.characteristics.Brightness;
+import java.util.Optional;
 
 /**
  * Extends {@link Lightbulb} with brightness values.
  *
  * @author Andy Lintner
  */
-public interface DimmableLightbulb extends Lightbulb {
-
-  /**
-   * Retrieves the current brightness of the light
-   *
-   * @return a future that will contain the brightness, expressed as an integer between 0 and 100.
-   */
-  CompletableFuture<Integer> getBrightness();
-
-  /**
-   * Sets the current brightness of the light
-   *
-   * @param value the brightness, on a scale of 0 to 100, to set
-   * @return a future that completes when the brightness is changed
-   * @throws Exception when the brightness cannot be set
-   */
-  CompletableFuture<Void> setBrightness(Integer value) throws Exception;
-
-  /**
-   * Subscribes to changes in the brightness of the light.
-   *
-   * @param callback the function to call when the state changes.
-   */
-  void subscribeBrightness(HomekitCharacteristicChangeCallback callback);
-
-  /** Unsubscribes from changes in the brightness of the light. */
-  void unsubscribeBrightness();
+@Deprecated
+public interface DimmableLightbulb extends Lightbulb, Brightness {
+  @Override
+  default Optional<Brightness> getBrightnessCharacteristic() {
+    return Optional.of(this);
+  }
 }

src/main/java/com/beowulfe/hap/accessories/Lightbulb.java

@@ -1,9 +1,12 @@
 package com.beowulfe.hap.accessories;
 
 import com.beowulfe.hap.*;
+import com.beowulfe.hap.accessories.characteristics.Brightness;
+import com.beowulfe.hap.accessories.characteristics.Color;
 import com.beowulfe.hap.impl.services.LightbulbService;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 
 /**
@@ -43,4 +46,16 @@ default Collection<Service> getServices() {
 
   /** Unsubscribes from changes in the binary state of the light. */
   void unsubscribeLightbulbPowerState();
+
+  /** returns the optional implementation of Brightness */
+  default Optional<Brightness> getBrightnessCharacteristic() {
+    Optional<Brightness> result = Optional.empty();
+    return result;
+  }
+
+  /** returns the optional implementation of Color */
+  default Optional<Color> getColorCharacteristics() {
+    Optional<Color> result = Optional.empty();
+    return result;
+  }
 }

src/main/java/com/beowulfe/hap/accessories/characteristics/Brightness.java

@@ -0,0 +1,32 @@
+package com.beowulfe.hap.accessories.characteristics;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+public interface Brightness {
+  /**
+   * Retrieves the current brightness of the light
+   *
+   * @return a future that will contain the brightness, expressed as an integer between 0 and 100.
+   */
+  CompletableFuture<Integer> getBrightness();
+
+  /**
+   * Sets the current brightness of the light
+   *
+   * @param value the brightness, on a scale of 0 to 100, to set
+   * @return a future that completes when the brightness is changed
+   * @throws Exception when the brightness cannot be set
+   */
+  CompletableFuture<Void> setBrightness(Integer value) throws Exception;
+
+  /**
+   * Subscribes to changes in the brightness of the light.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeBrightness(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the brightness of the light. */
+  void unsubscribeBrightness();
+}

src/main/java/com/beowulfe/hap/accessories/characteristics/Color.java

@@ -0,0 +1,64 @@
+package com.beowulfe.hap.accessories.characteristics;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Extends a Lightbulb with color settings. This will usually be implemented along with {@link
+ * Brightness}, but not necessarily so.
+ *
+ * @author Andy Lintner
+ */
+public interface Color {
+  /**
+   * Retrieves the current hue of the light.
+   *
+   * @return a future that will contain the hue, expressed in arc degrees from 0 to 360.
+   */
+  CompletableFuture<Double> getHue();
+
+  /**
+   * Sets the current hue of the light
+   *
+   * @param value the hue to set, expressed in arc degrees from 0 to 360.
+   * @return a future that completes when the hue is changed
+   * @throws Exception when the hue cannot be changed.
+   */
+  CompletableFuture<Void> setHue(Double value) throws Exception;
+
+  /**
+   * Subscribes to changes in the hue of the light.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeHue(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the hue of the light. */
+  void unsubscribeHue();
+
+  /**
+   * Retrieves the saturation of the light.
+   *
+   * @return a future that will contain the saturation, expressed as a value between 0 and 100.
+   */
+  CompletableFuture<Double> getSaturation();
+
+  /**
+   * Sets the saturation of the light.
+   *
+   * @param value the saturation to set, expressed as a value between 0 and 100.
+   * @return a future that completes when the saturation is changed.
+   * @throws Exception when the saturation cannot be set.
+   */
+  CompletableFuture<Void> setSaturation(Double value) throws Exception;
+
+  /**
+   * Subscribes to changes in the saturation of the light.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeSaturation(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the saturation of the light. */
+  void unsubscribeSaturation();
+}

src/main/java/com/beowulfe/hap/impl/characteristics/lightbulb/BrightnessCharacteristic.java

@@ -1,17 +1,17 @@
 package com.beowulfe.hap.impl.characteristics.lightbulb;
 
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import com.beowulfe.hap.accessories.DimmableLightbulb;
+import com.beowulfe.hap.accessories.characteristics.Brightness;
 import com.beowulfe.hap.characteristics.EventableCharacteristic;
 import com.beowulfe.hap.characteristics.IntegerCharacteristic;
 import java.util.concurrent.CompletableFuture;
 
 public class BrightnessCharacteristic extends IntegerCharacteristic
     implements EventableCharacteristic {
 
-  private final DimmableLightbulb lightbulb;
+  private final Brightness lightbulb;
 
-  public BrightnessCharacteristic(DimmableLightbulb lightbulb) {
+  public BrightnessCharacteristic(Brightness lightbulb) {
     super(
         "00000008-0000-1000-8000-0026BB765291",
         true,

src/main/java/com/beowulfe/hap/impl/characteristics/lightbulb/HueCharacteristic.java

@@ -1,16 +1,16 @@
 package com.beowulfe.hap.impl.characteristics.lightbulb;
 
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import com.beowulfe.hap.accessories.ColorfulLightbulb;
+import com.beowulfe.hap.accessories.characteristics.Color;
 import com.beowulfe.hap.characteristics.EventableCharacteristic;
 import com.beowulfe.hap.characteristics.FloatCharacteristic;
 import java.util.concurrent.CompletableFuture;
 
 public class HueCharacteristic extends FloatCharacteristic implements EventableCharacteristic {
 
-  private final ColorfulLightbulb lightbulb;
+  private final Color lightbulb;
 
-  public HueCharacteristic(ColorfulLightbulb lightbulb) {
+  public HueCharacteristic(Color lightbulb) {
     super(
         "00000013-0000-1000-8000-0026BB765291",
         true,

src/main/java/com/beowulfe/hap/impl/characteristics/lightbulb/SaturationCharacteristic.java

@@ -1,17 +1,17 @@
 package com.beowulfe.hap.impl.characteristics.lightbulb;
 
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import com.beowulfe.hap.accessories.ColorfulLightbulb;
+import com.beowulfe.hap.accessories.characteristics.Color;
 import com.beowulfe.hap.characteristics.EventableCharacteristic;
 import com.beowulfe.hap.characteristics.FloatCharacteristic;
 import java.util.concurrent.CompletableFuture;
 
 public class SaturationCharacteristic extends FloatCharacteristic
     implements EventableCharacteristic {
 
-  private final ColorfulLightbulb lightbulb;
+  private final Color lightbulb;
 
-  public SaturationCharacteristic(ColorfulLightbulb lightbulb) {
+  public SaturationCharacteristic(Color lightbulb) {
     super(
         "0000002F-0000-1000-8000-0026BB765291",
         true,

src/main/java/com/beowulfe/hap/impl/services/LightbulbService.java

@@ -1,7 +1,5 @@
 package com.beowulfe.hap.impl.services;
 
-import com.beowulfe.hap.accessories.ColorfulLightbulb;
-import com.beowulfe.hap.accessories.DimmableLightbulb;
 import com.beowulfe.hap.accessories.Lightbulb;
 import com.beowulfe.hap.impl.characteristics.common.PowerStateCharacteristic;
 import com.beowulfe.hap.impl.characteristics.lightbulb.BrightnessCharacteristic;
@@ -23,13 +21,16 @@ public LightbulbService(Lightbulb lightbulb, String serviceName) {
             c -> lightbulb.subscribeLightbulbPowerState(c),
             () -> lightbulb.unsubscribeLightbulbPowerState()));
 
-    if (lightbulb instanceof DimmableLightbulb) {
-      addCharacteristic(new BrightnessCharacteristic((DimmableLightbulb) lightbulb));
-    }
+    lightbulb
+        .getBrightnessCharacteristic()
+        .ifPresent(brightness -> addCharacteristic(new BrightnessCharacteristic(brightness)));
 
-    if (lightbulb instanceof ColorfulLightbulb) {
-      addCharacteristic(new HueCharacteristic((ColorfulLightbulb) lightbulb));
-      addCharacteristic(new SaturationCharacteristic((ColorfulLightbulb) lightbulb));
-    }
+    lightbulb
+        .getColorCharacteristics()
+        .ifPresent(
+            color -> {
+              addCharacteristic(new HueCharacteristic(color));
+              addCharacteristic(new SaturationCharacteristic(color));
+            });
   }
 }