Semantic Tags: Overload Equipment tag setters for Things (openhab#4713)

andrewfg · web-flow · commit fc8d791dbda6 · 2025-04-17T01:20:06.000+02:00
* overload tag setter methods
* run resolver

Signed-off-by: Andrew Fiddian-Green &lt;software@whitebear.ch&gt;
diff --git a/bundles/org.openhab.core.thing/pom.xml b/bundles/org.openhab.core.thing/pom.xml
@@ -30,6 +30,11 @@
       <artifactId>org.openhab.core.transform</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.core.bundles</groupId>
+      <artifactId>org.openhab.core.semantics</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.core.bundles</groupId>
       <artifactId>org.openhab.core.test</artifactId>
diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/Thing.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/Thing.java
@@ -20,6 +20,7 @@
 import org.openhab.core.common.registry.Identifiable;
 import org.openhab.core.config.core.Configuration;
 import org.openhab.core.items.Item;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.binding.ThingHandler;
 
 /**
@@ -246,4 +247,6 @@ public interface Thing extends Identifiable<ThingUID> {
      * @param semanticEquipmentTag the semantic (equipment) tag or {@code null} if no tag has been configured.
      */
     void setSemanticEquipmentTag(@Nullable String semanticEquipmentTag);
+
+    void setSemanticEquipmentTag(@Nullable SemanticTag semanticEquipmentTag);
 }
diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/builder/BridgeBuilder.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/builder/BridgeBuilder.java
@@ -18,6 +18,7 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.config.core.Configuration;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.Bridge;
 import org.openhab.core.thing.Channel;
 import org.openhab.core.thing.ChannelUID;
@@ -128,4 +129,9 @@ public BridgeBuilder withLocation(@Nullable String location) {
     public BridgeBuilder withSemanticEquipmentTag(@Nullable String semanticEquipmentTag) {
         return (BridgeBuilder) super.withSemanticEquipmentTag(semanticEquipmentTag);
     }
+
+    @Override
+    public BridgeBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag) {
+        return withSemanticEquipmentTag(semanticEquipmentTag.getName());
+    }
 }
diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/builder/ThingBuilder.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/builder/ThingBuilder.java
@@ -23,6 +23,7 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.config.core.Configuration;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.Channel;
 import org.openhab.core.thing.ChannelUID;
 import org.openhab.core.thing.Thing;
@@ -265,6 +266,10 @@ public ThingBuilder withSemanticEquipmentTag(@Nullable String semanticEquipmentT
         return this;
     }
 
+    public ThingBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag) {
+        return withSemanticEquipmentTag(semanticEquipmentTag.getName());
+    }
+
     protected Thing populate(ThingImpl thing) {
         thing.setLabel(label);
         thing.setChannels(channels);
diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/ThingImpl.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/ThingImpl.java
@@ -20,6 +20,7 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.config.core.Configuration;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.Channel;
 import org.openhab.core.thing.ChannelUID;
 import org.openhab.core.thing.Thing;
@@ -299,4 +300,9 @@ public boolean equals(@Nullable Object obj) {
     public void setSemanticEquipmentTag(@Nullable String semanticEquipmentTag) {
         this.semanticEquipmentTag = semanticEquipmentTag;
     }
+
+    @Override
+    public void setSemanticEquipmentTag(@Nullable SemanticTag semanticEquipmentTag) {
+        setSemanticEquipmentTag(semanticEquipmentTag.getName());
+    }
 }
diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/ThingTypeBuilder.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/ThingTypeBuilder.java
@@ -18,6 +18,7 @@
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.core.semantics.SemanticTag;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
@@ -207,4 +208,8 @@ public ThingTypeBuilder withSemanticEquipmentTag(String semanticEquipmentTag) {
         this.semanticEquipmentTag = semanticEquipmentTag;
         return this;
     }
+
+    public ThingTypeBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag) {
+        return withSemanticEquipmentTag(semanticEquipmentTag.getName());
+    }
 }
diff --git a/itests/org.openhab.core.automation.integration.tests/itest.bndrun b/itests/org.openhab.core.automation.integration.tests/itest.bndrun
@@ -82,4 +82,5 @@ Fragment-Host: org.openhab.core.automation
 	com.fasterxml.jackson.dataformat.jackson-dataformat-yaml;version='[2.18.2,2.18.3)',\
 	org.yaml.snakeyaml;version='[2.3.0,2.3.1)',\
 	de.focus_shift.jollyday-core;version='[1.5.0,1.5.1)',\
-	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)'
+	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.automation.module.core.tests/itest.bndrun b/itests/org.openhab.core.automation.module.core.tests/itest.bndrun
@@ -82,4 +82,5 @@ Fragment-Host: org.openhab.core.automation
 	com.fasterxml.jackson.dataformat.jackson-dataformat-yaml;version='[2.18.2,2.18.3)',\
 	org.yaml.snakeyaml;version='[2.3.0,2.3.1)',\
 	de.focus_shift.jollyday-core;version='[1.5.0,1.5.1)',\
