Array.create and Group.create with no store/path arguments should default to a new MemoryStore

Author: brokkoli71

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

@@ -5,6 +5,7 @@
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.core.Attributes;
 import dev.zarr.zarrjava.store.FilesystemStore;
+import dev.zarr.zarrjava.store.MemoryStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 import dev.zarr.zarrjava.core.codec.CodecPipeline;
@@ -87,6 +88,16 @@ public static Array open(String path) throws IOException, ZarrException {
       return open(Paths.get(path));
     }
 
+  /**
+   * Creates a new Zarr array with the provided metadata in an in-memory store
+   *
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(ArrayMetadata arrayMetadata) throws ZarrException, IOException {
+    return create(new StoreHandle(new MemoryStore()), arrayMetadata);
+  }
   /**
    * Creates a new Zarr array with the provided metadata at a specified storage location. This
    * method will raise an exception if a Zarr array already exists at the specified storage

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

@@ -5,6 +5,7 @@
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.core.Attributes;
 import dev.zarr.zarrjava.store.FilesystemStore;
+import dev.zarr.zarrjava.store.MemoryStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 
@@ -49,6 +50,10 @@ public static Group open(String path) throws IOException {
       return open(Paths.get(path));
     }
 
+  public static Group create(@Nonnull GroupMetadata groupMetadata) throws IOException {
+    return new Group(new MemoryStore().resolve(), groupMetadata).writeMetadata();
+  }
+
   public static Group create(
       @Nonnull StoreHandle storeHandle, @Nonnull GroupMetadata groupMetadata
   ) throws IOException {

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

@@ -4,6 +4,7 @@
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.core.Attributes;
 import dev.zarr.zarrjava.store.FilesystemStore;
+import dev.zarr.zarrjava.store.MemoryStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 import dev.zarr.zarrjava.core.codec.CodecPipeline;
@@ -72,6 +73,18 @@ public static Array open(String path) throws IOException, ZarrException {
       return open(Paths.get(path));
     }
 
+  /**
+   * Creates a new Zarr array with the provided metadata in an in-memory store
+   *
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(ArrayMetadata arrayMetadata)
+      throws IOException, ZarrException {
+    return Array.create(new MemoryStore().resolve(), arrayMetadata);
+  }
+
   /**
    * Creates a new Zarr array with the provided metadata at a specified storage location. This
    * method will raise an exception if a Zarr array already exists at the specified storage

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

@@ -4,6 +4,7 @@
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.core.Attributes;
 import dev.zarr.zarrjava.store.FilesystemStore;
+import dev.zarr.zarrjava.store.MemoryStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 import java.io.IOException;
@@ -30,48 +31,122 @@ protected Group(@Nonnull StoreHandle storeHandle, @Nonnull GroupMetadata groupMe
   public static Group open(@Nonnull StoreHandle storeHandle) throws IOException {
     StoreHandle metadataHandle = storeHandle.resolve(ZARR_JSON);
     ByteBuffer metadataBytes = metadataHandle.readNonNull();
-    return new Group(storeHandle, makeObjectMapper()
-        .readValue(Utils.toArray(metadataBytes), GroupMetadata.class));
+    return new Group(storeHandle, makeObjectMapper().readValue(Utils.toArray(metadataBytes), GroupMetadata.class));
   }
 
-  
-  public static Group open(Path path) throws IOException {
-      return open(new StoreHandle(new FilesystemStore(path)));
-    }
 
-    public static Group open(String path) throws IOException {
-      return open(Paths.get(path));
-    }
-
-  public static Group create(
-      @Nonnull StoreHandle storeHandle, @Nonnull GroupMetadata groupMetadata
-  ) throws IOException {
+  public static Group open(Path path) throws IOException {
+    return open(new StoreHandle(new FilesystemStore(path)));
+  }
+
+  public static Group open(String path) throws IOException {
+    return open(Paths.get(path));
+  }
+
+  /**
+   * Creates a new Zarr group with default metadata in an in-memory store.
+   *
+   * @throws IOException if the metadata cannot be serialized
+   */
+  public static Group create() throws IOException {
+    return new Group(new MemoryStore().resolve(), GroupMetadata.defaultValue()).writeMetadata();
+  }
+
+    /**
+   * Creates a new Zarr group with the provided metadata in an in-memory store.
+   *
+   * @param attributes the attributes of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the attributes are invalid
+   */
+  public static Group create(@Nonnull Attributes attributes) throws IOException, ZarrException {
+    return new Group(new MemoryStore().resolve(), new GroupMetadata(attributes)).writeMetadata();
+  }
+
+    /**
+   * Creates a new Zarr group with the provided metadata in an in-memory store.
+   *
+   * @param groupMetadata the metadata of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
+  public static Group create(@Nonnull GroupMetadata groupMetadata) throws IOException {
+    return new Group(new MemoryStore().resolve(), groupMetadata).writeMetadata();
+  }
+
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param storeHandle the storage location of the Zarr group
+   * @param groupMetadata the metadata of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
+  public static Group create(@Nonnull StoreHandle storeHandle, @Nonnull GroupMetadata groupMetadata) throws IOException {
     return new Group(storeHandle, groupMetadata).writeMetadata();
   }
 
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param storeHandle the storage location of the Zarr group
+   * @param attributes attributes of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the attributes are invalid
+   */
   public static Group create(
       @Nonnull StoreHandle storeHandle,
       @Nonnull Attributes attributes
   ) throws IOException, ZarrException {
     return create(storeHandle, new GroupMetadata(attributes));
   }
 
