Obsidian/patches/api/0360-Added-byte-array-serialization-deserialization-for-P.patch
2024-06-14 14:07:44 -07:00

51 lines
2.1 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Nex <nex@bits.team>
Date: Thu, 24 Feb 2022 16:28:08 +0100
Subject: [PATCH] Added byte array serialization/deserialization for
PersistentDataContainers
diff --git a/src/main/java/org/bukkit/persistence/PersistentDataContainer.java b/src/main/java/org/bukkit/persistence/PersistentDataContainer.java
index 18fc4f1c7151bfdeed32a52cf5050a76ebc391d6..decf3b1949d4653a9fb01684b93ff91048137076 100644
--- a/src/main/java/org/bukkit/persistence/PersistentDataContainer.java
+++ b/src/main/java/org/bukkit/persistence/PersistentDataContainer.java
@@ -184,4 +184,39 @@ public interface PersistentDataContainer {
*/
@NotNull
PersistentDataAdapterContext getAdapterContext();
+
+ // Paper start - byte array serialization
+ /**
+ * Serialize this {@link PersistentDataContainer} instance to a
+ * byte array.
+ *
+ * @return a binary representation of this container
+ * @throws java.io.IOException if we fail to write this container to a byte array
+ */
+ byte @NotNull [] serializeToBytes() throws java.io.IOException;
+
+ /**
+ * Read values from a serialised byte array into this
+ * {@link PersistentDataContainer} instance.
+ *
+ * @param bytes the byte array to read from
+ * @param clear if true, this {@link PersistentDataContainer} instance
+ * will be cleared before reading
+ * @throws java.io.IOException if the byte array has an invalid format
+ */
+ void readFromBytes(byte @NotNull [] bytes, boolean clear) throws java.io.IOException;
+
+ /**
+ * Read values from a serialised byte array into this
+ * {@link PersistentDataContainer} instance.
+ * This method has the same effect as
+ * <code>PersistentDataContainer#readFromBytes(bytes, true)</code>
+ *
+ * @param bytes the byte array to read from
+ * @throws java.io.IOException if the byte array has an invalid format
+ */
+ default void readFromBytes(final byte @NotNull [] bytes) throws java.io.IOException {
+ this.readFromBytes(bytes, true);
+ }
+ // Paper end - byte array serialization
}