-	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)'
+	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.automation.module.script.tests/itest.bndrun b/itests/org.openhab.core.automation.module.script.tests/itest.bndrun
@@ -79,4 +79,5 @@ Fragment-Host: org.openhab.core.automation.module.script
 	com.fasterxml.jackson.dataformat.jackson-dataformat-yaml;version='[2.18.2,2.18.3)',\
 	org.yaml.snakeyaml;version='[2.3.0,2.3.1)',\
 	de.focus_shift.jollyday-core;version='[1.5.0,1.5.1)',\
-	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)'
+	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.automation.module.timer.tests/itest.bndrun b/itests/org.openhab.core.automation.module.timer.tests/itest.bndrun
@@ -82,4 +82,5 @@ Fragment-Host: org.openhab.core.automation
 	com.fasterxml.jackson.dataformat.jackson-dataformat-yaml;version='[2.18.2,2.18.3)',\
 	org.yaml.snakeyaml;version='[2.3.0,2.3.1)',\
 	de.focus_shift.jollyday-core;version='[1.5.0,1.5.1)',\
-	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)'
+	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.automation.tests/itest.bndrun b/itests/org.openhab.core.automation.tests/itest.bndrun
@@ -82,4 +82,5 @@ Fragment-Host: org.openhab.core.automation
 	com.fasterxml.jackson.dataformat.jackson-dataformat-yaml;version='[2.18.2,2.18.3)',\
 	org.yaml.snakeyaml;version='[2.3.0,2.3.1)',\
 	de.focus_shift.jollyday-core;version='[1.5.0,1.5.1)',\
-	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)'
+	de.focus_shift.jollyday-jackson;version='[1.5.0,1.5.1)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.config.discovery.mdns.tests/itest.bndrun b/itests/org.openhab.core.config.discovery.mdns.tests/itest.bndrun
@@ -74,4 +74,5 @@ Fragment-Host: org.openhab.core.config.discovery.mdns
 	org.openhab.core.transform;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
 	org.osgi.service.cm;version='[1.6.0,1.6.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.config.discovery.tests/itest.bndrun b/itests/org.openhab.core.config.discovery.tests/itest.bndrun
@@ -73,4 +73,5 @@ Fragment-Host: org.openhab.core.config.discovery
 	org.openhab.core.transform;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
 	org.osgi.service.cm;version='[1.6.0,1.6.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.config.discovery.usbserial.tests/itest.bndrun b/itests/org.openhab.core.config.discovery.usbserial.tests/itest.bndrun
@@ -82,4 +82,5 @@ Provide-Capability: \
 	org.openhab.core.transform;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
 	org.osgi.service.cm;version='[1.6.0,1.6.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.storage.json.tests/itest.bndrun b/itests/org.openhab.core.storage.json.tests/itest.bndrun
@@ -67,4 +67,5 @@ Fragment-Host: org.openhab.core.storage.json
 	org.openhab.core.transform;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
 	org.osgi.service.cm;version='[1.6.0,1.6.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.thing.tests/itest.bndrun b/itests/org.openhab.core.thing.tests/itest.bndrun
@@ -74,4 +74,5 @@ Fragment-Host: org.openhab.core.thing
 	org.openhab.core.thing.tests;version='[5.0.0,5.0.1)',\
 	org.openhab.core.transform;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'
diff --git a/itests/org.openhab.core.voice.tests/itest.bndrun b/itests/org.openhab.core.voice.tests/itest.bndrun
@@ -80,4 +80,5 @@ Fragment-Host: org.openhab.core.voice
 	org.openhab.core.voice;version='[5.0.0,5.0.1)',\
 	org.openhab.core.voice.tests;version='[5.0.0,5.0.1)',\
 	biz.aQute.tester.junit-platform;version='[7.1.0,7.1.1)',\
-	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)'
+	org.ops4j.pax.logging.pax-logging-api;version='[2.2.8,2.2.9)',\
+	org.openhab.core.semantics;version='[5.0.0,5.0.1)'

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`
`19`	`19`	`import org.eclipse.jdt.annotation.NonNullByDefault;`
`20`	`20`	`import org.eclipse.jdt.annotation.Nullable;`
	`21`	`+import org.openhab.core.semantics.SemanticTag;`
`21`	`22`	`import org.openhab.core.thing.ThingTypeUID;`
`22`	`23`
`23`	`24`	`/**`
`@@ -207,4 +208,8 @@ public ThingTypeBuilder withSemanticEquipmentTag(String semanticEquipmentTag) {`
`207`	`208`	`this.semanticEquipmentTag = semanticEquipmentTag;`
`208`	`209`	`return this;`
`209`	`210`	`}`
	`211`	`+`
	`212`	`+ public ThingTypeBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag) {`
	`213`	`+ return withSemanticEquipmentTag(semanticEquipmentTag.getName());`
	`214`	`+ }`
`210`	`215`	`}`