aboutsummaryrefslogtreecommitdiffhomepage
path: root/patches/api/0369-Added-byte-array-serialization-deserialization-for-P.patch
blob: 9b71f12681f64753da9fc5cbb504119890462888 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
 }