Package com.winterhavenmc.library.messagebuilder.model.recipient

Record Class Recipient.Invalid

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
Record Components:
sender - the original CommandSender, if any
invalidReason - the reason this recipient was marked invalid
All Implemented Interfaces:
Recipient
Enclosing interface:
Recipient
public static record Recipient.Invalid(org.bukkit.command.CommandSender sender, Recipient.InvalidReason invalidReason) extends Record implements Recipient
Represents an invalid or unrecognized message recipient.

This can occur if the sender is null or of a type not explicitly handled by the library.

  • Constructor Details

    • Invalid

      public Invalid(org.bukkit.command.CommandSender sender, Recipient.InvalidReason invalidReason)
      Creates an instance of a Invalid record class.
      Parameters:
      sender - the value for the sender record component
      invalidReason - the value for the invalidReason 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.

    • sender

      public org.bukkit.command.CommandSender sender()
      Returns the value of the sender record component.
      Returns:
      the value of the sender record component

    • invalidReason

      public Recipient.InvalidReason invalidReason()
      Returns the value of the invalidReason record component.
      Returns:
      the value of the invalidReason record component