Unify syncing objects under interface

Author: Kneelawk

modules/syncing-core-xplat/src/main/java/com/kneelawk/graphlib/syncing/api/util/ObjectSyncing.java

@@ -0,0 +1,52 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2024 Cyan Kneelawk.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package com.kneelawk.graphlib.syncing.api.util;
+
+import org.jetbrains.annotations.NotNull;
+
+import net.minecraft.resources.ResourceLocation;
+
+import com.kneelawk.graphlib.api.util.ObjectType;
+
+/**
+ * Simple super type for all syncing types.
+ *
+ * @param <T> the object type this syncing type is associated with.
+ */
+public interface ObjectSyncing<T extends ObjectType> {
+    /**
+     * {@return the object type associated with this syncing type}
+     */
+    @NotNull
+    T getType();
+
+    /**
+     * {@return the id associated with this syncing type}
+     */
+    default ResourceLocation getId() {
+        return getType().getId();
+    }
+}

modules/syncing-knet-xplat/src/main/java/com/kneelawk/graphlib/syncing/knet/api/graph/user/BlockNodeSyncing.java

@@ -37,6 +37,7 @@
 import com.kneelawk.graphlib.api.graph.GraphUniverse;
 import com.kneelawk.graphlib.api.graph.user.BlockNode;
 import com.kneelawk.graphlib.api.graph.user.BlockNodeType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 import com.kneelawk.graphlib.syncing.knet.api.SyncingKNet;
 import com.kneelawk.graphlib.syncing.knet.api.graph.KNetSyncedUniverse;
 import com.kneelawk.graphlib.syncing.knet.impl.StreamCodecHelper;
@@ -47,7 +48,7 @@
 /**
  * Holds a block node encoder and decoder.
  */
