From 77296e8fba737310c3fd108ebac94573db250020 Mon Sep 17 00:00:00 2001
From: Bukkit/Spigot <noreply+git-bukkit@papermc.io>
Date: Mon, 17 Dec 2018 18:28:17 -0500
Subject: [PATCH] Add BlockData#getAsString(boolean) to hide unspecified states

By: Parker Hawke <hawkeboyz2@hotmail.com>
---
 .../java/org/bukkit/block/data/BlockData.java | 28 +++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/paper-api/src/main/java/org/bukkit/block/data/BlockData.java b/paper-api/src/main/java/org/bukkit/block/data/BlockData.java
index b78260c7b0..cf4edde485 100644
--- a/paper-api/src/main/java/org/bukkit/block/data/BlockData.java
+++ b/paper-api/src/main/java/org/bukkit/block/data/BlockData.java
@@ -21,6 +21,34 @@ public interface BlockData extends Cloneable {
      */
     String getAsString();
 
+    /**
+     * Gets a string, which when passed into a method such as
+     * {@link Server#createBlockData(java.lang.String)} will recreate this or a
+     * similar instance where unspecified states (if any) may be optionally
+     * omitted. If this instance was parsed and states are omitted, this exact
+     * instance will be creatable when parsed again, else their equality cannot
+     * be guaranteed.
+     * <p>
+     * This method will only take effect for BlockData instances created by
+     * methods such as {@link Server#createBlockData(String)} or any similar
+     * method whereby states are optionally defined. If otherwise, the result of
+     * {@link #getAsString()} will be returned. The following behaviour would be
+     * expected:
+     * <pre>{@code
+     * String dataString = "minecraft:chest[waterlogged=true]"
+     * BlockData data = Bukkit.createBlockData(dataString);
+     * dataString.equals(data.getAsString(true)); // This would return true
+     * dataString.equals(data.getAsString(false)); // This would return false as all states are present
+     * dataString.equals(data.getAsString()); // This is equivalent to the above, "getAsString(false)"
+     * }</pre>
+     *
+     * @param hideUnspecified true if unspecified states should be omitted,
+     * false if they are to be shown as performed by {@link #getAsString()}.
+     *
+     * @return serialized data string for this block
+     */
+    String getAsString(boolean hideUnspecified);
+
     /**
      * Merges all explicitly set states from the given data with this BlockData.
      * <br>