Syntactic sugar on decode api

Author: richardbergquist

Readme.md

@@ -48,8 +48,8 @@ try {
 }
 if (decodedData != null) {
     System.out.printf("Codec:%s(%s)%n", decodedData.getCodec().name(), decodedData.getCodec().code);
-    System.out.println("byte data length:" + decodedData.getByteData().length);
-    System.out.println("hex data:" + decodedData.getHexData());
+    System.out.println("byte data length:" + decodedData.getDataAsBytes().length);
+    System.out.println("hex data:" + decodedData.getDataAsHex());
 }
 ```
 

src/main/java/nz/co/identityfoundry/ddi/did/multicodec/DecodedData.java

@@ -1,42 +1,74 @@
 package nz.co.identityfoundry.ddi.did.multicodec;
 
+import nz.co.identityfoundry.ddi.did.util.HexUtils;
+
 /**
- * A bean to encapsulate decoded data
+ * <p>A bean to encapsulate decoded data and its codec.</p>
+ * <p>The bean provides access to an array of bytes to express the decoded data payload.
+ * The data can set/get either as a byte[] or as a hex string in such a way as the operations are consistent ways to act
+ * on the same payload of data.</p>
  */
 public class DecodedData {
     private Multicodec codec;
-    private byte[] byteData;
-    private String hexData;
+    private byte[] data;
 
     public DecodedData() {
     }
 
+    /**
+     * Gets the Multicodec value of the data.
+     * @return the Multicodec value of the data.
+     */
     public Multicodec getCodec() {
         return codec;
     }
 
+    /**
+     * Sets the Multicodec value of the data.
+     * @param codec the Multicodec value of the data.
+     */
     public void setCodec(Multicodec codec) {
         this.codec = codec;
     }
 
-    public byte[] getByteData() {
-        return byteData;
+    /**
+     * Gets the data as a byte array.
+     * @return the data as a byte array.
+     */
+    public byte[] getDataAsBytes() {
+        return data;
     }
 
-    public void setByteData(byte[] byteData) {
-        this.byteData = byteData;
+    /**
+     * Sets the data.
+     * @param data the data as a byte array.
+     */
+    public void setData(byte[] data) {
+        this.data = data;
     }
 
-    public String getHexData() {
-        return hexData;
+    /**
+     * Alternative method to get the data as a hex string.
+     * @return get the data as a hex string.
+     */
+    public String getDataAsHex() {
+        return HexUtils.bytesToHex(this.data);
     }
 
-    public void setHexData(String hexData) {
-        this.hexData = hexData;
+    /**
+     * Alternative method to set the data as a hex string.
+     * @param hexData the data as a hex string.
+     */
+    public void setData(String hexData) {
+        setData(HexUtils.hexToBytes(hexData));
     }
 
+    /**
+     * Determines if this object is populated with non-null information.
+     * @return true, if this object is populated with non-null information.
+     */
     public boolean isSet() {
-        return (getCodec() != null) && (getByteData() != null && getByteData().length > 0);
+        return (getCodec() != null) && (getDataAsBytes() != null && getDataAsBytes().length > 0);
 
     }
 }

src/main/java/nz/co/identityfoundry/ddi/did/multicodec/MulticodecEncoder.java

@@ -99,9 +99,7 @@ public static DecodedData decode(byte[] multicodecEncodedData) throws AmbiguousC
             int codeLength = HexUtils.hexToBytes(c.code).length;
             if ((codeLength == 1) && (multicodecEncodedDataHex.startsWith(c.uvarintcode))) {
                 data.setCodec(c);
-                String dataHex = StringUtils.removeStart(multicodecEncodedDataHex, c.uvarintcode);
-                data.setByteData(HexUtils.hexToBytes(dataHex));
-                data.setHexData(dataHex);
+                data.setData(StringUtils.removeStart(multicodecEncodedDataHex, c.uvarintcode));
                 break;
             }
         }

src/test/java/nz/co/identityfoundry/ddi/did/multicodec/MulticodecEncoderFullTest.java

@@ -574,7 +574,7 @@ public void testDecodeSingleByteCodec() {
             }
             assertNotNull("DecodedData was not null", decodedData);
             assertEquals(String.format("Expected codec %s, but got %s", codec.name(), decodedData.getCodec().name()), codec.name(), decodedData.getCodec().name());
-            assertArrayEquals(String.format("Expected data %s, but got %s", HexUtils.bytesToHex(raw), decodedData.getHexData()), raw, decodedData.getByteData());
+            assertArrayEquals(String.format("Expected data %s, but got %s", HexUtils.bytesToHex(raw), decodedData.getDataAsHex()), raw, decodedData.getDataAsBytes());
         }
     }