change multi-inheritance:

brokkoli71 · brokkoli71 · commit 56644d24a063 · 2025-09-23T15:31:32.000+02:00
- codecs in core are abstrac classes
 - parent codec per v2/v3 (used for serialization) is interface
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/AbstractCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/AbstractCodec.java
@@ -0,0 +1,20 @@
+package dev.zarr.zarrjava.core.codec;
+
+import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.v3.ArrayMetadata; //TODO remove v3 dependency
+
+public abstract class AbstractCodec implements Codec{
+    protected ArrayMetadata.CoreArrayMetadata arrayMetadata;
+
+    public ArrayMetadata.CoreArrayMetadata resolveArrayMetadata() throws ZarrException {
+        if (arrayMetadata == null) {
+            throw new ZarrException("arrayMetadata needs to get set in for every codec");
+        }
+        return this.arrayMetadata;
+    }
+
+    public void setCoreArrayMetadata(ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException{
+        this.arrayMetadata = arrayMetadata;
+    }
+}
+
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/ArrayArrayCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/ArrayArrayCodec.java
@@ -3,12 +3,12 @@
 import dev.zarr.zarrjava.ZarrException;
 import ucar.ma2.Array;
 
-public interface ArrayArrayCodec {
+public abstract class ArrayArrayCodec extends AbstractCodec {
 
-  Array encode(Array chunkArray)
+  public abstract Array encode(Array chunkArray)
       throws ZarrException;
 
-  Array decode(Array chunkArray)
+  public abstract Array decode(Array chunkArray)
       throws ZarrException;
 
 }
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/ArrayBytesCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/ArrayBytesCodec.java
@@ -5,22 +5,22 @@
 import java.nio.ByteBuffer;
 import ucar.ma2.Array;
 
-public interface ArrayBytesCodec {
+public abstract class ArrayBytesCodec extends AbstractCodec {
 
-  ByteBuffer encode(Array chunkArray)
+  public abstract ByteBuffer encode(Array chunkArray)
       throws ZarrException;
 
-  Array decode(ByteBuffer chunkBytes)
+  public abstract Array decode(ByteBuffer chunkBytes)
       throws ZarrException;
 
-  interface WithPartialDecode extends ArrayBytesCodec {
+  public abstract static class WithPartialDecode extends ArrayBytesCodec {
 
     public abstract Array decode(ByteBuffer shardBytes) throws ZarrException;
     public abstract ByteBuffer encode(Array shardArray) throws ZarrException;
 
-     Array decodePartial(
-        StoreHandle handle, long[] offset, int[] shape
-    ) throws ZarrException;
+    protected abstract Array decodePartial(
+         StoreHandle handle, long[] offset, int[] shape
+     ) throws ZarrException;
   }
 }
 
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/BytesBytesCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/BytesBytesCodec.java
@@ -7,13 +7,13 @@
 import java.io.OutputStream;
 import java.nio.ByteBuffer;
 
-public interface BytesBytesCodec {
+public abstract class BytesBytesCodec extends AbstractCodec {
 
-    ByteBuffer encode(ByteBuffer chunkBytes) throws ZarrException;
+    public abstract ByteBuffer encode(ByteBuffer chunkBytes) throws ZarrException;
 
-    ByteBuffer decode(ByteBuffer chunkBytes) throws ZarrException;
+    public abstract ByteBuffer decode(ByteBuffer chunkBytes) throws ZarrException;
 
-    default void copy(InputStream inputStream, OutputStream outputStream) throws IOException {
+    protected void copy(InputStream inputStream, OutputStream outputStream) throws IOException {
         byte[] buffer = new byte[4096];
         int len;
         while ((len = inputStream.read(buffer)) > 0) {
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/Codec.java b/src/main/java/dev/zarr/zarrjava/core/codec/Codec.java
@@ -1,14 +1,14 @@
 package dev.zarr.zarrjava.core.codec;
 
 import dev.zarr.zarrjava.ZarrException;
-import dev.zarr.zarrjava.v3.ArrayMetadata;
+import dev.zarr.zarrjava.core.ArrayMetadata;
 
 public interface Codec {
-    ArrayMetadata.CoreArrayMetadata resolveArrayMetadata() throws ZarrException;
+    void setCoreArrayMetadata(ArrayMetadata.CoreArrayMetadata codecArrayMetadata) throws ZarrException;
 
-    long computeEncodedSize(long inputByteLength, ArrayMetadata.CoreArrayMetadata arrayMetadata)
-            throws ZarrException;
+    ArrayMetadata.CoreArrayMetadata resolveArrayMetadata() throws ZarrException;
 
-    void setCoreArrayMetadata(ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException;
+    default long computeEncodedSize(long inputByteLength, ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException{
+        throw new ZarrException("Not implemented for " + this.getClass());
+    }
 }
-
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/core/BloscCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/core/BloscCodec.java
@@ -15,10 +15,10 @@
 import java.io.IOException;
 import java.nio.ByteBuffer;
 
-public interface BloscCodec extends BytesBytesCodec {
+public abstract class BloscCodec extends BytesBytesCodec {
 
   @Override
-  default ByteBuffer decode(ByteBuffer chunkBytes)
+  public ByteBuffer decode(ByteBuffer chunkBytes)
       throws ZarrException {
     try {
       return ByteBuffer.wrap(Blosc.decompress(Utils.toArray(chunkBytes)));
@@ -27,7 +27,7 @@ default ByteBuffer decode(ByteBuffer chunkBytes)
     }
   }
 
-  final class CustomCompressorDeserializer extends StdDeserializer<Blosc.Compressor> {
+  public static final class CustomCompressorDeserializer extends StdDeserializer<Blosc.Compressor> {
 
     public CustomCompressorDeserializer() {
       this(null);
@@ -53,7 +53,7 @@ public Blosc.Compressor deserialize(JsonParser jsonParser, DeserializationContex
     }
   }
 
-  final class CustomCompressorSerializer extends StdSerializer<Blosc.Compressor> {
+  public static final class CustomCompressorSerializer extends StdSerializer<Blosc.Compressor> {
 
     public CustomCompressorSerializer() {
       super(Blosc.Compressor.class);
diff --git a/src/main/java/dev/zarr/zarrjava/core/codec/core/BytesCodec.java b/src/main/java/dev/zarr/zarrjava/core/codec/core/BytesCodec.java
@@ -2,10 +2,4 @@
 
 import dev.zarr.zarrjava.core.codec.ArrayBytesCodec;
 
-public interface BytesCodec extends ArrayBytesCodec {
-
-    /*
-    TODO: better style would be to make this a class and dev.zarr.zarrjava.v3.codec.Codec an interface
-        Would this work with the serialization?
-     */
-}
+public abstract class BytesCodec extends ArrayBytesCodec {}
diff --git a/src/main/java/dev/zarr/zarrjava/v2/Array.java b/src/main/java/dev/zarr/zarrjava/v2/Array.java
@@ -28,9 +28,9 @@ protected Array(StoreHandle storeHandle, ArrayMetadata arrayMetadata) throws IOE
     this.storeHandle = storeHandle;
     this.metadata = arrayMetadata;
     this.codecPipeline = new CodecPipeline(Utils.concatArrays(
-        new dev.zarr.zarrjava.core.codec.Codec[]{},
+        new Codec[]{},
         metadata.filters == null ? new Codec[]{} : metadata.filters,
-        new dev.zarr.zarrjava.core.codec.Codec[]{new BytesCodec(arrayMetadata.endianness.toEndian())},
+        new Codec[]{new BytesCodec(arrayMetadata.endianness.toEndian())},
         metadata.compressor == null ? new Codec[]{} : new Codec[]{metadata.compressor}
     ), metadata.coreArrayMetadata);
   }
diff --git a/src/main/java/dev/zarr/zarrjava/v2/codec/Codec.java b/src/main/java/dev/zarr/zarrjava/v2/codec/Codec.java
@@ -1,26 +1,7 @@
 package dev.zarr.zarrjava.v2.codec;
 
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
-import dev.zarr.zarrjava.ZarrException;
-import dev.zarr.zarrjava.v2.ArrayMetadata;
 
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "id")
-public abstract class Codec implements dev.zarr.zarrjava.core.codec.Codec {
-
-    protected ArrayMetadata.CoreArrayMetadata arrayMetadata;
-
-    public ArrayMetadata.CoreArrayMetadata resolveArrayMetadata() throws ZarrException {
-        if (arrayMetadata == null) {
-            throw new ZarrException("arrayMetadata needs to get set in for every codec");
-        }
-        return this.arrayMetadata;
-    }
-
-    public abstract long computeEncodedSize(long inputByteLength, ArrayMetadata.CoreArrayMetadata arrayMetadata)
-            throws ZarrException;
-
-    public void setCoreArrayMetadata(ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException{
-        this.arrayMetadata = arrayMetadata;
-    }
-}
+public interface Codec extends dev.zarr.zarrjava.core.codec.Codec {}
 
diff --git a/src/main/java/dev/zarr/zarrjava/v2/codec/core/BloscCodec.java b/src/main/java/dev/zarr/zarrjava/v2/codec/core/BloscCodec.java
@@ -14,13 +14,12 @@
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.utils.Utils;
 import dev.zarr.zarrjava.v2.codec.Codec;
-import dev.zarr.zarrjava.v2.ArrayMetadata;
 
 import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.nio.ByteBuffer;
 
-public class BloscCodec extends Codec implements dev.zarr.zarrjava.core.codec.core.BloscCodec {
+public class BloscCodec extends dev.zarr.zarrjava.core.codec.core.BloscCodec implements Codec {
 
   public final String id = "blosc";
 
@@ -74,12 +73,6 @@ public ByteBuffer encode(ByteBuffer chunkBytes)
     }
   }
 
-  @Override
-  public long computeEncodedSize(long inputByteLength,
-      ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException {
-    throw new ZarrException("Not implemented for Blosc codec.");
-  }
-
   public static final class CustomShuffleSerializer extends StdSerializer<Blosc.Shuffle> {
 
     public CustomShuffleSerializer() {
diff --git a/src/main/java/dev/zarr/zarrjava/v2/codec/core/BytesCodec.java b/src/main/java/dev/zarr/zarrjava/v2/codec/core/BytesCodec.java
@@ -12,7 +12,8 @@
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
-public class BytesCodec extends Codec implements dev.zarr.zarrjava.core.codec.core.BytesCodec {
+// TODO might move some of this to core
+public class BytesCodec extends dev.zarr.zarrjava.core.codec.core.BytesCodec implements Codec {
     @Nonnull
     public final Endian endian;
 
@@ -24,8 +25,6 @@ public BytesCodec(
         this.endian = endian;
     }
 
-
-    @Override
     public Array decode(ByteBuffer chunkBytes) {
         chunkBytes.order(endian.getByteOrder());
         return Array.factory(arrayMetadata.dataType.getMA2DataType(), arrayMetadata.chunkShape,
@@ -37,12 +36,6 @@ public ByteBuffer encode(Array chunkArray) {
         return chunkArray.getDataAsByteBuffer(endian.getByteOrder());
     }
 
-    @Override
-    public long computeEncodedSize(long inputByteLength,
-                                   ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException {
-        return inputByteLength;
-    }
-
     public enum Endian {
         LITTLE("little"),
         BIG("big");
diff --git a/src/main/java/dev/zarr/zarrjava/v2/codec/core/ZlibCodec.java b/src/main/java/dev/zarr/zarrjava/v2/codec/core/ZlibCodec.java
@@ -14,7 +14,7 @@
 import java.nio.ByteBuffer;
 import java.util.zip.*;
 
-public class ZlibCodec extends Codec implements BytesBytesCodec {
+public class ZlibCodec extends BytesBytesCodec implements Codec {
 
     public final String id = "zlib";
     public final int level;
@@ -53,10 +53,4 @@ public ByteBuffer encode(ByteBuffer chunkBytes) throws ZarrException {
             throw new ZarrException("Error in encoding zlib.", ex);
         }
     }
-
-    @Override
-    public long computeEncodedSize(long inputByteLength,
-                                   ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException {
-        throw new ZarrException("Not implemented for Zlib codec.");
-    }
 }
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/Codec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/Codec.java
@@ -5,19 +5,7 @@
 import dev.zarr.zarrjava.v3.ArrayMetadata;
 
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "name")
-public abstract class Codec implements dev.zarr.zarrjava.core.codec.Codec {
-
-    protected ArrayMetadata.CoreArrayMetadata arrayMetadata;
-
-    public ArrayMetadata.CoreArrayMetadata resolveArrayMetadata() throws ZarrException {
-        if (arrayMetadata == null) {
-            throw new ZarrException("arrayMetadata needs to get set in for every codec");
-        }
-        return this.arrayMetadata;
-    }
-
-    public void setCoreArrayMetadata(ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException{
-        this.arrayMetadata = arrayMetadata;
-    }
+public interface Codec extends dev.zarr.zarrjava.v2.codec.Codec {
+    long computeEncodedSize(long inputByteLength, ArrayMetadata.CoreArrayMetadata arrayMetadata) throws ZarrException;
 }
 
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/CodecRegistry.java b/src/main/java/dev/zarr/zarrjava/v3/codec/CodecRegistry.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.databind.jsontype.NamedType;
 import dev.zarr.zarrjava.v3.codec.core.*;
-import dev.zarr.zarrjava.core.codec.Codec;
 
 import java.util.HashMap;
 import java.util.Map;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/BloscCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/BloscCodec.java
@@ -21,7 +21,7 @@
 import java.nio.ByteBuffer;
 import javax.annotation.Nonnull;
 
-public class BloscCodec extends Codec implements dev.zarr.zarrjava.core.codec.core.BloscCodec {
+public class BloscCodec extends dev.zarr.zarrjava.core.codec.core.BloscCodec implements Codec{
 
   public final String name = "blosc";
   @Nonnull
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/BytesCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/BytesCodec.java
@@ -12,7 +12,7 @@
 import javax.annotation.Nonnull;
 import ucar.ma2.Array;
 
-public class BytesCodec extends Codec implements dev.zarr.zarrjava.core.codec.core.BytesCodec {
+public class BytesCodec extends dev.zarr.zarrjava.core.codec.core.BytesCodec implements Codec {
 
   public final String name = "bytes";
   @Nonnull
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/Crc32cCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/Crc32cCodec.java
@@ -10,7 +10,7 @@
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
-public class Crc32cCodec extends Codec implements BytesBytesCodec {
+public class Crc32cCodec extends  BytesBytesCodec implements Codec {
 
   public final String name = "crc32c";
 
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/GzipCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/GzipCodec.java
@@ -15,7 +15,7 @@
 import java.util.zip.GZIPOutputStream;
 import javax.annotation.Nonnull;
 
-public class GzipCodec extends Codec implements BytesBytesCodec {
+public class GzipCodec extends BytesBytesCodec implements Codec {
 
   public final String name = "gzip";
   @Nonnull
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/ShardingIndexedCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/ShardingIndexedCodec.java
@@ -22,7 +22,7 @@
 import ucar.ma2.InvalidRangeException;
 
 
-public class ShardingIndexedCodec extends Codec implements ArrayBytesCodec.WithPartialDecode {
+public class ShardingIndexedCodec extends ArrayBytesCodec.WithPartialDecode implements Codec {
 
   public final String name = "sharding_indexed";
   @Nonnull
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/TransposeCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/TransposeCodec.java
@@ -14,7 +14,7 @@
 import static dev.zarr.zarrjava.utils.Utils.inversePermutation;
 import static dev.zarr.zarrjava.utils.Utils.isPermutation;
 
-public class TransposeCodec extends Codec implements ArrayArrayCodec {
+public class TransposeCodec extends ArrayArrayCodec implements Codec{
 
     @Nonnull
     public final String name = "transpose";
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/ZstdCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/ZstdCodec.java
@@ -12,7 +12,7 @@
 import javax.annotation.Nonnull;
 import java.nio.ByteBuffer;
 
-public class ZstdCodec extends Codec implements BytesBytesCodec {
+public class ZstdCodec extends BytesBytesCodec implements Codec {
 
     public final String name = "zstd";
     @Nonnull

Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@`
`15`	`15`	`import java.io.IOException;`
`16`	`16`	`import java.nio.ByteBuffer;`
`17`	`17`
`18`		`-public interface BloscCodec extends BytesBytesCodec {`
	`18`	`+public abstract class BloscCodec extends BytesBytesCodec {`
`19`	`19`
`20`	`20`	`@Override`
`21`		`- default ByteBuffer decode(ByteBuffer chunkBytes)`
	`21`	`+ public ByteBuffer decode(ByteBuffer chunkBytes)`
`22`	`22`	`throws ZarrException {`
`23`	`23`	`try {`
`24`	`24`	`return ByteBuffer.wrap(Blosc.decompress(Utils.toArray(chunkBytes)));`
`@@ -27,7 +27,7 @@ default ByteBuffer decode(ByteBuffer chunkBytes)`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`		`- final class CustomCompressorDeserializer extends StdDeserializer<Blosc.Compressor> {`
	`30`	`+ public static final class CustomCompressorDeserializer extends StdDeserializer<Blosc.Compressor> {`
`31`	`31`
`32`	`32`	`public CustomCompressorDeserializer() {`
`33`	`33`	`this(null);`
`@@ -53,7 +53,7 @@ public Blosc.Compressor deserialize(JsonParser jsonParser, DeserializationContex`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
`56`		`- final class CustomCompressorSerializer extends StdSerializer<Blosc.Compressor> {`
	`56`	`+ public static final class CustomCompressorSerializer extends StdSerializer<Blosc.Compressor> {`
`57`	`57`
`58`	`58`	`public CustomCompressorSerializer() {`
`59`	`59`	`super(Blosc.Compressor.class);`