Package net.kyori.adventure.nbt

Interface ListBinaryTag

All Superinterfaces:
BinaryTag, net.kyori.examination.Examinable, Iterable<BinaryTag>, ListTagSetter<ListBinaryTag,​BinaryTag>
public interface ListBinaryTag
extends ListTagSetter<ListBinaryTag,​BinaryTag>, BinaryTag, Iterable<BinaryTag>
A list of zero or more values of a single tag type.
Since:
4.0.0

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static interface  ListBinaryTag.Builder<T extends BinaryTag>
    A list tag builder.

  • Method Summary

    Modifier and Type Method Description
    static @NonNull ListBinaryTag.Builder<BinaryTag> builder()
    Creates a builder.
    static <T extends BinaryTag>
    @NonNull ListBinaryTag.Builder<T>    		 builder​(@NonNull BinaryTagType<T> type)
    Creates a builder.
    static @NonNull ListBinaryTag empty()
    Gets an empty list tag.
    @NonNull BinaryTag get​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a tag.
    default byte getByte​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a byte.
    default byte getByte​(@org.checkerframework.checker.index.qual.NonNegative int index, byte defaultValue)
    Gets a byte.
    default byte @NonNull [] getByteArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets an array of bytes.
    default byte @NonNull [] getByteArray​(@org.checkerframework.checker.index.qual.NonNegative int index, byte @NonNull [] defaultValue)
    Gets an array of bytes.
    default @NonNull CompoundBinaryTag getCompound​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a compound.
    default @NonNull CompoundBinaryTag getCompound​(@org.checkerframework.checker.index.qual.NonNegative int index, @NonNull CompoundBinaryTag defaultValue)
    Gets a compound.
    default double getDouble​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a double.
    default double getDouble​(@org.checkerframework.checker.index.qual.NonNegative int index, double defaultValue)
    Gets a double.
    default float getFloat​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a float.
    default float getFloat​(@org.checkerframework.checker.index.qual.NonNegative int index, float defaultValue)
    Gets a float.
    default int getInt​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets an int.
    default int getInt​(@org.checkerframework.checker.index.qual.NonNegative int index, int defaultValue)
    Gets an int.
    default int @NonNull [] getIntArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets an array of ints.
    default int @NonNull [] getIntArray​(@org.checkerframework.checker.index.qual.NonNegative int index, int @NonNull [] defaultValue)
    Gets an array of ints.
    default long getLong​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a long.
    default long getLong​(@org.checkerframework.checker.index.qual.NonNegative int index, long defaultValue)
    Gets a long.
    default long @NonNull [] getLongArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets an array of longs.
    default long @NonNull [] getLongArray​(@org.checkerframework.checker.index.qual.NonNegative int index, long @NonNull [] defaultValue)
    Gets an array of longs.
    default short getShort​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a short.
    default short getShort​(@org.checkerframework.checker.index.qual.NonNegative int index, short defaultValue)
    Gets a short.
    default @NonNull String getString​(@org.checkerframework.checker.index.qual.NonNegative int index)
    Gets a string.
    default @NonNull String getString​(@org.checkerframework.checker.index.qual.NonNegative int index, @NonNull String defaultValue)
    Gets a string.
    @NonNull BinaryTagType<? extends BinaryTag> listType()
    Gets the type of element stored in this list.
    static @NonNull ListBinaryTag of​(@NonNull BinaryTagType<? extends BinaryTag> type, @NonNull List<BinaryTag> tags)
    Creates a tag.
    @NonNull ListBinaryTag remove​(int index, @Nullable Consumer<BinaryTag> removedConsumer)
    Removes the tag at index index, optionally providing removedConsumer with the tag previously at index index.
    @NonNull ListBinaryTag set​(int index, @NonNull BinaryTag tag, @Nullable Consumer<BinaryTag> removedConsumer)
    Sets the tag at index index to tag, optionally providing removedConsumer with the tag previously at index index.
    int size()
    Gets the size.
    default @NonNull BinaryTagType<ListBinaryTag> type()
    Gets the tag type.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examinableProperties, examine

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

    Methods inherited from interface net.kyori.adventure.nbt.ListTagSetter

    add

  • Method Details

    • empty

      static @NonNull ListBinaryTag empty()
      Gets an empty list tag.
      Returns:
      an empty tag
      Since:
      4.0.0

    • builder

      static @NonNull ListBinaryTag.Builder<BinaryTag> builder()
      Creates a builder.
      Returns:
      a new builder
      Since:
      4.0.0

    • builder

      static <T extends BinaryTag> @NonNull ListBinaryTag.Builder<T> builder​(@NonNull BinaryTagType<T> type)
      Creates a builder.
      Type Parameters:
      T - the element type
      Parameters:
      type - the element type
      Returns:
      a new builder
      Since:
      4.0.0

    • of

      static @NonNull ListBinaryTag of​(@NonNull BinaryTagType<? extends BinaryTag> type, @NonNull List<BinaryTag> tags)
      Creates a tag.
      Parameters:
      type - the element type
      tags - the elements
      Returns:
      a tag
      Since:
      4.0.0

    • type

      default @NonNull BinaryTagType<ListBinaryTag> type()
      Description copied from interface: BinaryTag
      Gets the tag type.
      Specified by:
      type in interface BinaryTag
      Returns:
      the tag type

    • listType

      @NonNull BinaryTagType<? extends BinaryTag> listType()
      Gets the type of element stored in this list.
      Returns:
      the type
      Since:
      4.0.0

    • size

      int size()
      Gets the size.
      Returns:
      the size
      Since:
      4.0.0

    • get

      @NonNull BinaryTag get​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a tag.
      Parameters:
      index - the index
      Returns:
      the tag
      Throws:
      IndexOutOfBoundsException - if the index is out of range
      Since:
      4.0.0

    • set

      @NonNull ListBinaryTag set​(int index, @NonNull BinaryTag tag, @Nullable Consumer<BinaryTag> removedConsumer)
      Sets the tag at index index to tag, optionally providing removedConsumer with the tag previously at index index.
      Parameters:
      index - the index
      tag - the tag
      removedConsumer - a consumer which receives the tag being removed at index index
      Returns:
      a list tag
      Since:
      4.0.0

    • remove

      @NonNull ListBinaryTag remove​(int index, @Nullable Consumer<BinaryTag> removedConsumer)
      Removes the tag at index index, optionally providing removedConsumer with the tag previously at index index.
      Parameters:
      index - the index
      removedConsumer - a consumer which receives the tag being removed at index index
      Returns:
      a list tag
      Since:
      4.0.0

    • getByte

      default byte getByte​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a byte.
      Parameters:
      index - the index
      Returns:
      the byte value, or 0
      Since:
      4.0.0

    • getByte

      default byte getByte​(@org.checkerframework.checker.index.qual.NonNegative int index, byte defaultValue)
      Gets a byte.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the byte value, or defaultValue
      Since:
      4.0.0

    • getShort

      default short getShort​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a short.
      Parameters:
      index - the index
      Returns:
      the short value, or 0
      Since:
      4.0.0

    • getShort

      default short getShort​(@org.checkerframework.checker.index.qual.NonNegative int index, short defaultValue)
      Gets a short.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the short value, or defaultValue
      Since:
      4.0.0

    • getInt

      default int getInt​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets an int.
      Parameters:
      index - the index
      Returns:
      the int value, or 0
      Since:
      4.0.0

    • getInt

      default int getInt​(@org.checkerframework.checker.index.qual.NonNegative int index, int defaultValue)
      Gets an int.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the int value, or defaultValue
      Since:
      4.0.0

    • getLong

      default long getLong​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a long.
      Parameters:
      index - the index
      Returns:
      the long value, or 0
      Since:
      4.0.0

    • getLong

      default long getLong​(@org.checkerframework.checker.index.qual.NonNegative int index, long defaultValue)
      Gets a long.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the long value, or defaultValue
      Since:
      4.0.0

    • getFloat

      default float getFloat​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a float.
      Parameters:
      index - the index
      Returns:
      the float value, or 0
      Since:
      4.0.0

    • getFloat

      default float getFloat​(@org.checkerframework.checker.index.qual.NonNegative int index, float defaultValue)
      Gets a float.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the float value, or defaultValue
      Since:
      4.0.0

    • getDouble

      default double getDouble​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a double.
      Parameters:
      index - the index
      Returns:
      the double value, or 0
      Since:
      4.0.0

    • getDouble

      default double getDouble​(@org.checkerframework.checker.index.qual.NonNegative int index, double defaultValue)
      Gets a double.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the double value, or defaultValue
      Since:
      4.0.0

    • getByteArray

      default byte @NonNull [] getByteArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets an array of bytes.
      Parameters:
      index - the index
      Returns:
      the array of bytes, or a zero-length array
      Since:
      4.0.0

    • getByteArray

      default byte @NonNull [] getByteArray​(@org.checkerframework.checker.index.qual.NonNegative int index, byte @NonNull [] defaultValue)
      Gets an array of bytes.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the array of bytes, or defaultValue
      Since:
      4.0.0

    • getString

      default @NonNull String getString​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a string.
      Parameters:
      index - the index
      Returns:
      the string value, or ""
      Since:
      4.0.0

    • getString

      default @NonNull String getString​(@org.checkerframework.checker.index.qual.NonNegative int index, @NonNull String defaultValue)
      Gets a string.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the string value, or defaultValue
      Since:
      4.0.0

    • getCompound

      default @NonNull CompoundBinaryTag getCompound​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets a compound.
      Parameters:
      index - the index
      Returns:
      the compound, or a new compound
      Since:
      4.0.0

    • getCompound

      default @NonNull CompoundBinaryTag getCompound​(@org.checkerframework.checker.index.qual.NonNegative int index, @NonNull CompoundBinaryTag defaultValue)
      Gets a compound.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the compound, or defaultValue
      Since:
      4.0.0

    • getIntArray

      default int @NonNull [] getIntArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets an array of ints.
      Parameters:
      index - the index
      Returns:
      the array of ints, or a zero-length array
      Since:
      4.0.0

    • getIntArray

      default int @NonNull [] getIntArray​(@org.checkerframework.checker.index.qual.NonNegative int index, int @NonNull [] defaultValue)
      Gets an array of ints.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the array of ints, or defaultValue
      Since:
      4.0.0

    • getLongArray

      default long @NonNull [] getLongArray​(@org.checkerframework.checker.index.qual.NonNegative int index)
      Gets an array of longs.
      Parameters:
      index - the index
      Returns:
      the array of longs, or a zero-length array
      Since:
      4.0.0

    • getLongArray

      default long @NonNull [] getLongArray​(@org.checkerframework.checker.index.qual.NonNegative int index, long @NonNull [] defaultValue)
      Gets an array of longs.
      Parameters:
      index - the index
      defaultValue - the default value
      Returns:
      the array of longs, or defaultValue
      Since:
      4.0.0