feat: common.struct + common.io.object

vorburger · vorburger · commit ca07cec807f4 · 2025-06-01T19:06:55.000+02:00
diff --git a/java/dev/enola/common/io/BUILD b/java/dev/enola/common/io/BUILD
@@ -22,6 +22,7 @@ java_library(
     srcs = glob(
         [
             "*.java",
+            "object/*.java",
             "mediatype/*.java",
             "hashbrown/*.java",
             "resource/**/*.java",
diff --git a/java/dev/enola/common/io/object/ObjectReader.java b/java/dev/enola/common/io/object/ObjectReader.java
@@ -0,0 +1,44 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.io.object;
+
+import dev.enola.common.io.resource.ReadableResource;
+
+import java.io.IOException;
+import java.util.Optional;
+
+public interface ObjectReader {
+
+    // TODO <T> Iterator<T> readAll(ReadableResource resource, Class<T> type) throws IOException;
+
+    default <T> T read(ReadableResource resource, Class<T> type) throws IOException {
+        return optional(resource, type)
+                .orElseThrow(
+                        () ->
+                                new IOException(
+                                        getClass()
+                                                + " cannot read "
+                                                + resource.uri()
+                                                + " as "
+                                                + type.getTypeName()));
+    }
+
+    <T> Optional<T> optional(ReadableResource resource, Class<T> type) throws IOException;
+
+    // PS: There is intentionally no ResolvedType / TypeReference / TypeToken sorta support!
+}
diff --git a/java/dev/enola/common/io/object/ObjectReaderChain.java b/java/dev/enola/common/io/object/ObjectReaderChain.java
@@ -0,0 +1,31 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.io.object;
+
+import dev.enola.common.io.resource.ReadableResource;
+
+import java.io.IOException;
+import java.util.Optional;
+
+public class ObjectReaderChain implements ObjectReader {
+
+    @Override
+    public <T> Optional<T> optional(ReadableResource resource, Class<T> type) throws IOException {
+        return null;
+    }
+}
diff --git a/java/dev/enola/common/io/object/ObjectWriter.java b/java/dev/enola/common/io/object/ObjectWriter.java
@@ -0,0 +1,20 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.io.object;
+
+public interface ObjectWriter {}
diff --git a/java/dev/enola/common/io/object/ObjectWriterChain.java b/java/dev/enola/common/io/object/ObjectWriterChain.java
@@ -0,0 +1,20 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.io.object;
+
+public class ObjectWriterChain implements ObjectWriter {}
diff --git a/java/dev/enola/common/io/object/package-info.java b/java/dev/enola/common/io/object/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** I/O for {@link dev.enola.common.struct}. */
+@NullMarked
+package dev.enola.common.io.object;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/java/dev/enola/common/struct/BUILD b/java/dev/enola/common/struct/BUILD
@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2023 The Enola <https://enola.dev> Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+load("@rules_java//java:defs.bzl", "java_library")
+load("//tools/bazel:junit.bzl", "junit_tests")
+
+java_library(
+    name = "struct",
+    srcs = glob(
+        ["*.java"],
+        exclude = ["*Test.java"],
+    ),
+    visibility = ["//:__subpackages__"],
+    deps = [
+        "@enola_maven//:com_google_errorprone_error_prone_annotations",
+        "@enola_maven//:com_google_guava_guava",
+        "@enola_maven//:org_jspecify_jspecify",
+    ],
+)
+
+junit_tests(
+    name = "tests",
+    srcs = glob(
+        ["*Test.java"],
+        allow_empty = True,
+    ),
+    deps = [
+        ":struct",
+    ],
+)
diff --git a/java/dev/enola/common/struct/CustomDatatype.java b/java/dev/enola/common/struct/CustomDatatype.java
@@ -0,0 +1,23 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.struct;
+
+import com.google.errorprone.annotations.Immutable;
+
+@Immutable
+public record CustomDatatype(int anInt, String aString) {}
diff --git a/java/dev/enola/common/struct/Example.java b/java/dev/enola/common/struct/Example.java
@@ -0,0 +1,42 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.struct;
+
+import org.jspecify.annotations.Nullable;
+
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public interface Example {
+
+    String text();
+
+    Integer number();
+
+    Instant instant();
+
+    @Nullable Example example();
+
+    List<Example> examplesInOrder();
+
+    Set<Example> examplesBag();
+
+    Map<String, Example> map();
+}
diff --git a/java/dev/enola/common/struct/ExampleIOTestFixture.java b/java/dev/enola/common/struct/ExampleIOTestFixture.java
@@ -0,0 +1,20 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.struct;
+
+public class ExampleIOTestFixture {}
diff --git a/java/dev/enola/common/struct/ExampleTest.java b/java/dev/enola/common/struct/ExampleTest.java
@@ -0,0 +1,70 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.struct;
+
+import org.junit.Test;
+
+import java.util.List;
+
+public class ExampleTest {
+
+    @Test
+    public void empty() {
+        // var o = ExtendedExampleBuilder().build();
+        // assertThat(o.text()).isNull();
+        // assertThat(o.number()).isNull();
+        // assertThat(o.instant()).isNull();
+        // assertThat(o.example()).isNull();
+
+        // assertThat(o.examplesInOrder()).isEmpty();
+        // assertThat(o.examplesBag()).isEmpty();
+        // assertThat(o.map()).isEmpty();
+
+        // assertThat(o.bigDecimal()).isNull();
+        // assertThat(o.url()).isNull();
+    }
+
+    @Test
+    public void set() {
+        // var o = ExtendedExampleBuilder().text("hello, world").build();
+        // assertThat(o.text()).isEqualTo("hello, world");
+    }
+
+    @Test
+    public void hashCodeEquals() {
+        // var o1 = ExtendedExampleBuilder().text("hello, world").build();
+        // var o2 = ExtendedExampleBuilder().text("hello, world").build();
+        // assertThat(o1).isEqualTo(o2);
+        // assertThat(o1.hashCode()).isEqualTo(o2.hashCode());
+    }
+
+    @Test
+    public void testToString() {
+        // var o = ExtendedExampleBuilder().text("hello, world").build();
+        // assertThat(o.toString()).contains("hello, world");
+        // assertThat(o.toString()).contains("text");
+    }
+
+    @Test
+    public void guavaImmutableList() {
+        // var o1 = ExtendedExampleBuilder().build();
+        // var o2 = ExtendedExampleBuilder().addExamplesInOrder(o1).build();
+        // assertThat(o.examplesInOrder()).containsExactly(o1);
+        // assertThat(o.examplesInOrder()).isInstanceOf(ImmutableList.class);
+    }
+}
diff --git a/java/dev/enola/common/struct/ExtendedExample.java b/java/dev/enola/common/struct/ExtendedExample.java
@@ -0,0 +1,30 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2025 The Enola <https://enola.dev> Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.enola.common.struct;
+
+import java.math.BigDecimal;
+import java.net.URI;
+
+public interface ExtendedExample extends Example {
+
+    CustomDatatype customDatatype();
+
+    BigDecimal bigDecimal();
+
+    URI url();
+}
diff --git a/java/dev/enola/common/struct/package-info.java b/java/dev/enola/common/struct/package-info.java
diff --git a/java/dev/enola/common/yamljson/JSONTest.java b/java/dev/enola/common/yamljson/JSONTest.java
diff --git a/java/dev/enola/common/yamljson/YAMLTest.java b/java/dev/enola/common/yamljson/YAMLTest.java

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ java_library(`
`22`	`22`	`srcs = glob(`
`23`	`23`	`[`
`24`	`24`	`"*.java",`
	`25`	`+ "object/*.java",`
`25`	`26`	`"mediatype/*.java",`
`26`	`27`	`"hashbrown/*.java",`
`27`	`28`	`"resource/*/.java",`