refactor: use records for WeaviateObject and ObjectMetadata

Author: bevzzz

src/it/java/io/weaviate/client6/v1/DataITest.java

@@ -39,14 +39,14 @@ public void testCreateGetDelete() throws IOException {
     Assertions.assertThat(object)
         .as("object exists after insert").get()
         .satisfies(obj -> {
-          Assertions.assertThat(obj.metadata.id)
+          Assertions.assertThat(obj.metadata().id())
               .as("object id").isEqualTo(id);
 
-          Assertions.assertThat(obj.metadata.vectors).extracting(Vectors::getSingle)
+          Assertions.assertThat(obj.metadata().vectors()).extracting(Vectors::getSingle)
               .asInstanceOf(InstanceOfAssertFactories.OPTIONAL).as("has single vector").get()
               .asInstanceOf(InstanceOfAssertFactories.array(Float[].class)).containsExactly(vector);
 
-          Assertions.assertThat(obj.properties)
+          Assertions.assertThat(obj.properties())
               .as("has expected properties")
               .containsEntry("username", "john doe");
         });

src/it/java/io/weaviate/client6/v1/query/NearVectorQueryITest.java

@@ -68,7 +68,7 @@ private static Map<String, Float[]> createVectors(int n) throws IOException {
               .id(randomUUID())
               .vectors(Vectors.of(VECTOR_INDEX, vector)));
 
-      created.put(object.metadata.id, vector);
+      created.put(object.metadata().id(), vector);
     }
 
     return created;

src/main/java/io/weaviate/client6/v1/ObjectMetadata.java

@@ -2,24 +2,11 @@
 
 import java.util.function.Consumer;
 
