Merge pull request #1421 from PaperMC/feature/easy-object-component

feature(api): Easier way to create object components

Author: kezz

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

@@ -50,6 +50,8 @@
 import net.kyori.adventure.text.format.TextColor;
 import net.kyori.adventure.text.format.TextDecoration;
 import net.kyori.adventure.text.object.ObjectContents;
+import net.kyori.adventure.text.object.ObjectContentsLike;
+import net.kyori.adventure.text.object.PlayerHeadObjectContents;
 import net.kyori.adventure.text.serializer.ComponentSerializer;
 import net.kyori.adventure.translation.Translatable;
 import net.kyori.adventure.util.ARGBLike;
@@ -561,6 +563,22 @@ static ObjectComponent object(final Consumer<? super ObjectComponent.Builder> co
     return AbstractBuilder.configureAndBuild(object(), consumer);
   }
 
+  /**
+   * Creates an object component with the given contents.
+   *
+   * @param objectContentsLike the contents
+   * @return an object component
+   * @since 5.2.0
+   */
+  @Contract(value = "_ -> new", pure = true)
+  static ObjectComponent object(final ObjectContentsLike objectContentsLike) {
+    if (requireNonNull(objectContentsLike, "objectContentsLike") instanceof PlayerHeadObjectContents.SkinSource skinSource) {
+      return object(ObjectContents.playerHead(skinSource));
+    } else {
+      return object(objectContentsLike.asObjectContents());
+    }
+  }
+
   /**
    * Creates an object component with the given contents.
    *

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

@@ -24,6 +24,7 @@
 package net.kyori.adventure.text;
 
 import net.kyori.adventure.text.object.ObjectContents;
+import net.kyori.adventure.text.object.ObjectContentsLike;
 import org.jspecify.annotations.Nullable;
 
 /**
@@ -32,7 +33,7 @@
  * @since 4.25.0
  * @sinceMinecraft 1.21.9
  */
-public sealed interface ObjectComponent extends ScopedComponent<ObjectComponent> permits ObjectComponentImpl {
+public sealed interface ObjectComponent extends ScopedComponent<ObjectComponent>, ObjectContentsLike permits ObjectComponentImpl {
   /**
    * Gets the contents of this object component.
    *

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

@@ -66,6 +66,11 @@ public ObjectComponent style(final Style style) {
     return create(this.children, style, this.contents, this.fallback);
   }
 
+  @Override
+  public ObjectContents asObjectContents() {
+    return this.contents;
+  }
+
   static final class BuilderImpl extends AbstractComponentBuilder<ObjectComponent, Builder> implements Builder {
     private @Nullable ObjectContents objectContents; // Not nullable for built type, it errors in builder.
     private @Nullable ComponentLike fallback;

api/src/main/java/net/kyori/adventure/text/object/ObjectContents.java

@@ -36,7 +36,7 @@
  * @since 4.25.0
  * @sinceMinecraft 1.21.9
  */
-public sealed interface ObjectContents permits SpriteObjectContents, PlayerHeadObjectContents {
+public sealed interface ObjectContents extends ObjectContentsLike permits SpriteObjectContents, PlayerHeadObjectContents {
   /**
    * Creates a sprite contents with the given atlas and sprite.
    *
@@ -108,4 +108,9 @@ static PlayerHeadObjectContents playerHead(final UUID id) {
   static PlayerHeadObjectContents playerHead(final PlayerHeadObjectContents.SkinSource skinSource) {
     return playerHead().skin(skinSource).build();
   }
+
+  @Override
+  default ObjectContents asObjectContents() {
+    return this;
+  }
 }

api/src/main/java/net/kyori/adventure/text/object/ObjectContentsLike.java

@@ -0,0 +1,42 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2025 KyoriPowered
+ *
+ * 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 net.kyori.adventure.text.object;
+
+import org.jetbrains.annotations.Contract;
+
+/**
+ * Something that can be represented as an {@link ObjectContents}.
+ *
+ * @since 5.2.0
+ */
+public interface ObjectContentsLike {
+  /**
+   * Gets an {@link ObjectContents} representation.
+   *
+   * @return the object contents
+   * @since 5.2.0
+   */
+  @Contract(pure = true)
+  ObjectContents asObjectContents();
+}

api/src/main/java/net/kyori/adventure/text/object/PlayerHeadObjectContents.java

@@ -294,7 +294,7 @@ sealed interface Builder permits PlayerHeadObjectContentsImpl.BuilderImpl {
    * @see ObjectContents#playerHead(SkinSource)
    * @since 4.25.0
    */
-  interface SkinSource {
+  interface SkinSource extends ObjectContentsLike {
     /**
      * Applies this skin source to the given player head contents builder.
      *
@@ -305,5 +305,10 @@ interface SkinSource {
     @PlatformAPI
     @ApiStatus.Internal
     void applySkinToPlayerHeadContents(Builder builder);
+
+    @Override
+    default ObjectContents asObjectContents() {
+      return ObjectContents.playerHead(this);
+    }
   }
 }