[hdpowerview] Change method names to match documentation (#12796)

* [hdpowerview] refactor method names

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

diff --git a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/api/ShadePosition.java b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/api/ShadePosition.java
index 1c397d60bbac465abd313c71df64e49bdcc9926b..00ca32976034ba193829f3fcff535aaf0aebbbdc 100644 (file)
--- a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/api/ShadePosition.java
+++ b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/api/ShadePosition.java
@@ -101,7 +101,7 @@ public class ShadePosition {
                  * Secondary, upper rail of a dual action shade: => NOT INVERTED
                  */
                 posKind1 = posKindCoords.ordinal();
-                if (shadeCapabilities.supportsBlackoutShade()) {
+                if (shadeCapabilities.supportsSecondaryOverlapped()) {
                     position1 = MAX_SHADE - (int) Math.round((double) percent / 100 * MAX_SHADE);
                 } else {
                     position1 = (int) Math.round((double) percent / 100 * MAX_SHADE);
@@ -142,7 +142,7 @@ public class ShadePosition {
                 if (VANE_TILT_POSITION.equals(posKind1) && shadeCapabilities.supportsTiltOnClosed()) {
                     return PercentType.HUNDRED;
                 }
-                if (SECONDARY_POSITION.equals(posKind1) && shadeCapabilities.supportsBlackoutShade()) {
+                if (SECONDARY_POSITION.equals(posKind1) && shadeCapabilities.supportsSecondaryOverlapped()) {
                     return PercentType.HUNDRED;
                 }
                 break;
@@ -153,12 +153,12 @@ public class ShadePosition {
                  * Secondary, upper rail of a dual action shade: => NOT INVERTED
                  */
                 if (posKindCoords.equals(posKind1)) {
-                    if (shadeCapabilities.supportsBlackoutShade()) {
+                    if (shadeCapabilities.supportsSecondaryOverlapped()) {
                         return new PercentType(100 - (int) Math.round((double) position1 / MAX_SHADE * 100));
                     }
                     return new PercentType((int) Math.round((double) position1 / MAX_SHADE * 100));
                 }
-                if (PRIMARY_POSITION.equals(posKind1) && shadeCapabilities.supportsBlackoutShade()) {
+                if (PRIMARY_POSITION.equals(posKind1) && shadeCapabilities.supportsSecondaryOverlapped()) {
                     return PercentType.ZERO;
                 }
                 break;
@@ -351,7 +351,7 @@ public class ShadePosition {
                     } else {
                         setPosition1(shadeCapabilities, posKindCoords, percent);
                     }
-                } else if (shadeCapabilities.supportsBlackoutShade()) {
+                } else if (shadeCapabilities.supportsSecondaryOverlapped()) {
                     setPosition1(shadeCapabilities, posKindCoords, percent);
                 }
                 break;

diff --git a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/database/ShadeCapabilitiesDatabase.java b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/database/ShadeCapabilitiesDatabase.java
index 930640f53efd49d93ff96ff8ab31a16bec8f27d2..a28a8291bb9ce43d685c0e041bb13ac200f8a315 100644 (file)
--- a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/database/ShadeCapabilitiesDatabase.java
+++ b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/database/ShadeCapabilitiesDatabase.java
@@ -40,16 +40,16 @@ public class ShadeCapabilitiesDatabase {
      */
     private static final Map<Integer, Capabilities> CAPABILITIES_DATABASE = Arrays.asList(
     // @formatter:off
-            new Capabilities(0).primary().tiltOnClosed()                      .text("Bottom Up"),
-            new Capabilities(1).primary().tiltOnClosed()                      .text("Bottom Up Tilt 90°"),
-            new Capabilities(2).primary().tiltAnywhere().tilt180()            .text("Bottom Up Tilt 180°"),
-            new Capabilities(3).primary().tiltOnClosed()                      .text("Vertical"),
-            new Capabilities(4).primary().tiltAnywhere().tilt180()            .text("Vertical Tilt 180°"),
-            new Capabilities(5)          .tiltAnywhere().tilt180()            .text("Tilt Only 180°"),
-            new Capabilities(6).primary()                                     .text("Top Down")                 .primaryStateInverted(),
-            new Capabilities(7).primary()                         .secondary().text("Top Down Bottom Up"),
-            new Capabilities(8).primary()                                     .text("Duolite Lift")             .withBlackoutShade(),
-            new Capabilities(9).primary().tiltAnywhere()                      .text("Duolite Lift and Tilt 90°").withBlackoutShade(),
+            new Capabilities(0).primary()        .tiltOnClosed()                                .text("Bottom Up"),
+            new Capabilities(1).primary()        .tiltOnClosed()                                .text("Bottom Up Tilt 90°"),
+            new Capabilities(2).primary()        .tiltAnywhere().tilt180()                      .text("Bottom Up Tilt 180°"),
+            new Capabilities(3).primary()        .tiltOnClosed()                                .text("Vertical"),
+            new Capabilities(4).primary()        .tiltAnywhere().tilt180()                      .text("Vertical Tilt 180°"),
+            new Capabilities(5)                  .tiltAnywhere().tilt180()                      .text("Tilt Only 180°"),
+            new Capabilities(6).primaryInverted()                                               .text("Top Down"),
+            new Capabilities(7).primary()                                 .secondary()          .text("Top Down Bottom Up"),
+            new Capabilities(8).primary()                                 .secondaryOverlapped().text("Duolite Lift"),
+            new Capabilities(9).primary()        .tiltAnywhere()          .secondaryOverlapped().text("Duolite Lift and Tilt 90°"),
     // @formatter:on
             new Capabilities()).stream().collect(Collectors.toMap(Capabilities::getValue, Function.identity()));
 
@@ -149,15 +149,15 @@ public class ShadeCapabilitiesDatabase {
         private boolean supportsSecondary;
         private boolean supportsTiltOnClosed;
         private boolean supportsTiltAnywhere;
-        private boolean supportsBlackoutShade;
-        private boolean primaryStateInverted;
+        private boolean supportsSecondaryOverlapped;
+        private boolean primaryInverted;
         private boolean tilt180Degrees;
 
         public Capabilities() {
         }
 
-        protected Capabilities withBlackoutShade() {
-            supportsBlackoutShade = true;
+        protected Capabilities secondaryOverlapped() {
+            supportsSecondaryOverlapped = true;
             return this;
         }
 
@@ -190,8 +190,9 @@ public class ShadeCapabilitiesDatabase {
             return this;
         }
 
-        protected Capabilities primaryStateInverted() {
-            primaryStateInverted = true;
+        protected Capabilities primaryInverted() {
+            supportsPrimary = true;
+            primaryInverted = true;
             return this;
         }
 
@@ -228,21 +229,21 @@ public class ShadeCapabilitiesDatabase {
         }
 
         /**
-         * Check if the Capabilities class instance supports a secondary shade.
+         * Check if the Capabilities class instance if the primary shade is inverted.
          *
          * @return true if the primary shade is inverted.
          */
-        public boolean isPrimaryStateInverted() {
-            return primaryStateInverted;
+        public boolean isPrimaryInverted() {
+            return primaryInverted;
         }
 
         /**
-         * Check if the Capabilities class instance supports 'tilt when closed'.
+         * Check if the Capabilities class instance supports 'tilt on closed'.
          *
          * Note: Simple bottom up or vertical shades that do not have independent vane controls, can be tilted in a
          * simple way, only when they are fully closed, by moving the shade motor a bit further.
          *
-         * @return true if the primary shade is inverted.
+         * @return true if the it supports tilt on closed.
          */
         public boolean supportsTiltOnClosed() {
             return supportsTiltOnClosed && !supportsTiltAnywhere;
@@ -251,19 +252,20 @@ public class ShadeCapabilitiesDatabase {
         /**
          * Check if the Capabilities class instance supports 180 degrees tilt.
          *
-         * @return true if the primary shade supports 180 degrees.
+         * @return true if the tilt range is 180 degrees.
          */
         public boolean supportsTilt180() {
             return tilt180Degrees;
         }
 
         /**
-         * Check if the Capabilities class instance supports a secondary 'DuoLite' blackout shade.
+         * Check if the Capabilities class instance supports an overlapped secondary shade.
+         * e.g. a 'DuoLite' or blackout shade.
          *
-         * @return true if the primary shade supports a secondary blackout shade.
+         * @return true if the shade supports a secondary overlapped shade.
          */
-        public boolean supportsBlackoutShade() {
-            return supportsBlackoutShade;
+        public boolean supportsSecondaryOverlapped() {
+            return supportsSecondaryOverlapped;
         }
     }
 

diff --git a/bundles/org.openhab.binding.hdpowerview/src/test/java/org/openhab/binding/hdpowerview/ShadePositionTest.java b/bundles/org.openhab.binding.hdpowerview/src/test/java/org/openhab/binding/hdpowerview/ShadePositionTest.java
index 3bd61403802802361c4a51cabca9219908bd8edf..ce74424e50aace60e1d8b246f259dfabd8c8afb5 100644 (file)
--- a/bundles/org.openhab.binding.hdpowerview/src/test/java/org/openhab/binding/hdpowerview/ShadePositionTest.java
+++ b/bundles/org.openhab.binding.hdpowerview/src/test/java/org/openhab/binding/hdpowerview/ShadePositionTest.java
@@ -50,10 +50,10 @@ public class ShadePositionTest {
         assertTrue(db.getCapabilities(4).supportsTilt180());
         assertTrue(db.getCapabilities(5).supportsTilt180());
         assertFalse(db.getCapabilities(5).supportsPrimary());
-        assertTrue(db.getCapabilities(6).isPrimaryStateInverted());
+        assertTrue(db.getCapabilities(6).isPrimaryInverted());
         assertTrue(db.getCapabilities(7).supportsSecondary());
-        assertTrue(db.getCapabilities(8).supportsBlackoutShade());
-        assertTrue(db.getCapabilities(9).supportsBlackoutShade());
+        assertTrue(db.getCapabilities(8).supportsSecondaryOverlapped());
+        assertTrue(db.getCapabilities(9).supportsSecondaryOverlapped());
 
         assertEquals(db.getType(4).getCapabilities(), 0);
         assertEquals(db.getType(-1).getCapabilities(), -1);
@@ -61,9 +61,9 @@ public class ShadePositionTest {
         assertFalse(db.isTypeInDatabase(99));
         assertFalse(db.isCapabilitiesInDatabase(99));
 
-        assertFalse(db.getCapabilities(0).isPrimaryStateInverted());
-        assertFalse(db.getCapabilities(-1).isPrimaryStateInverted());
-        assertFalse(db.getCapabilities(99).isPrimaryStateInverted());
+        assertFalse(db.getCapabilities(0).isPrimaryInverted());
+        assertFalse(db.getCapabilities(-1).isPrimaryInverted());
+        assertFalse(db.getCapabilities(99).isPrimaryInverted());
 
         assertFalse(db.getCapabilities(0).supportsSecondary());
         assertFalse(db.getCapabilities(-1).supportsSecondary());