-public class ObjectMetadata {
-  public final String id;
-  public final Vectors vectors;
+public record ObjectMetadata(String id, Vectors vectors) {
 
-  // ObjectMetadata(String id, Vectors vectors) {
-  // this(m -> m.id(id).vectors(vectors));
-  // }
-
-  public ObjectMetadata(String id, Vectors vectors) {
-    this.id = id;
-    this.vectors = vectors;
-  }
-
-  public ObjectMetadata(Consumer<Builder> options) {
+  public static ObjectMetadata with(Consumer<Builder> options) {
     var opt = new Builder(options);
-
-    this.id = opt.id;
-    this.vectors = opt.vectors;
+    return new ObjectMetadata(opt.id, opt.vectors);
   }
 
   public static class Builder {

src/main/java/io/weaviate/client6/v1/data/WeaviateObject.java

@@ -9,22 +9,13 @@
 import com.google.gson.Gson;
 
 import io.weaviate.client6.v1.ObjectMetadata;
-import lombok.AccessLevel;
-import lombok.AllArgsConstructor;
 
 // TODO: unify this with collections.SearchObject
 
-@AllArgsConstructor(access = AccessLevel.PACKAGE)
-public class WeaviateObject<T> {
-  public final String collection;
-  public final T properties;
-  public final ObjectMetadata metadata;
+public record WeaviateObject<T>(String collection, T properties, ObjectMetadata metadata) {
 
   WeaviateObject(String collection, T properties, Consumer<ObjectMetadata.Builder> options) {
-
-    this.collection = collection;
-    this.properties = properties;
-    this.metadata = new ObjectMetadata(options);
+    this(collection, properties, ObjectMetadata.with(options));
   }
 
   // JSON serialization ----------------

src/main/java/io/weaviate/client6/v1/data/WeaviateObjectDTO.java

@@ -20,12 +20,12 @@ class WeaviateObjectDTO<T> {
   Map<String, Object> vectors;
 
   WeaviateObjectDTO(WeaviateObject<T> object) {
-    this.collection = object.collection;
-    this.properties = object.properties;
+    this.collection = object.collection();
+    this.properties = object.properties();
 
-    if (object.metadata != null) {
-      this.id = object.metadata.id;
-      this.vectors = object.metadata.vectors.asMap();
+    if (object.metadata() != null) {
+      this.id = object.metadata().id();
+      this.vectors = object.metadata().vectors().asMap();
     }
   }
 

src/test/java/io/weaviate/client6/v1/ObjectMetadataTest.java

@@ -9,17 +9,17 @@ public class ObjectMetadataTest {
 
   @Test
   public final void testMetadata_id() {
-    var metadata = new ObjectMetadata(m -> m.id("object-1"));
-    Assertions.assertThat(metadata.id)
+    var metadata = ObjectMetadata.with(m -> m.id("object-1"));
+    Assertions.assertThat(metadata.id())
         .as("object id").isEqualTo("object-1");
   }
 
   @Test
   public final void testVectorsMetadata_unnamed() {
     Float[] vector = { 1f, 2f, 3f };
-    var metadata = new ObjectMetadata(m -> m.vectors(Vectors.unnamed(vector)));
+    var metadata = ObjectMetadata.with(m -> m.vectors(Vectors.unnamed(vector)));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("unnamed vector").isNotNull()
         .returns(Optional.of(vector), Vectors::getUnnamed)
         .returns(Optional.empty(), Vectors::getSingle);
@@ -28,9 +28,9 @@ public final void testVectorsMetadata_unnamed() {
   @Test
   public final void testVectorsMetadata_default() {
     Float[] vector = { 1f, 2f, 3f };
-    var metadata = new ObjectMetadata(m -> m.vectors(vector));
+    var metadata = ObjectMetadata.with(m -> m.vectors(vector));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("default vector").isNotNull()
         .returns(vector, Vectors::getDefaultSingle)
         .returns(Optional.of(vector), Vectors::getSingle)
@@ -40,9 +40,9 @@ public final void testVectorsMetadata_default() {
   @Test
   public final void testVectorsMetadata_default_2d() {
     Float[][] vector = { { 1f, 2f, 3f }, { 1f, 2f, 3f } };
-    var metadata = new ObjectMetadata(m -> m.vectors(vector));
+    var metadata = ObjectMetadata.with(m -> m.vectors(vector));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("default 2d vector").isNotNull()
         .returns(vector, Vectors::getDefaultMulti)
         .returns(Optional.of(vector), Vectors::getMulti)
@@ -52,9 +52,9 @@ public final void testVectorsMetadata_default_2d() {
   @Test
   public final void testVectorsMetadata_named() {
     Float[] vector = { 1f, 2f, 3f };
-    var metadata = new ObjectMetadata(m -> m.vectors("vector-1", vector));
+    var metadata = ObjectMetadata.with(m -> m.vectors("vector-1", vector));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("named vector").isNotNull()
         .returns(vector, v -> v.getSingle("vector-1"))
         .returns(Optional.of(vector), Vectors::getSingle)
@@ -64,9 +64,9 @@ public final void testVectorsMetadata_named() {
   @Test
   public final void testVectorsMetadata_named_2d() {
     Float[][] vector = { { 1f, 2f, 3f }, { 1f, 2f, 3f } };
-    var metadata = new ObjectMetadata(m -> m.vectors("vector-1", vector));
+    var metadata = ObjectMetadata.with(m -> m.vectors("vector-1", vector));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("named 2d vector").isNotNull()
         .returns(vector, v -> v.getMulti("vector-1"))
         .returns(Optional.of(vector), Vectors::getMulti)
@@ -77,12 +77,12 @@ public final void testVectorsMetadata_named_2d() {
   public final void testVectorsMetadata_multiple_named() {
     Float[][] vector_1 = { { 1f, 2f, 3f }, { 1f, 2f, 3f } };
     Float[] vector_2 = { 4f, 5f, 6f };
-    var metadata = new ObjectMetadata(m -> m.vectors(
+    var metadata = ObjectMetadata.with(m -> m.vectors(
         named -> named
             .vector("vector-1", vector_1)
             .vector("vector-2", vector_2)));
 
-    Assertions.assertThat(metadata.vectors)
+    Assertions.assertThat(metadata.vectors())
         .as("multiple named vectors").isNotNull()
         .returns(vector_1, v -> v.getMulti("vector-1"))
         .returns(vector_2, v -> v.getSingle("vector-2"))