Record Class ItemRenameResult.Success

java.lang.Object
java.lang.Record
net.okocraft.box.api.model.result.item.ItemRenameResult.Success
Record Components:
customItem - a renamed custom item
previousName - a previous name of item
All Implemented Interfaces:
ItemRenameResult
Enclosing interface:
ItemRenameResult
public static record ItemRenameResult.Success(@NotNull BoxCustomItem customItem, @NotNull String previousName) extends Record implements ItemRenameResult
A record of the ItemRenameResult that indicates success.

  • Constructor Details

    • Success

      public Success(@NotNull @NotNull BoxCustomItem customItem, @NotNull @NotNull String previousName)
      Creates an instance of a Success record class.
      Parameters:
      customItem - the value for the customItem record component
      previousName - the value for the previousName record component

  • Method Details

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

    • customItem

      @NotNull public @NotNull BoxCustomItem customItem()
      Returns the value of the customItem record component.
      Returns:
      the value of the customItem record component

    • previousName

      @NotNull public @NotNull String previousName()
      Returns the value of the previousName record component.
      Returns:
      the value of the previousName record component