Rework of chat elements

Author: Exceptionflug

README.md

@@ -31,7 +31,7 @@ We provide some documentation on how to migrate your existing plugin to use the
 <dependency>
     <groupId>dev.simplix</groupId>
     <artifactId>protocolize-api</artifactId>
-    <version>2.3.2</version>
+    <version>2.3.3</version>
     <scope>provided</scope>
 </dependency>
 ```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>dev.simplix</groupId>
     <artifactId>protocolize</artifactId>
-    <version>2.3.2</version>
+    <version>2.3.3</version>
     <packaging>pom</packaging>
 
     <modules>
@@ -23,7 +23,7 @@
         <bungeecord.version>1.20-R0.2-SNAPSHOT</bungeecord.version>
         <velocity.version>3.2.0-SNAPSHOT</velocity.version>
         <bytebuddy.version>1.11.13</bytebuddy.version>
-        <data.version>2.3.2.1</data.version>
+        <data.version>2.3.3</data.version>
     </properties>
 
     <repositories>

protocolize-api/pom.xml

@@ -7,11 +7,11 @@
     <parent>
         <groupId>dev.simplix</groupId>
         <artifactId>protocolize</artifactId>
-        <version>2.3.2</version>
+        <version>2.3.3</version>
     </parent>
 
     <artifactId>protocolize-api</artifactId>
-    <version>2.3.2</version>
+    <version>2.3.3</version>
 
     <dependencies>
         <dependency>

protocolize-api/src/main/java/dev/simplix/protocolize/api/ComponentConverter.java

@@ -1,5 +1,7 @@
 package dev.simplix.protocolize.api;
 
+import net.querz.nbt.tag.Tag;
+
 /**
  * Date: 24.08.2021
  *
@@ -11,8 +13,14 @@ public interface ComponentConverter<T> {
 
     String toJson(T component);
 
+    Tag<?> toNbt(T component);
+
     T fromLegacyText(String legacyText);
 
     T fromJson(String json);
 
+    T fromNbt(Tag<?> tag);
+
+    void disableItalic(T component);
+
 }

protocolize-api/src/main/java/dev/simplix/protocolize/api/chat/ChatElement.java

@@ -0,0 +1,37 @@
+package dev.simplix.protocolize.api.chat;
+
+import dev.simplix.protocolize.api.ComponentConverter;
+import dev.simplix.protocolize.api.Protocolize;
+import dev.simplix.protocolize.api.providers.ComponentConverterProvider;
+import net.querz.nbt.tag.Tag;
+
+public interface ChatElement<T> {
+
+    static <T> ChatElement<T> of(T component) {
+        ComponentConverter<T> converter = (ComponentConverter<T>) Protocolize.getService(ComponentConverterProvider.class).platformConverter();
+        return new ChatElementImpl<>(converter, component);
+    }
+
+    static <T> ChatElement<T> ofLegacyText(String legacyText) {
+        return ChatElementImpl.ofLegacyText(legacyText);
+    }
+
+    static <T> ChatElement<T> ofJson(String json) {
+        return ChatElementImpl.ofJson(json);
+    }
+
+    static <T> ChatElement<T> ofNbt(Tag<?> nbt) {
+        return ChatElementImpl.ofNbt(nbt);
+    }
+
+    ChatElement<T> disableItalic();
+
+    T asComponent();
+
+    String asJson();
+
+    String asLegacyText();
+
+    Tag<?> asNbt();
+
+}

protocolize-api/src/main/java/dev/simplix/protocolize/api/chat/ChatElementImpl.java

@@ -0,0 +1,59 @@
+package dev.simplix.protocolize.api.chat;
+
+import dev.simplix.protocolize.api.ComponentConverter;
+import dev.simplix.protocolize.api.Protocolize;
+import dev.simplix.protocolize.api.providers.ComponentConverterProvider;
+import net.querz.nbt.tag.Tag;
+
+class ChatElementImpl<T> implements ChatElement<T> {
+
+    private final ComponentConverter<T> componentConverter;
+    private T component;
+
+    ChatElementImpl(ComponentConverter<T> componentConverter, T component) {
+        this.componentConverter = componentConverter;
+        this.component = component;
+    }
+
+    static <T> ChatElement<T> ofLegacyText(String text) {
+        ComponentConverter<T> converter = (ComponentConverter<T>) Protocolize.getService(ComponentConverterProvider.class).platformConverter();
+        return new ChatElementImpl<>(converter, converter.fromLegacyText(text));
+    }
+
+    static <T> ChatElement<T> ofJson(String text) {
+        ComponentConverter<T> converter = (ComponentConverter<T>) Protocolize.getService(ComponentConverterProvider.class).platformConverter();
+        return new ChatElementImpl<>(converter, converter.fromJson(text));
+    }
+
+    static <T> ChatElement<T> ofNbt(Tag<?> tag) {
+        ComponentConverter<T> converter = (ComponentConverter<T>) Protocolize.getService(ComponentConverterProvider.class).platformConverter();
+        return new ChatElementImpl<>(converter, converter.fromNbt(tag));
+    }
+
+    @Override
+    public ChatElement<T> disableItalic() {
+        componentConverter.disableItalic(component);
+        return this;
+    }
+
+    @Override
+    public T asComponent() {
+        return component;
+    }
+
+    @Override
+    public String asJson() {
+        return componentConverter.toJson(component);
+    }
+
+    @Override
+    public String asLegacyText() {
+        return componentConverter.toLegacyText(component);
+    }
+
+    @Override
+    public Tag<?> asNbt() {
+        return componentConverter.toNbt(component);
+    }
+
+}

protocolize-api/src/main/java/dev/simplix/protocolize/api/inventory/Inventory.java

@@ -2,6 +2,7 @@
 
 import dev.simplix.protocolize.api.ComponentConverter;
 import dev.simplix.protocolize.api.Protocolize;
+import dev.simplix.protocolize.api.chat.ChatElement;
 import dev.simplix.protocolize.api.item.BaseItemStack;
 import dev.simplix.protocolize.api.item.ItemStack;
 import dev.simplix.protocolize.api.providers.ComponentConverterProvider;
@@ -29,14 +30,11 @@
 @Accessors(fluent = true)
 public class Inventory {
 
-    private static final ComponentConverter CONVERTER = Protocolize.getService(ComponentConverterProvider.class)
-        .platformConverter();
-
     private final Map<Integer, BaseItemStack> items = new ConcurrentHashMap<>();
     private final List<Consumer<InventoryClick>> clickConsumers = new ArrayList<>();
     private final List<Consumer<InventoryClose>> closeConsumers = new ArrayList<>();
     private InventoryType type;
-    private String titleJson;
+    private ChatElement<?> title;
 
     public Inventory(InventoryType type) {
         this.type = type;
@@ -73,28 +71,6 @@ public Inventory item(int slot, ItemStack stack) {
         return this;
     }
 
-    public <T> T title() {
-        return title(false);
-    }
-
-    public <T> T title(boolean legacyString) {
-        if (legacyString) {
-            return (T) CONVERTER.toLegacyText(CONVERTER.fromJson(titleJson));
-        } else {
-            return (T) CONVERTER.fromJson(titleJson);
-        }
-    }
-
-    public Inventory title(String legacyName) {
-        this.titleJson = CONVERTER.toJson(CONVERTER.fromLegacyText(legacyName));
-        return this;
-    }
-
-    public Inventory title(Object titleComponent) {
-        this.titleJson = CONVERTER.toJson(titleComponent);
-        return this;
-    }
-
     public Inventory onClick(Consumer<InventoryClick> consumer) {
         clickConsumers.add(consumer);
         return this;

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/BaseItemStack.java

@@ -1,5 +1,7 @@
 package dev.simplix.protocolize.api.item;
 
+import dev.simplix.protocolize.api.chat.ChatElement;
+
 import java.util.List;
 import java.util.Set;
 
@@ -10,33 +12,19 @@ public interface BaseItemStack {
 
   Set<ItemFlag> itemFlags();
 
-  List<String> loreJson();
-
-  String displayNameJson();
-
   boolean canBeStacked(BaseItemStack stack);
 
-  <T> T displayName();
-
-  <T> T displayName(boolean legacyString);
-
-  BaseItemStack displayName(String legacyName);
-
-  BaseItemStack displayName(Object displayName);
-
-  <T> List<T> lore();
-
-  <T> List<T> lore(boolean legacyString);
+    ChatElement<?> displayName();
 
-  void lore(List<?> list, boolean legacyString);
+    BaseItemStack displayName(ChatElement<?> displayName);
 
-  void lore(int index, String legacyText);
+    <T> List<ChatElement<?>> lore();
 
-  void lore(int index, Object component);
+    void lore(List<ChatElement<?>> list);
 
-  void addToLore(String legacyText);
+    void lore(int index, ChatElement<?> element);
 
-  void addToLore(Object component);
+    void addToLore(ChatElement<?> element);
 
   BaseItemStack deepClone();