[addonInfo extensions] adopt reviewer suggestions

Signed-off-by: Andrew Fiddian-Green <[email protected]>
openhab · Dec 5, 2023 · 164187c · 164187c
1 parent 6b1d750
commit 164187c
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 39 deletions.
diff --git a/bundles/org.openhab.core.addon/.classpath b/bundles/org.openhab.core.addon/.classpath
@@ -24,16 +24,16 @@
 			<attribute name="annotationpath" value="target/dependency"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry excluding="**" kind="src" output="target/classes" path="src/generated">
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
 		<attributes>
+			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/generated">
 		<attributes>
-			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
-			<attribute name="test" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>

diff --git a/...don/infoproviders/AddonsInfoProvider.java → ...ernal/xml/AddonInfoAddonsXmlProvider.java b/...don/infoproviders/AddonsInfoProvider.java → ...ernal/xml/AddonInfoAddonsXmlProvider.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.core.addon.infoproviders;
+package org.openhab.core.addon.internal.xml;
 
 import java.io.File;
 import java.io.IOException;
@@ -29,7 +29,6 @@
 import org.openhab.core.OpenHAB;
 import org.openhab.core.addon.AddonDiscoveryMethod;
 import org.openhab.core.addon.AddonInfo;
-import org.openhab.core.addon.AddonInfoListReader;
 import org.openhab.core.addon.AddonInfoProvider;
 import org.openhab.core.addon.AddonMatchProperty;
 import org.osgi.service.component.annotations.Activate;
@@ -42,30 +41,26 @@
 import com.thoughtworks.xstream.converters.ConversionException;
 
 /**
- * The {@link AddonsInfoProvider} reads all {@code userdata/addons/*.xml} files, each of which
- * should contain a list of addon.xml elements, and convert their combined contents into a list
+ * The {@link AddonInfoAddonsXmlProvider} reads all {@code userdata/addons/*.xml} files, each of which
+ * should contain a list of {@code addon} elements, and convert their combined contents into a list
  * of {@link AddonInfo} objects can be accessed via the {@link AddonInfoProvider} interface.
  *
  * @author Andrew Fiddian-Green - Initial contribution
  */
 @NonNullByDefault
-@Component(service = AddonInfoProvider.class, name = AddonsInfoProvider.SERVICE_NAME)
-public class AddonsInfoProvider implements AddonInfoProvider {
+@Component(service = AddonInfoProvider.class, name = AddonInfoAddonsXmlProvider.SERVICE_NAME)
+public class AddonInfoAddonsXmlProvider implements AddonInfoProvider {
 
     public static final String SERVICE_NAME = "addons-info-provider";
 
-    private static final boolean TEST_ADDON_DEVELOPER_REGEX_SYNTAX = true;
-
-    private final Logger logger = LoggerFactory.getLogger(AddonsInfoProvider.class);
+    private final Logger logger = LoggerFactory.getLogger(AddonInfoAddonsXmlProvider.class);
     private final String folder = OpenHAB.getUserDataFolder() + File.separator + "addons";
     private final Set<AddonInfo> addonInfos = new HashSet<>();
 
     @Activate
-    public AddonsInfoProvider() {
+    public AddonInfoAddonsXmlProvider() {
         initialize();
-        if (TEST_ADDON_DEVELOPER_REGEX_SYNTAX) {
-            testAddonDeveloperRegexSyntax();
-        }
+        testAddonDeveloperRegexSyntax();
     }
 
     @Deactivate
@@ -98,7 +93,7 @@ private void initialize() {
             } catch (ConversionException e) {
                 logger.warn("File '{}' has invalid content", f.getName());
             } catch (XStreamException e) {
-                logger.warn("File '{}' could not deserialized", f.getName());
+                logger.warn("File '{}' could not be deserialized", f.getName());
             }
         });
     }
@@ -127,7 +122,7 @@ private void testAddonDeveloperRegexSyntax() {
             }
         }
         if (!patternErrors.isEmpty()) {
-            logger.warn("The following errors were found\n\t{}", String.join("\n\t", patternErrors));
+            logger.warn("The following errors were found:\n\t{}", String.join("\n\t", patternErrors));
         }
     }
 }
diff --git a/...enhab/core/addon/AddonInfoListReader.java → ...don/internal/xml/AddonInfoListReader.java b/...enhab/core/addon/AddonInfoListReader.java → ...don/internal/xml/AddonInfoListReader.java
@@ -10,16 +10,14 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.core.addon;
+package org.openhab.core.addon.internal.xml;
 
 import java.util.List;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.openhab.core.addon.internal.xml.AddonDiscoveryMethodConverter;
-import org.openhab.core.addon.internal.xml.AddonInfoConverter;
-import org.openhab.core.addon.internal.xml.AddonInfoListConverter;
-import org.openhab.core.addon.internal.xml.AddonInfoXmlResult;
-import org.openhab.core.addon.internal.xml.AddonMatchPropertyConverter;
+import org.openhab.core.addon.AddonDiscoveryMethod;
+import org.openhab.core.addon.AddonInfoList;
+import org.openhab.core.addon.AddonMatchProperty;
 import org.openhab.core.config.core.ConfigDescription;
 import org.openhab.core.config.core.ConfigDescriptionParameter;
 import org.openhab.core.config.core.ConfigDescriptionParameterGroup;
@@ -39,7 +37,7 @@
 import com.thoughtworks.xstream.XStream;
 
 /**
- * The {@link AddonInfoListReader} reads XML documents, which contain the {@code binding} XML tag, and converts them to
+ * The {@link AddonInfoListReader} reads XML documents, which contain the {@code addon} XML tag, and converts them to
  * a List of {@link AddonInfoXmlResult} objects.
  * <p>
  * This reader uses {@code XStream} and {@code StAX} to parse and convert the XML document.

diff --git a/...openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoReader.java b/...openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoReader.java
@@ -36,7 +36,7 @@
 import com.thoughtworks.xstream.XStream;
 
 /**
- * The {@link AddonInfoReader} reads XML documents, which contain the {@code binding} XML tag,
+ * The {@link AddonInfoReader} reads XML documents, which contain the {@code addon} XML tag,
  * and converts them to {@link AddonInfoXmlResult} objects.
  * <p>
  * This reader uses {@code XStream} and {@code StAX} to parse and convert the XML document.

diff --git a/...openhab.core.addon/src/test/java/org/openhab/core/addon/test/AddonInfoListReaderTest.java b/...openhab.core.addon/src/test/java/org/openhab/core/addon/test/AddonInfoListReaderTest.java
@@ -24,8 +24,8 @@
 import org.openhab.core.addon.AddonDiscoveryMethod;
 import org.openhab.core.addon.AddonInfo;
 import org.openhab.core.addon.AddonInfoList;
-import org.openhab.core.addon.AddonInfoListReader;
 import org.openhab.core.addon.AddonMatchProperty;
+import org.openhab.core.addon.internal.xml.AddonInfoListReader;
 
 /**
  * JUnit tests for {@link AddonInfoListReader}.

diff --git a/bundles/org.openhab.core.config.core/.classpath b/bundles/org.openhab.core.config.core/.classpath
@@ -6,12 +6,7 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry including="**/*.java" kind="src" output="target/classes" path="src/generated/java">
-		<attributes>
-			<attribute name="optional" value="true"/>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
+	<classpathentry kind="src" path="src/generated/java"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
@@ -36,10 +31,5 @@
 			<attribute name="test" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry excluding="**" kind="src" output="target/classes" path="src/generated">
-		<attributes>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>