-  public static Group create(@Nonnull StoreHandle storeHandle) throws IOException, ZarrException {
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param storeHandle the storage location of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
+  public static Group create(@Nonnull StoreHandle storeHandle) throws IOException {
     return create(storeHandle, GroupMetadata.defaultValue());
   }
 
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param path the storage location of the Zarr group
+   * @param groupMetadata the metadata of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public static Group create(Path path, GroupMetadata groupMetadata) throws IOException, ZarrException {
     return create(new FilesystemStore(path).resolve(), groupMetadata);
   }
 
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param path the storage location of the Zarr group
+   * @param groupMetadata the metadata of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public static Group create(String path, GroupMetadata groupMetadata) throws IOException, ZarrException {
     return create(Paths.get(path), groupMetadata);
   }
 
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param path the storage location of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public static Group create(Path path) throws IOException, ZarrException {
     return create(new FilesystemStore(path).resolve());
   }
 
+  /**
+   * Creates a new Zarr group with the provided metadata at a specified storage location.
+   *
+   * @param path the storage location of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public static Group create(String path) throws IOException, ZarrException {
     return create(Paths.get(path));
   }
@@ -86,25 +161,59 @@ public Node get(String key) throws ZarrException, IOException{
     }
   }
 
+  /**
+   * Creates a new subgroup with the provided metadata at the specified key.
+   *
+   * @param key           the key of the new Zarr group within the current group
+   * @param groupMetadata the metadata of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public Group createGroup(String key, GroupMetadata groupMetadata)
-      throws IOException, ZarrException {
+          throws IOException, ZarrException {
     return Group.create(storeHandle.resolve(key), groupMetadata);
   }
 
+  /**
+   * Creates a new subgroup with the provided attributes at the specified key.
+   *
+   * @param key        the key of the new Zarr group within the current group
+   * @param attributes attributes of the Zarr group
+   * @throws IOException if the metadata cannot be serialized
+   */
   public Group createGroup(String key, Attributes attributes)
-      throws IOException, ZarrException {
+          throws IOException, ZarrException {
     return Group.create(storeHandle.resolve(key), new GroupMetadata(attributes));
   }
 
-  public Group createGroup(String key) throws IOException, ZarrException {
+  /**
+   * Creates a new subgroup with default metadata at the specified key.
+   *
+   * @param key the key of the new Zarr group within the current group
+   * @throws IOException if the metadata cannot be serialized
+   */
+  public Group createGroup(String key) throws IOException {
     return Group.create(storeHandle.resolve(key), GroupMetadata.defaultValue());
   }
 
+  /**
+   * Creates a new array with the provided metadata at the specified key.
+   *
+   * @param key           the key of the new Zarr array within the current group
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   */
   public Array createArray(String key, ArrayMetadata arrayMetadata)
-      throws IOException, ZarrException {
+          throws IOException, ZarrException {
     return Array.create(storeHandle.resolve(key), arrayMetadata);
   }
 
+    /**
+     * Creates a new array with the provided metadata builder mapper at the specified key.
+     *
+     * @param key                             the key of the new Zarr array within the current group
+     * @param arrayMetadataBuilderMapper      a function building the metadata of the Zarr array
+     * @throws IOException if the metadata cannot be serialized
+     */
   public Array createArray(String key,
       Function<ArrayMetadataBuilder, ArrayMetadataBuilder> arrayMetadataBuilderMapper)
       throws IOException, ZarrException {

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

@@ -44,8 +44,13 @@ public GroupMetadata(
     this.attributes = attributes;
   }
 
-  public static GroupMetadata defaultValue() throws ZarrException {
-    return new GroupMetadata(ZARR_FORMAT, NODE_TYPE, new Attributes());
+  public static GroupMetadata defaultValue() {
+    try {
+        return new GroupMetadata(ZARR_FORMAT, NODE_TYPE, new Attributes());
+        } catch (ZarrException e) {
+        // This should never happen
+        throw new RuntimeException(e);
+    }
   }
 
   @Override