Package net.minestom.server.item.metadata

Record Class BannerMeta

java.lang.Object
java.lang.Record
net.minestom.server.item.metadata.BannerMeta
Record Components:
readable - data
All Implemented Interfaces:
ItemMetaView<BannerMeta.Builder>, TagReadable
@Experimental public record BannerMeta(TagReadable readable) extends Record implements ItemMetaView<BannerMeta.Builder>
Meta for all Materials.WHITE_BANNER and Materials.SHIELD items

  • Constructor Details

    • BannerMeta

      public BannerMeta(TagReadable readable)
      Creates an instance of a BannerMeta record class.
      Parameters:
      readable - the value for the readable record component

  • Method Details

    • from

      @Contract(value="_, _ -> new", pure=true) @NotNull public static @NotNull BannerMeta.Pattern from(@NotNull @NotNull DyeColor color, @NotNull @NotNull BannerPattern pattern)

    • getCustomName

      @Nullable public @Nullable Component getCustomName()
      Get name of the marker, unused by Minestom
      Returns:
      name of the marker

    • getPatterns

      @NotNull public @NotNull List<BannerMeta.Pattern> getPatterns()
      Get patterns of the banner
      Returns:
      patterns of the banner

    • getTag

      public <T> @UnknownNullability T getTag(@NotNull @NotNull Tag<T> tag)
      Description copied from interface: TagReadable
      Reads the specified tag.
      Specified by:
      getTag in interface TagReadable
      Type Parameters:
      T - the tag type
      Parameters:
      tag - the tag to read
      Returns:
      the read tag, null if not present

    • 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.

    • readable

      public TagReadable readable()
      Returns the value of the readable record component.
      Returns:
      the value of the readable record component