-public final class BlockNodeSyncing {
+public final class BlockNodeSyncing implements ObjectSyncing<BlockNodeType> {
     /**
      * {@link BlockNodeSyncing} static stream codec.
      * <p>
@@ -80,6 +81,7 @@ private BlockNodeSyncing(@NotNull BlockNodeType type,
     /**
      * {@return this syncing descriptor's type}
      */
+    @Override
     public @NotNull BlockNodeType getType() {
         return type;
     }

modules/syncing-knet-xplat/src/main/java/com/kneelawk/graphlib/syncing/knet/api/graph/user/GraphEntitySyncing.java

@@ -37,6 +37,7 @@
 import com.kneelawk.graphlib.api.graph.GraphUniverse;
 import com.kneelawk.graphlib.api.graph.user.GraphEntity;
 import com.kneelawk.graphlib.api.graph.user.GraphEntityType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 import com.kneelawk.graphlib.syncing.knet.api.SyncingKNet;
 import com.kneelawk.graphlib.syncing.knet.api.graph.KNetSyncedUniverse;
 import com.kneelawk.graphlib.syncing.knet.impl.StreamCodecHelper;
@@ -49,7 +50,7 @@
  *
  * @param <G> the type of graph entity this syncs.
  */
-public final class GraphEntitySyncing<G extends GraphEntity<G>> {
+public final class GraphEntitySyncing<G extends GraphEntity<G>> implements ObjectSyncing<GraphEntityType<G>> {
     /**
      * {@link GraphEntitySyncing} static codec.
      * <p>
@@ -95,6 +96,7 @@ private GraphEntitySyncing(@NotNull GraphEntityType<G> type,
     /**
      * {@return this syncing descriptor's type}
      */
+    @Override
     public @NotNull GraphEntityType<G> getType() {
         return type;
     }

modules/syncing-knet-xplat/src/main/java/com/kneelawk/graphlib/syncing/knet/api/graph/user/LinkEntitySyncing.java

@@ -36,6 +36,7 @@
 import com.kneelawk.graphlib.api.graph.GraphUniverse;
 import com.kneelawk.graphlib.api.graph.user.LinkEntity;
 import com.kneelawk.graphlib.api.graph.user.LinkEntityType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 import com.kneelawk.graphlib.syncing.knet.api.SyncingKNet;
 import com.kneelawk.graphlib.syncing.knet.api.graph.KNetSyncedUniverse;
 import com.kneelawk.graphlib.syncing.knet.impl.StreamCodecHelper;
@@ -46,7 +47,7 @@
 /**
  * Holds a link entity encoder and decoder.
  */
-public final class LinkEntitySyncing {
+public final class LinkEntitySyncing implements ObjectSyncing<LinkEntityType> {
     /**
      * {@link LinkEntitySyncing} static codec.
      * <p>
@@ -79,6 +80,7 @@ private LinkEntitySyncing(@NotNull LinkEntityType type,
     /**
      * {@return this syncing descriptor's type}
      */
+    @Override
     public @NotNull LinkEntityType getType() {
         return type;
     }

modules/syncing-knet-xplat/src/main/java/com/kneelawk/graphlib/syncing/knet/api/graph/user/LinkKeySyncing.java

@@ -36,6 +36,7 @@
 import com.kneelawk.graphlib.api.graph.GraphUniverse;
 import com.kneelawk.graphlib.api.graph.user.LinkKey;
 import com.kneelawk.graphlib.api.graph.user.LinkKeyType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 import com.kneelawk.graphlib.syncing.knet.api.SyncingKNet;
 import com.kneelawk.graphlib.syncing.knet.api.graph.KNetSyncedUniverse;
 import com.kneelawk.graphlib.syncing.knet.impl.StreamCodecHelper;
@@ -46,7 +47,7 @@
 /**
  * Holds a link key encoder and decoder.
  */
-public final class LinkKeySyncing {
+public final class LinkKeySyncing implements ObjectSyncing<LinkKeyType> {
     /**
      * {@link LinkKeySyncing} static codec.
      * <p>
@@ -79,6 +80,7 @@ private LinkKeySyncing(@NotNull LinkKeyType type,
     /**
      * {@return this syncing descriptor's type}
      */
+    @Override
     public @NotNull LinkKeyType getType() {
         return type;
     }

modules/syncing-knet-xplat/src/main/java/com/kneelawk/graphlib/syncing/knet/api/graph/user/NodeEntitySyncing.java

@@ -36,6 +36,7 @@
 import com.kneelawk.graphlib.api.graph.GraphUniverse;
 import com.kneelawk.graphlib.api.graph.user.NodeEntity;
 import com.kneelawk.graphlib.api.graph.user.NodeEntityType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 import com.kneelawk.graphlib.syncing.knet.api.SyncingKNet;
 import com.kneelawk.graphlib.syncing.knet.api.graph.KNetSyncedUniverse;
 import com.kneelawk.graphlib.syncing.knet.impl.StreamCodecHelper;
@@ -46,7 +47,7 @@
 /**
  * Holds a node entity encoder and decoder.
  */
-public final class NodeEntitySyncing {
+public final class NodeEntitySyncing implements ObjectSyncing<NodeEntityType> {
     /**
      * {@link NodeEntitySyncing} static codec.
      * <p>
@@ -79,6 +80,7 @@ private NodeEntitySyncing(@NotNull NodeEntityType type,
     /**
      * {@return this syncing descriptor's type}
      */
+    @Override
     public @NotNull NodeEntityType getType() {
         return type;
     }

modules/syncing-lns/src/main/java/com/kneelawk/graphlib/syncing/lns/api/graph/user/BlockNodeSyncing.java

@@ -37,11 +37,12 @@
 
 import com.kneelawk.graphlib.api.graph.user.BlockNode;
 import com.kneelawk.graphlib.api.graph.user.BlockNodeType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 
 /**
  * Holds a block node encoder and decoder.
  */
-public final class BlockNodeSyncing {
+public final class BlockNodeSyncing implements ObjectSyncing<BlockNodeType> {
     private final @NotNull BlockNodeType type;
     private final @NotNull BlockNodePacketEncoder<?> encoder;
     private final @NotNull BlockNodePacketDecoder decoder;
@@ -56,6 +57,7 @@ private BlockNodeSyncing(@NotNull BlockNodeType type, @NotNull BlockNodePacketEn
     /**
      * {@return the type associated with this syncing}
      */
+    @Override
     public @NotNull BlockNodeType getType() {
         return type;
     }

modules/syncing-lns/src/main/java/com/kneelawk/graphlib/syncing/lns/api/graph/user/GraphEntitySyncing.java

@@ -37,13 +37,14 @@
 
 import com.kneelawk.graphlib.api.graph.user.GraphEntity;
 import com.kneelawk.graphlib.api.graph.user.GraphEntityType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 
 /**
  * Holds a graph entity encoder and decoder.
  *
  * @param <G> the type of graph entity this syncs.
  */
-public final class GraphEntitySyncing<G extends GraphEntity<G>> {
+public final class GraphEntitySyncing<G extends GraphEntity<G>> implements ObjectSyncing<GraphEntityType<G>> {
     private final @NotNull GraphEntityType<G> type;
     private final @NotNull GraphEntityPacketEncoder<G> encoder;
     private final @NotNull GraphEntityPacketDecoder decoder;
@@ -58,6 +59,7 @@ private GraphEntitySyncing(@NotNull GraphEntityType<G> type, @NotNull GraphEntit
     /**
      * {@return the type associated with this syncing}
      */
+    @Override
     public @NotNull GraphEntityType<G> getType() {
         return type;
     }

modules/syncing-lns/src/main/java/com/kneelawk/graphlib/syncing/lns/api/graph/user/LinkEntitySyncing.java

@@ -34,14 +34,14 @@
 import alexiil.mc.lib.net.InvalidInputDataException;
 import alexiil.mc.lib.net.NetByteBuf;
 
-import com.kneelawk.graphlib.api.graph.user.BlockNodeType;
 import com.kneelawk.graphlib.api.graph.user.LinkEntity;
 import com.kneelawk.graphlib.api.graph.user.LinkEntityType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 
 /**
  * Holds a link entity encoder and decoder.
  */
-public final class LinkEntitySyncing {
+public final class LinkEntitySyncing implements ObjectSyncing<LinkEntityType> {
     private final @NotNull LinkEntityType type;
     private final @NotNull LinkEntityPacketEncoder<?> encoder;
     private final @NotNull LinkEntityPacketDecoder decoder;
@@ -56,6 +56,7 @@ private LinkEntitySyncing(@NotNull LinkEntityType type, @NotNull LinkEntityPacke
     /**
      * {@return the type associated with this syncing}
      */
+    @Override
     public @NotNull LinkEntityType getType() {
         return type;
     }

modules/syncing-lns/src/main/java/com/kneelawk/graphlib/syncing/lns/api/graph/user/LinkKeySyncing.java

@@ -34,14 +34,14 @@
 import alexiil.mc.lib.net.InvalidInputDataException;
 import alexiil.mc.lib.net.NetByteBuf;
 
-import com.kneelawk.graphlib.api.graph.user.BlockNodeType;
 import com.kneelawk.graphlib.api.graph.user.LinkKey;
 import com.kneelawk.graphlib.api.graph.user.LinkKeyType;
+import com.kneelawk.graphlib.syncing.api.util.ObjectSyncing;
 
 /**
  * Holds a link key encoder and decoder.
  */
-public final class LinkKeySyncing {
+public final class LinkKeySyncing implements ObjectSyncing<LinkKeyType> {
     private final @NotNull LinkKeyType type;
     private final @NotNull LinkKeyPacketEncoder<?> encoder;
     private final @NotNull LinkKeyPacketDecoder decoder;
@@ -56,6 +56,7 @@ private LinkKeySyncing(@NotNull LinkKeyType type, @NotNull LinkKeyPacketEncoder<
     /**
      * {@return the type associated with this syncing}
      */
+    @Override
     public @NotNull LinkKeyType getType() {
         return type;
     }