Record Class BukkitItemStack

java.lang.Object
java.lang.Record
kr.toxicity.model.api.bukkit.platform.BukkitItemStack
Record Components:
source - the source Bukkit item stack
All Implemented Interfaces:
kr.toxicity.model.api.platform.PlatformItemStack
public record BukkitItemStack(@NotNull org.bukkit.inventory.ItemStack source) extends Record implements kr.toxicity.model.api.platform.PlatformItemStack
Represents a Bukkit item stack wrapped as a PlatformItemStack.
Since:
2.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    BukkitItemStack(@NotNull org.bukkit.inventory.ItemStack source)
    Creates an instance of a BukkitItemStack record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull kr.toxicity.model.api.platform.PlatformItemStack
    clone()
     
    @NotNull kr.toxicity.model.api.platform.PlatformItemStack
    enchant(boolean enchant)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isAir()
     
    @NotNull kr.toxicity.model.api.platform.PlatformItemStack
    modelData(int customModelData, @Nullable kr.toxicity.model.api.platform.PlatformNamespace namespace)
     
    @NotNull org.bukkit.inventory.ItemStack
    source()
    Returns the value of the source record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • BukkitItemStack

      public BukkitItemStack(@NotNull @NotNull org.bukkit.inventory.ItemStack source)
      Creates an instance of a BukkitItemStack record class.
      Parameters:
      source - the value for the source record component

  • Method Details

    • isAir

      public boolean isAir()
      Specified by:
      isAir in interface kr.toxicity.model.api.platform.PlatformItemStack

    • enchant

      @NotNull public @NotNull kr.toxicity.model.api.platform.PlatformItemStack enchant(boolean enchant)
      Specified by:
      enchant in interface kr.toxicity.model.api.platform.PlatformItemStack

    • modelData

      @NotNull public @NotNull kr.toxicity.model.api.platform.PlatformItemStack modelData(int customModelData, @Nullable @Nullable kr.toxicity.model.api.platform.PlatformNamespace namespace)
      Specified by:
      modelData in interface kr.toxicity.model.api.platform.PlatformItemStack

    • clone

      @NotNull public @NotNull kr.toxicity.model.api.platform.PlatformItemStack clone()
      Specified by:
      clone in interface kr.toxicity.model.api.platform.PlatformItemStack
      Overrides:
      clone in class Object

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

    • source

      @NotNull public @NotNull org.bukkit.inventory.ItemStack source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component