Package net.minestom.server.item.metadata

Record Class ShieldMeta

java.lang.Object
java.lang.Record
net.minestom.server.item.metadata.ShieldMeta
All Implemented Interfaces:
ItemMetaView<ShieldMeta.Builder>, TagReadable
@Experimental public record ShieldMeta(@NotNull TagReadable readable) extends Record implements ItemMetaView<ShieldMeta.Builder>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    ShieldMeta.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShieldMeta(@NotNull TagReadable readable)
    Creates an instance of a ShieldMeta record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull DyeColor
    getBaseColor()
    Get base color of the shield
    @Nullable net.kyori.adventure.text.Component
    getCustomName()
    Get name of the marker, unused by Minestom
    @NotNull List<BannerMeta.Pattern>
    getPatterns()
    Get patterns of the shield
    <T> @UnknownNullability T
    getTag(@NotNull Tag<T> tag)
    Reads the specified tag.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull TagReadable
    readable()
    Returns the value of the readable 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

    Methods inherited from interface net.minestom.server.tag.TagReadable

    hasTag

  • Constructor Details

    • ShieldMeta

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

  • Method Details

    • getBaseColor

      @NotNull public @NotNull DyeColor getBaseColor()
      Get base color of the shield
      Returns:
      the base color

    • getCustomName

      @Nullable public @Nullable net.kyori.adventure.text.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 shield
      Returns:
      patterns of the shield

    • 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

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