[insteon] Refactor transport message field type (openhab#18272)

Signed-off-by: Jeremy Setton <[email protected]>

Author: jsetton

bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/transport/message/Field.java

@@ -32,9 +32,9 @@
 public final class Field {
     private final String name;
     private final int offset;
-    private final DataType type;
+    private final FieldType type;
 
-    public Field(String name, int offset, DataType type) {
+    public Field(String name, int offset, FieldType type) {
         this.name = name;
         this.offset = offset;
         this.type = type;
@@ -48,7 +48,7 @@ public int getOffset() {
         return offset;
     }
 
-    private void check(int len, DataType t) throws FieldException {
+    private void check(int len, FieldType t) throws FieldException {
         if (offset + type.getSize() > len) {
             throw new FieldException("field write beyond end of msg");
         }
@@ -79,7 +79,7 @@ public void set(byte[] data, String value) throws FieldException, IllegalArgumen
      * @throws FieldException
      */
     public void setByte(byte[] data, byte b) throws FieldException {
-        check(data.length, DataType.BYTE);
+        check(data.length, FieldType.BYTE);
         data[offset] = b;
     }
 
@@ -92,7 +92,7 @@ public void setByte(byte[] data, byte b) throws FieldException {
      * @throws FieldException
      */
     public void setAddress(byte[] data, InsteonAddress address) throws FieldException {
-        check(data.length, DataType.ADDRESS);
+        check(data.length, FieldType.ADDRESS);
         System.arraycopy(address.getBytes(), 0, data, offset, type.getSize());
     }
 
@@ -104,7 +104,7 @@ public void setAddress(byte[] data, InsteonAddress address) throws FieldExceptio
      * @throws FieldException
      */
     public byte getByte(byte[] data) throws FieldException {
-        check(data.length, DataType.BYTE);
+        check(data.length, FieldType.BYTE);
         return data[offset];
     }
 
@@ -116,7 +116,7 @@ public byte getByte(byte[] data) throws FieldException {
      * @throws FieldException
      */
     public InsteonAddress getAddress(byte[] data) throws FieldException {
-        check(data.length, DataType.ADDRESS);
+        check(data.length, FieldType.ADDRESS);
         byte[] address = Arrays.copyOfRange(data, offset, offset + type.getSize());
         return new InsteonAddress(address);
     }

bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/transport/message/DataType.java bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/transport/message/FieldType.java

@@ -21,24 +21,24 @@
 import org.eclipse.jdt.annotation.Nullable;
 
 /**
- * Defines the data types that can be used in the fields of a message.
+ * The {@link FieldType} represents a field type
  *
  * @author Daniel Pfrommer - Initial contribution
  * @author Rob Nielsen - Port to openHAB 2 insteon binding
  * @author Jeremy Setton - Rewrite insteon binding
  */
 @NonNullByDefault
-public enum DataType {
+public enum FieldType {
     BYTE("byte", 1),
     ADDRESS("address", 3);
 
-    private static final Map<String, DataType> NAME_MAP = Arrays.stream(values())
+    private static final Map<String, FieldType> NAME_MAP = Arrays.stream(values())
             .collect(Collectors.toUnmodifiableMap(type -> type.name, Function.identity()));
 
     private final String name;
     private final int size;
 
-    private DataType(String name, int size) {
+    private FieldType(String name, int size) {
         this.name = name;
         this.size = size;
     }
@@ -51,13 +51,7 @@ public int getSize() {
         return size;
     }
 
-    /**
-     * Factory method for getting a DataType from the data type name
-     *
-     * @param name the data type name
-     * @return the data type if defined, otherwise null
-     */
-    public static @Nullable DataType get(String name) {
+    public static @Nullable FieldType get(String name) {
         return NAME_MAP.get(name);
     }
 }

bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/transport/message/MsgDefinitionRegistry.java

@@ -153,7 +153,7 @@ private void parseMsgDefinition(Element element) throws SAXException {
                 Element child = (Element) node;
                 String nodeName = child.getNodeName();
                 if (!"header".equals(nodeName)) {
-                    // Increment the offset by the field data type length
+                    // Increment the offset by the field type length
                     offset += parseField(child, offset, data, fields);
                 } else if (offset == 0) {
                     headerLength = parseHeader(child, data, fields);
@@ -196,7 +196,7 @@ private int parseHeader(Element element, byte[] data, Map<String, Field> fields)
             Node node = nodes.item(i);
             if (node.getNodeType() == Node.ELEMENT_NODE) {
                 Element child = (Element) node;
-                // Increment the offset by the field data type length
+                // Increment the offset by the field type length
                 offset += parseField(child, offset, data, fields);
             }
         }
@@ -213,16 +213,16 @@ private int parseHeader(Element element, byte[] data, Map<String, Field> fields)
      * @param offset msg offset
      * @param data msg data to update
      * @param fields fields map to update
-     * @return field data type length
+     * @return field type length
      * @throws SAXException
      */
     private int parseField(Element element, int offset, byte[] data, Map<String, Field> fields) throws SAXException {
         String name = element.getAttribute("name");
-        DataType dataType = DataType.get(element.getNodeName());
-        if (dataType == null) {
-            throw new SAXException("invalid field data type");
+        FieldType fieldType = FieldType.get(element.getNodeName());
+        if (fieldType == null) {
+            throw new SAXException("invalid field type");
         }
-        Field field = new Field(name, offset, dataType);
+        Field field = new Field(name, offset, fieldType);
         try {
             field.set(data, element.getTextContent());
         } catch (FieldException | IllegalArgumentException e) {
@@ -231,7 +231,7 @@ private int parseField(Element element, int offset, byte[] data, Map<String, Fie
         if (!name.isEmpty()) {
             fields.put(name, field);
         }
-        return dataType.getSize();
+        return fieldType.getSize();
     }
 
     /**