nbt: Add friendly output formatting for IntelliJ debugger

Author: zml2008

api/src/main/java/net/kyori/adventure/text/AbstractComponent.java

@@ -143,7 +143,7 @@ protected Stream<? extends ExaminableProperty> examinablePropertiesWithoutChildr
     return Stream.concat(
       this.examinablePropertiesWithoutChildren(),
       Stream.of(
-        ExaminableProperty.of("style", this.style)
+        ExaminableProperty.of("children", this.children)
       )
     );
   }

nbt/build.gradle

@@ -2,6 +2,7 @@ dependencies {
   api("net.kyori:examination-api:1.1.0")
   api("net.kyori:examination-string:1.1.0")
   compileOnlyApi("org.checkerframework:checker-qual:3.10.0")
+  compileOnlyApi("org.jetbrains:annotations:20.1.0")
 }
 
 jar {

nbt/src/main/java/net/kyori/adventure/nbt/ByteArrayBinaryTagImpl.java

@@ -29,7 +29,9 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
+@Debug.Renderer(text = "\"byte[\" + this.value.length + \"]\"", childrenArray = "this.value", hasChildren = "this.value.length > 0")
 final class ByteArrayBinaryTagImpl extends ArrayBinaryTagImpl implements ByteArrayBinaryTag {
   final byte[] value;
 

nbt/src/main/java/net/kyori/adventure/nbt/ByteBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@code byte} value.
@@ -79,6 +80,7 @@ public interface ByteBinaryTag extends NumberBinaryTag {
   byte value();
 }
 
+@Debug.Renderer(text = "\"0x\" + Integer.toString(this.value, 16)", hasChildren = "false")
 final class ByteBinaryTagImpl extends AbstractBinaryTag implements ByteBinaryTag {
   private final byte value;
 

nbt/src/main/java/net/kyori/adventure/nbt/CompoundBinaryTagImpl.java

@@ -33,9 +33,11 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 import static java.util.Objects.requireNonNull;
 
+@Debug.Renderer(text = "\"CompoundBinaryTag[length=\" + this.tags.size() + \"]\"", childrenArray = "this.tags.entrySet().toArray()", hasChildren = "!this.tags.isEmpty()")
 final class CompoundBinaryTagImpl extends AbstractBinaryTag implements CompoundBinaryTag {
   static final CompoundBinaryTag EMPTY = new CompoundBinaryTagImpl(Collections.emptyMap());
   private final Map<String, BinaryTag> tags;

nbt/src/main/java/net/kyori/adventure/nbt/DoubleBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@code double} value.
@@ -59,6 +60,7 @@ public interface DoubleBinaryTag extends NumberBinaryTag {
   double value();
 }
 
+@Debug.Renderer(text = "String.valueOf(this.value) + \"d\"", hasChildren = "false")
 final class DoubleBinaryTagImpl extends AbstractBinaryTag implements DoubleBinaryTag {
   private final double value;
 

nbt/src/main/java/net/kyori/adventure/nbt/FloatBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@code float} value.
@@ -59,6 +60,7 @@ public interface FloatBinaryTag extends NumberBinaryTag {
   float value();
 }
 
+@Debug.Renderer(text = "String.valueOf(this.value) + \"f\"", hasChildren = "false")
 final class FloatBinaryTagImpl extends AbstractBinaryTag implements FloatBinaryTag {
   private final float value;
 

nbt/src/main/java/net/kyori/adventure/nbt/IntArrayBinaryTagImpl.java

@@ -33,7 +33,9 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
+@Debug.Renderer(text = "\"int[\" + this.value.length + \"]\"", childrenArray = "this.value", hasChildren = "this.value.length > 0")
 final class IntArrayBinaryTagImpl extends ArrayBinaryTagImpl implements IntArrayBinaryTag {
   final int[] value;
 

nbt/src/main/java/net/kyori/adventure/nbt/IntBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding an {@code int} value.
@@ -59,6 +60,7 @@ public interface IntBinaryTag extends NumberBinaryTag {
   int value();
 }
 
+@Debug.Renderer(text = "String.valueOf(this.value) + \"i\"", hasChildren = "false")
 final class IntBinaryTagImpl extends AbstractBinaryTag implements IntBinaryTag {
   private final int value;
 

nbt/src/main/java/net/kyori/adventure/nbt/ListBinaryTagImpl.java

@@ -36,7 +36,9 @@
 import org.checkerframework.checker.index.qual.NonNegative;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
+@Debug.Renderer(text = "\"ListBinaryTag[type=\" + this.type.toString() + \"]\"", childrenArray = "this.tags.toArray()", hasChildren = "!this.tags.isEmpty()")
 final class ListBinaryTagImpl extends AbstractBinaryTag implements ListBinaryTag {
   static final ListBinaryTag EMPTY = new ListBinaryTagImpl(BinaryTagTypes.END, Collections.emptyList());
   private final List<BinaryTag> tags;

nbt/src/main/java/net/kyori/adventure/nbt/LongArrayBinaryTagImpl.java

@@ -33,7 +33,9 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
+@Debug.Renderer(text = "\"long[\" + this.value.length + \"]\"", childrenArray = "this.value", hasChildren = "this.value.length > 0")
 final class LongArrayBinaryTagImpl extends ArrayBinaryTagImpl implements LongArrayBinaryTag {
   final long[] value;
 

nbt/src/main/java/net/kyori/adventure/nbt/LongBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@code long} value.
@@ -59,6 +60,7 @@ public interface LongBinaryTag extends NumberBinaryTag {
   long value();
 }
 
+@Debug.Renderer(text = "String.valueOf(this.value) + \"l\"", hasChildren = "false")
 final class LongBinaryTagImpl extends AbstractBinaryTag implements LongBinaryTag {
   private final long value;
 

nbt/src/main/java/net/kyori/adventure/nbt/ShortBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@code short} value.
@@ -59,6 +60,7 @@ public interface ShortBinaryTag extends NumberBinaryTag {
   short value();
 }
 
+@Debug.Renderer(text = "String.valueOf(this.value) + \"s\"", hasChildren = "false")
 final class ShortBinaryTagImpl extends AbstractBinaryTag implements ShortBinaryTag {
   private final short value;
 

nbt/src/main/java/net/kyori/adventure/nbt/StringBinaryTag.java

@@ -27,6 +27,7 @@
 import net.kyori.examination.ExaminableProperty;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Debug;
 
 /**
  * A binary tag holding a {@link String} value.
@@ -59,6 +60,7 @@ public interface StringBinaryTag extends BinaryTag {
   @NonNull String value();
 }
 
+@Debug.Renderer(text = "\"\\\"\" + this.value + \"\\\"\"", hasChildren = "false")
 final class StringBinaryTagImpl extends AbstractBinaryTag implements StringBinaryTag {
   private final String value;