Package net.kyori.adventure.nbt.api

Interface BinaryTagHolder

public interface BinaryTagHolder
Holds a compound binary tag.

Instead of including an entire NBT implementation in Adventure, it was decided to use this "holder" interface instead. This opens the door for platform specific implementations.

See net.kyori.adventure.nbt.impl for a platform agnostic implementation.

Since:
4.0.0

  • Method Summary

    Modifier and Type Method Description
    static <T,​ EX extends Exception>
    @NotNull BinaryTagHolder    		 encode​(T nbt, @NotNull Codec<? super T,​String,​?,​EX> codec)
    Encodes nbt using codec.
    <T,​ DX extends Exception>
    T    		 get​(@NotNull Codec<T,​String,​DX,​?> codec)
    Gets the held value as a binary tag.
    static @NotNull BinaryTagHolder of​(@NotNull String string)
    Creates an encoded binary tag holder.
    @NotNull String string()
    Gets the raw string value.

  • Method Details

    • encode

      @NotNull static <T,​ EX extends Exception> @NotNull BinaryTagHolder encode​(@NotNull T nbt, @NotNull @NotNull Codec<? super T,​String,​?,​EX> codec) throws EX extends Exception
      Encodes nbt using codec.
      Type Parameters:
      T - the binary tag type
      EX - encode exception type
      Parameters:
      nbt - the binary tag
      codec - the codec
      Returns:
      the encoded binary tag holder
      Throws:
      EX - if an error occurred while encoding the binary tag
      Since:
      4.0.0

    • of

      @NotNull static @NotNull BinaryTagHolder of​(@NotNull @NotNull String string)
      Creates an encoded binary tag holder.
      Parameters:
      string - the encoded binary tag value
      Returns:
      the encoded binary tag
      Since:
      4.0.0

    • string

      @NotNull @NotNull String string()
      Gets the raw string value.
      Returns:
      the raw string value
      Since:
      4.0.0

    • get

      @NotNull <T,​ DX extends Exception> T get​(@NotNull @NotNull Codec<T,​String,​DX,​?> codec) throws DX extends Exception
      Gets the held value as a binary tag.
      Type Parameters:
      T - the binary tag type
      DX - decode thrown exception type
      Parameters:
      codec - the codec
      Returns:
      the binary tag
      Throws:
      DX - if an error occurred while retrieving the binary tag
      Since:
      4.0.0