Package net.minestom.server.item.metadata

Record Class BannerMeta.Pattern

java.lang.Object
java.lang.Record
net.minestom.server.item.metadata.BannerMeta.Pattern
Enclosing class:
BannerMeta
public static record BannerMeta.Pattern(@NotNull DyeColor color, @NotNull BannerPattern pattern) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pattern(@NotNull DyeColor color, @NotNull BannerPattern pattern)
    Creates an instance of a Pattern record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound
    asCompound()
    Retrieves the BannerMeta.Pattern as an NBTCompound.
    @NotNull DyeColor
    color()
    Returns the value of the color record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @NotNull BannerMeta.Pattern
    fromCompound(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Retrieves a banner pattern from the given compound.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull BannerPattern
    pattern()
    Returns the value of the pattern record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Pattern

      public Pattern(@NotNull @NotNull DyeColor color, @NotNull @NotNull BannerPattern pattern)
      Creates an instance of a Pattern record class.
      Parameters:
      color - the value for the color record component
      pattern - the value for the pattern record component

  • Method Details

    • fromCompound

      @NotNull public static @NotNull BannerMeta.Pattern fromCompound(@NotNull @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Retrieves a banner pattern from the given compound.
      Parameters:
      compound - The NBT connection, which should be a banner pattern.
      Returns:
      A new created banner pattern.

    • asCompound

      @NotNull public @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound asCompound()
      Retrieves the BannerMeta.Pattern as an NBTCompound.
      Returns:
      The banner pattern as a nbt compound.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • color

      @NotNull public @NotNull DyeColor color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • pattern

      @NotNull public @NotNull BannerPattern pattern()
      Returns the value of the pattern record component.
      Returns:
      the value of the pattern record component