feat: Add StringRepresentable

gabizou · gabizou · commit 779d47211bf6 · 2024-06-03T20:10:51.000-07:00
For some usages it's helpful to have the serializable name that gets used and assists
with interpreting values from user parsed files.
diff --git a/src/main/java/org/spongepowered/api/data/Keys.java b/src/main/java/org/spongepowered/api/data/Keys.java
@@ -563,6 +563,12 @@ public final class Keys {
      */
     public static final Key<Value<Ticks>> BREEDING_COOLDOWN = Keys.key(ResourceKey.sponge("breeding_cooldown"), Ticks.class);
 
+    /**
+     * Whether a {@link BlockState} can be lit on fire by things like spreading lava,
+     * or sometimes a {@link ServerLocation} to be directionally specific.
+     */
+    public static final Key<Value<Boolean>> BURNABLE = Keys.key(ResourceKey.sponge("burnable"), Boolean.class);
+
     /**
      * The burntime of an {@link ItemStack} fuel in a furnace.
      * See {@link #FUEL} for the time
diff --git a/src/main/java/org/spongepowered/api/data/type/AttachmentSurface.java b/src/main/java/org/spongepowered/api/data/type/AttachmentSurface.java
@@ -31,6 +31,6 @@
  * Represents a block surface.
  */
 @CatalogedBy(AttachmentSurfaces.class)
-public interface AttachmentSurface extends DefaultedRegistryValue, Comparable<AttachmentSurface> {
+public interface AttachmentSurface extends DefaultedRegistryValue, Comparable<AttachmentSurface>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/BambooLeavesType.java b/src/main/java/org/spongepowered/api/data/type/BambooLeavesType.java
@@ -32,6 +32,6 @@
  * Represents the type of leaves of a {@link BlockTypes#BAMBOO} block.
  */
 @CatalogedBy(BambooLeavesTypes.class)
-public interface BambooLeavesType extends DefaultedRegistryValue, Comparable<BambooLeavesType> {
+public interface BambooLeavesType extends DefaultedRegistryValue, Comparable<BambooLeavesType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/BellAttachmentType.java b/src/main/java/org/spongepowered/api/data/type/BellAttachmentType.java
@@ -32,6 +32,6 @@
  * Represents the attachment-type of a {@link BlockTypes#BELL} block.
  */
 @CatalogedBy(BellAttachmentTypes.class)
-public interface BellAttachmentType extends DefaultedRegistryValue, Comparable<BellAttachmentType> {
+public interface BellAttachmentType extends DefaultedRegistryValue, Comparable<BellAttachmentType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/ChestAttachmentType.java b/src/main/java/org/spongepowered/api/data/type/ChestAttachmentType.java
@@ -34,6 +34,6 @@
  * chests into a double chests.
  */
 @CatalogedBy(ChestAttachmentTypes.class)
-public interface ChestAttachmentType extends DefaultedRegistryValue, Comparable<ChestAttachmentType> {
+public interface ChestAttachmentType extends DefaultedRegistryValue, Comparable<ChestAttachmentType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/ComparatorMode.java b/src/main/java/org/spongepowered/api/data/type/ComparatorMode.java
@@ -28,6 +28,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(ComparatorModes.class)
-public interface ComparatorMode extends DefaultedRegistryValue, Comparable<ComparatorMode> {
+public interface ComparatorMode extends DefaultedRegistryValue, Comparable<ComparatorMode>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/DoorHinge.java b/src/main/java/org/spongepowered/api/data/type/DoorHinge.java
@@ -32,6 +32,6 @@
  * Represents a side of a hinge.
  */
 @CatalogedBy(DoorHinges.class)
-public interface DoorHinge extends DefaultedRegistryValue, Cycleable<DoorHinge>, Comparable<DoorHinge> {
+public interface DoorHinge extends DefaultedRegistryValue, Cycleable<DoorHinge>, Comparable<DoorHinge>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/DripstoneSegment.java b/src/main/java/org/spongepowered/api/data/type/DripstoneSegment.java
@@ -28,6 +28,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(DripstoneSegments.class)
-public interface DripstoneSegment extends DefaultedRegistryValue, Comparable<DripstoneSegment> {
+public interface DripstoneSegment extends DefaultedRegistryValue, Comparable<DripstoneSegment>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/InstrumentType.java b/src/main/java/org/spongepowered/api/data/type/InstrumentType.java
@@ -32,7 +32,7 @@
  * Represents a type of instrument.
  */
 @CatalogedBy(InstrumentTypes.class)
-public interface InstrumentType extends DefaultedRegistryValue, Comparable<InstrumentType> {
+public interface InstrumentType extends DefaultedRegistryValue, Comparable<InstrumentType>, StringRepresentable {
 
     /**
      * Gets the {@link SoundType} that is used by
diff --git a/src/main/java/org/spongepowered/api/data/type/JigsawBlockOrientation.java b/src/main/java/org/spongepowered/api/data/type/JigsawBlockOrientation.java
@@ -33,7 +33,7 @@
  * Represents the front and top orientation of {@link BlockTypes#JIGSAW} blocks.
  */
 @CatalogedBy(JigsawBlockOrientations.class)
-public interface JigsawBlockOrientation extends DefaultedRegistryValue, Comparable<JigsawBlockOrientation> {
+public interface JigsawBlockOrientation extends DefaultedRegistryValue, Comparable<JigsawBlockOrientation>, StringRepresentable {
 
     /**
      * The front facing direction of a jigsaw block.
diff --git a/src/main/java/org/spongepowered/api/data/type/PistonType.java b/src/main/java/org/spongepowered/api/data/type/PistonType.java
@@ -31,6 +31,6 @@
  * Represents a "type" of piston.
  */
 @CatalogedBy(PistonTypes.class)
-public interface PistonType extends DefaultedRegistryValue, Comparable<PistonType> {
+public interface PistonType extends DefaultedRegistryValue, Comparable<PistonType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/PortionType.java b/src/main/java/org/spongepowered/api/data/type/PortionType.java
@@ -28,6 +28,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(PortionTypes.class)
-public interface PortionType extends DefaultedRegistryValue, Comparable<PortionType> {
+public interface PortionType extends DefaultedRegistryValue, Comparable<PortionType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/RailDirection.java b/src/main/java/org/spongepowered/api/data/type/RailDirection.java
@@ -29,6 +29,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(RailDirections.class)
-public interface RailDirection extends DefaultedRegistryValue, Cycleable<RailDirection>, Comparable<RailDirection> {
+public interface RailDirection extends DefaultedRegistryValue, Cycleable<RailDirection>, Comparable<RailDirection>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/SculkSensorState.java b/src/main/java/org/spongepowered/api/data/type/SculkSensorState.java
@@ -28,6 +28,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(SculkSensorStates.class)
-public interface SculkSensorState extends DefaultedRegistryValue, Comparable<SculkSensorState> {
+public interface SculkSensorState extends DefaultedRegistryValue, Comparable<SculkSensorState>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/SlabPortion.java b/src/main/java/org/spongepowered/api/data/type/SlabPortion.java
@@ -33,6 +33,6 @@
  * example {@link BlockTypes#STONE_SLAB}.
  */
 @CatalogedBy(SlabPortions.class)
-public interface SlabPortion extends DefaultedRegistryValue, Comparable<SlabPortion> {
+public interface SlabPortion extends DefaultedRegistryValue, Comparable<SlabPortion>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/StairShape.java b/src/main/java/org/spongepowered/api/data/type/StairShape.java
@@ -31,6 +31,6 @@
  * Represents a stair shape.
  */
 @CatalogedBy(StairShapes.class)
-public interface StairShape extends DefaultedRegistryValue, Comparable<StairShape> {
+public interface StairShape extends DefaultedRegistryValue, Comparable<StairShape>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/StringRepresentable.java b/src/main/java/org/spongepowered/api/data/type/StringRepresentable.java
@@ -0,0 +1,37 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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 org.spongepowered.api.data.type;
+
+/**
+ * Represents a type that has a stable string representation, usually an enumerated
+ * set of values, like most catalog types:
+ * {@link org.spongepowered.api.data.type.ArtType},
+ * {@link RabbitType}, {@link RailDirection}, etc.
+ */
+public interface StringRepresentable {
+
+    String serializationString();
+
+}
diff --git a/src/main/java/org/spongepowered/api/data/type/StructureMode.java b/src/main/java/org/spongepowered/api/data/type/StructureMode.java
@@ -32,6 +32,6 @@
  * Represents a mode that a {@link StructureBlock} may be in.
  */
 @CatalogedBy(StructureModes.class)
-public interface StructureMode extends DefaultedRegistryValue, Comparable<StructureMode> {
+public interface StructureMode extends DefaultedRegistryValue, Comparable<StructureMode>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/Tilt.java b/src/main/java/org/spongepowered/api/data/type/Tilt.java
@@ -28,7 +28,7 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(Tilts.class)
-public interface Tilt extends DefaultedRegistryValue, Comparable<Tilt> {
+public interface Tilt extends DefaultedRegistryValue, Comparable<Tilt>, StringRepresentable {
 
     /**
      * {@return Whether a block entering this tilt state will trigger any
diff --git a/src/main/java/org/spongepowered/api/data/type/WallConnectionState.java b/src/main/java/org/spongepowered/api/data/type/WallConnectionState.java
@@ -31,6 +31,6 @@
  * Represents the type of wall BlockStates
  */
 @CatalogedBy(WallConnectionStates.class)
-public interface WallConnectionState extends DefaultedRegistryValue, Comparable<WallConnectionState> {
+public interface WallConnectionState extends DefaultedRegistryValue, Comparable<WallConnectionState>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/data/type/WireAttachmentType.java b/src/main/java/org/spongepowered/api/data/type/WireAttachmentType.java
@@ -28,6 +28,6 @@
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 @CatalogedBy(WireAttachmentTypes.class)
-public interface WireAttachmentType extends DefaultedRegistryValue, Comparable<WireAttachmentType> {
+public interface WireAttachmentType extends DefaultedRegistryValue, Comparable<WireAttachmentType>, StringRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/registry/RegistryTypes.java b/src/main/java/org/spongepowered/api/registry/RegistryTypes.java
@@ -88,7 +88,9 @@
 import org.spongepowered.api.data.type.StairShape;
 import org.spongepowered.api.data.type.StructureMode;
 import org.spongepowered.api.data.type.Tilt;
+import org.spongepowered.api.data.type.TrialSpawnerState;
 import org.spongepowered.api.data.type.TropicalFishShape;
+import org.spongepowered.api.data.type.VaultState;
 import org.spongepowered.api.data.type.VillagerType;
 import org.spongepowered.api.data.type.WallConnectionState;
 import org.spongepowered.api.data.type.WireAttachmentType;
@@ -496,10 +498,14 @@ public final class RegistryTypes {
 
     public static final DefaultedRegistryType<TransactionType> TRANSACTION_TYPE = RegistryTypes.spongeKeyInGame("transaction_type");
 
+    public static final DefaultedRegistryType<TrialSpawnerState> TRIAL_SPAWNER_STATE = RegistryTypes.spongeKeyInGame("trial_spawner_state");
+
     public static final DefaultedRegistryType<TropicalFishShape> TROPICAL_FISH_SHAPE = RegistryTypes.spongeKeyInGame("tropical_fish_shape");
 
     public static final DefaultedRegistryType<Tilt> TILT = RegistryTypes.spongeKeyInGame("tilt");
 
+    public static final RegistryType<VaultState> VAULT_STATE = RegistryTypes.spongeKeyInGame("vault_state");
+
     public static final DefaultedRegistryType<Visibility> VISIBILITY = RegistryTypes.spongeKeyInGame("visibility");
 
     public static final DefaultedRegistryType<WallConnectionState> WALL_CONNECTION_STATE = RegistryTypes.spongeKeyInGame("wall_connection_state");
diff --git a/src/main/java/org/spongepowered/api/state/EnumStateProperty.java b/src/main/java/org/spongepowered/api/state/EnumStateProperty.java
@@ -25,6 +25,7 @@
 package org.spongepowered.api.state;
 
 import org.spongepowered.api.Sponge;
+import org.spongepowered.api.data.type.StringRepresentable;
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 /**
@@ -33,7 +34,7 @@
  * may not be exposed in the API.
  */
 @CatalogedBy(EnumStateProperties.class)
-public interface EnumStateProperty<E extends Comparable<E>> extends StateProperty<E> {
+public interface EnumStateProperty<E extends Comparable<E> & StringRepresentable> extends StateProperty<E> {
 
     static <E extends Comparable<E>> EnumStateProperty<E> of(String name) {
         return Sponge.game().factoryProvider().provide(Factory.class).of(name);
diff --git a/src/main/java/org/spongepowered/api/util/Axis.java b/src/main/java/org/spongepowered/api/util/Axis.java
@@ -24,12 +24,13 @@
  */
 package org.spongepowered.api.util;
 
+import org.spongepowered.api.data.type.StringRepresentable;
 import org.spongepowered.math.vector.Vector3d;
 
 /**
  * Represents a three dimensional cartesian axis.
  */
-public enum Axis implements Cycleable<Axis> {
+public enum Axis implements Cycleable<Axis>, StringRepresentable {
 
     X(new Vector3d(1, 0, 0)),
     Y(new Vector3d(0, 1, 0)),
@@ -142,4 +143,10 @@ public Axis cycleNext() {
         }
         return Axis.X;
     }
+
+    @Override
+    public String serializationString() {
+        return this.name();
+    }
+
 }
diff --git a/src/main/java/org/spongepowered/api/util/Direction.java b/src/main/java/org/spongepowered/api/util/Direction.java
@@ -25,6 +25,7 @@
 package org.spongepowered.api.util;
 
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
+import org.spongepowered.api.data.type.StringRepresentable;
 import org.spongepowered.math.GenericMath;
 import org.spongepowered.math.TrigMath;
 import org.spongepowered.math.vector.Vector3d;
@@ -42,7 +43,7 @@
  * <li>{@link #DOWN}  targeting towards -Y</li>
  * </ul>
  */
-public enum Direction {
+public enum Direction implements StringRepresentable {
     NORTH(new Vector3d(0, 0, -1), Division.CARDINAL),
     NORTH_NORTHEAST(new Vector3d(C.S8, 0, -C.C8), Division.SECONDARY_ORDINAL),
     NORTHEAST(new Vector3d(1, 0, -1), Division.ORDINAL),
@@ -341,6 +342,11 @@ public Vector3i asBlockOffset() {
         return this.blockOffset;
     }
 
+    @Override
+    public String serializationString() {
+        return this.name();
+    }
+
     private interface C {
 
         double C8 = Math.cos(Math.PI / 8);

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,6 @@`
`31`	`31`	`* Represents a block surface.`
`32`	`32`	`*/`
`33`	`33`	`@CatalogedBy(AttachmentSurfaces.class)`
`34`		`-public interface AttachmentSurface extends DefaultedRegistryValue, Comparable<AttachmentSurface> {`
	`34`	`+public interface AttachmentSurface extends DefaultedRegistryValue, Comparable<AttachmentSurface>, StringRepresentable {`
`35`	`35`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,6 @@`
`32`	`32`	`* Represents the type of leaves of a {@link BlockTypes#BAMBOO} block.`
`33`	`33`	`*/`
`34`	`34`	`@CatalogedBy(BambooLeavesTypes.class)`
`35`		`-public interface BambooLeavesType extends DefaultedRegistryValue, Comparable<BambooLeavesType> {`
	`35`	`+public interface BambooLeavesType extends DefaultedRegistryValue, Comparable<BambooLeavesType>, StringRepresentable {`
`36`	`36`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,6 @@`
`34`	`34`	`* chests into a double chests.`
`35`	`35`	`*/`
`36`	`36`	`@CatalogedBy(ChestAttachmentTypes.class)`
`37`		`-public interface ChestAttachmentType extends DefaultedRegistryValue, Comparable<ChestAttachmentType> {`
	`37`	`+public interface ChestAttachmentType extends DefaultedRegistryValue, Comparable<ChestAttachmentType>, StringRepresentable {`
`38`	`38`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@`
`28`	`28`	`import org.spongepowered.api.util.annotation.CatalogedBy;`
`29`	`29`
`30`	`30`	`@CatalogedBy(ComparatorModes.class)`
`31`		`-public interface ComparatorMode extends DefaultedRegistryValue, Comparable<ComparatorMode> {`
	`31`	`+public interface ComparatorMode extends DefaultedRegistryValue, Comparable<ComparatorMode>, StringRepresentable {`
`32`	`32`
`33`	`33`	`}`