refactor code duplication

Author: brokkoli71

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
           cache: maven
 
       - name: Set up Python
-        uses: actions/setup-python@@v5
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
@@ -41,6 +41,7 @@ jobs:
           uv venv && uv init
           uv add zarr
           uv add zarrita
+
       - name: Download testdata
         run: |
           mkdir testoutput

src/main/java/dev/zarr/zarrjava/core/codec/AbstractCodec.java

@@ -1,7 +1,7 @@
 package dev.zarr.zarrjava.core.codec;
 
 import dev.zarr.zarrjava.ZarrException;
-import dev.zarr.zarrjava.v3.ArrayMetadata; //TODO remove v3 dependency
+import dev.zarr.zarrjava.core.ArrayMetadata;
 
 public abstract class AbstractCodec implements Codec{
     protected ArrayMetadata.CoreArrayMetadata arrayMetadata;

src/main/java/dev/zarr/zarrjava/core/codec/core/BytesCodec.java

@@ -1,5 +1,51 @@
 package dev.zarr.zarrjava.core.codec.core;
 
+import com.fasterxml.jackson.annotation.JsonValue;
 import dev.zarr.zarrjava.core.codec.ArrayBytesCodec;
+import ucar.ma2.Array;
 
-public abstract class BytesCodec extends ArrayBytesCodec {}
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+
+public abstract class BytesCodec extends ArrayBytesCodec {
+    protected abstract ByteOrder getByteOrder();
+
+    @Override
+    public Array decode(ByteBuffer chunkBytes) {
+        chunkBytes.order(getByteOrder());
+        return Array.factory(arrayMetadata.dataType.getMA2DataType(), arrayMetadata.chunkShape,
+            chunkBytes);
+    }
+
+    @Override
+    public ByteBuffer encode(Array chunkArray) {
+        return chunkArray.getDataAsByteBuffer(getByteOrder());
+    }
+
+    public enum Endian {
+        LITTLE("little"),
+        BIG("big");
+        private final String endian;
+
+        Endian(String endian) {
+            this.endian = endian;
+        }
+
+        @JsonValue
+        public String getValue() {
+            return endian;
+        }
+
+        public ByteOrder getByteOrder() {
+            switch (this) {
+                case LITTLE:
+                    return ByteOrder.LITTLE_ENDIAN;
+                case BIG:
+                    return ByteOrder.BIG_ENDIAN;
+                default:
+                    throw new RuntimeException("Unreachable");
+            }
+        }
+    }
+
+}

src/main/java/dev/zarr/zarrjava/v2/DataType.java

@@ -1,7 +1,6 @@
 package dev.zarr.zarrjava.v2;
 
 import com.fasterxml.jackson.annotation.JsonValue;
-import dev.zarr.zarrjava.ZarrException;
 
 public enum DataType implements dev.zarr.zarrjava.core.DataType {
   BOOL("b1", Endianness.UNSPECIFIED),
@@ -25,67 +24,10 @@ public enum DataType implements dev.zarr.zarrjava.core.DataType {
     this.endianness = endianness;
   }
 
-  //todo remove?
-  public static DataType fromDataType(dev.zarr.zarrjava.v3.DataType dataType) {
-    switch (dataType) {
-      case BOOL:
-        return BOOL;
-      case INT8:
-        return INT8;
-      case INT16:
-        return INT16;
-      case INT32:
-        return INT32;
-      case INT64:
-        return INT64;
-      case UINT8:
-        return UINT8;
-      case UINT16:
-        return UINT16;
-      case UINT32:
-        return UINT32;
-      case UINT64:
-        return UINT64;
-      case FLOAT32:
-        return FLOAT32;
-      case FLOAT64:
-        return FLOAT64;
-      default:
-        throw new IllegalArgumentException("Unsupported DataType: " + dataType);
-    }
-  }
-
   public Endianness getEndianness() {
     return endianness;
   }
 
-  //todo remove?
-  public dev.zarr.zarrjava.v3.DataType toV3() throws ZarrException {
-    if (this.dtype.equals(BOOL.dtype))
-      return dev.zarr.zarrjava.v3.DataType.BOOL;
-    if (this.dtype.equals(INT8.dtype))
-      return dev.zarr.zarrjava.v3.DataType.INT8;
-    if (this.dtype.equals(INT16.dtype))
-      return dev.zarr.zarrjava.v3.DataType.INT16;
-    if (this.dtype.equals(INT32.dtype))
-      return dev.zarr.zarrjava.v3.DataType.INT32;
-    if (this.dtype.equals(INT64.dtype))
-      return dev.zarr.zarrjava.v3.DataType.INT64;
-    if (this.dtype.equals(UINT8.dtype))
-      return dev.zarr.zarrjava.v3.DataType.UINT8;
-    if (this.dtype.equals(UINT16.dtype))
-      return dev.zarr.zarrjava.v3.DataType.UINT16;
-    if (this.dtype.equals(UINT32.dtype))
-      return dev.zarr.zarrjava.v3.DataType.UINT32;
-    if (this.dtype.equals(UINT64.dtype))
-      return dev.zarr.zarrjava.v3.DataType.UINT64;
-    if (this.dtype.equals(FLOAT32.dtype))
-      return dev.zarr.zarrjava.v3.DataType.FLOAT32;
-    if (this.dtype.equals(FLOAT64.dtype))
-      return dev.zarr.zarrjava.v3.DataType.FLOAT64;
-    throw new ZarrException("Unknown DataTypeV2: " + this.dtype);
-  }
-
   @JsonValue
   public String getValue() {
     return String.format("%s%s", endianness.getValue(), dtype);

src/main/java/dev/zarr/zarrjava/v2/codec/core/BytesCodec.java

@@ -2,64 +2,25 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonValue;
-import dev.zarr.zarrjava.ZarrException;
-import dev.zarr.zarrjava.v2.ArrayMetadata;
 import dev.zarr.zarrjava.v2.codec.Codec;
-import ucar.ma2.Array;
 
 import javax.annotation.Nonnull;
-import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
-// TODO might move some of this to core
 public class BytesCodec extends dev.zarr.zarrjava.core.codec.core.BytesCodec implements Codec {
+    public final String name = "bytes";
     @Nonnull
     public final Endian endian;
 
-    public final String name = "bytes";
-
     @JsonCreator
     public BytesCodec(
         @JsonProperty(value = "endian", defaultValue = "little") Endian endian) {
         this.endian = endian;
     }
 
-    public Array decode(ByteBuffer chunkBytes) {
-        chunkBytes.order(endian.getByteOrder());
-        return Array.factory(arrayMetadata.dataType.getMA2DataType(), arrayMetadata.chunkShape,
-            chunkBytes);
-    }
-
     @Override
-    public ByteBuffer encode(Array chunkArray) {
-        return chunkArray.getDataAsByteBuffer(endian.getByteOrder());
-    }
-
-    public enum Endian {
-        LITTLE("little"),
-        BIG("big");
-        private final String endian;
-
-        Endian(String endian) {
-            this.endian = endian;
-        }
-
-        @JsonValue
-        public String getValue() {
-            return endian;
-        }
-
-        public ByteOrder getByteOrder() {
-            switch (this) {
-                case LITTLE:
-                    return ByteOrder.LITTLE_ENDIAN;
-                case BIG:
-                    return ByteOrder.BIG_ENDIAN;
-                default:
-                    throw new RuntimeException("Unreachable");
-            }
-        }
+    protected ByteOrder getByteOrder() {
+        return endian.getByteOrder();
     }
 }
 

src/main/java/dev/zarr/zarrjava/v3/ArrayMetadataBuilder.java

@@ -10,7 +10,7 @@
 import dev.zarr.zarrjava.v3.codec.Codec;
 import dev.zarr.zarrjava.v3.codec.CodecBuilder;
 import dev.zarr.zarrjava.v3.codec.core.BytesCodec;
-import dev.zarr.zarrjava.v3.codec.core.BytesCodec.Endian;
+import dev.zarr.zarrjava.core.codec.core.BytesCodec.Endian;
 
 import java.util.HashMap;
 import java.util.Map;

src/main/java/dev/zarr/zarrjava/v3/codec/CodecBuilder.java

@@ -8,7 +8,7 @@
 import dev.zarr.zarrjava.v3.DataType;
 import dev.zarr.zarrjava.v3.codec.core.*;
 import dev.zarr.zarrjava.v3.codec.core.BytesCodec.Configuration;
-import dev.zarr.zarrjava.v3.codec.core.BytesCodec.Endian;
+import dev.zarr.zarrjava.core.codec.core.BytesCodec.Endian;
 
 import java.util.ArrayList;
 import java.util.Collections;

src/main/java/dev/zarr/zarrjava/v3/codec/core/BytesCodec.java

@@ -2,15 +2,12 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonValue;
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.v3.codec.Codec;
 import dev.zarr.zarrjava.v3.ArrayMetadata;
-import dev.zarr.zarrjava.core.codec.ArrayBytesCodec;
-import java.nio.ByteBuffer;
+
 import java.nio.ByteOrder;
 import javax.annotation.Nonnull;
-import ucar.ma2.Array;
 
 public class BytesCodec extends dev.zarr.zarrjava.core.codec.core.BytesCodec implements Codec {
 
@@ -29,50 +26,18 @@ public BytesCodec(Endian endian) {
     this(new BytesCodec.Configuration(endian));
   }
 
-  @Override
-  public Array decode(ByteBuffer chunkBytes) {
-    chunkBytes.order(configuration.endian.getByteOrder());
-    return Array.factory(arrayMetadata.dataType.getMA2DataType(), arrayMetadata.chunkShape,
-        chunkBytes);
-  }
-
-  @Override
-  public ByteBuffer encode(Array chunkArray) {
-    return chunkArray.getDataAsByteBuffer(configuration.endian.getByteOrder());
-  }
-
   @Override
   public long computeEncodedSize(long inputByteLength,
       ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException {
     return inputByteLength;
   }
 
-  public enum Endian {
-    LITTLE("little"),
-    BIG("big");
-    private final String endian;
-
-    Endian(String endian) {
-      this.endian = endian;
-    }
-
-    @JsonValue
-    public String getValue() {
-      return endian;
-    }
-
-    public ByteOrder getByteOrder() {
-      switch (this) {
-        case LITTLE:
-          return ByteOrder.LITTLE_ENDIAN;
-        case BIG:
-          return ByteOrder.BIG_ENDIAN;
-        default:
-          throw new RuntimeException("Unreachable");
-      }
-    }
+  @Override
+  protected ByteOrder getByteOrder() {
+    return configuration.endian.getByteOrder();
   }
 
+
   public static final class Configuration{
 
     @Nonnull