Package com.winterhavenmc.library.messagebuilder.models.recipient

Record Class Recipient.Valid

java.lang.Object

java.lang.Record

com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid

Record Components:

sender - the original CommandSender

All Implemented Interfaces:

Recipient, Recipient.Sendable

Enclosing interface:

Recipient

public static record Recipient.Valid(org.bukkit.command.CommandSender sender)
extends Record
implements Recipient, Recipient.Sendable

Represents a valid, recognized message recipient such as a player, console, or command block.

Nested Class Summary

Nested classes/interfaces inherited from interface com.winterhavenmc.library.messagebuilder.models.recipient.Recipient

Recipient.Invalid, Recipient.InvalidReason, Recipient.Proxied, Recipient.Sendable, Recipient.Valid

Constructor Summary

Constructors

Constructor	Description
Valid(org.bukkit.command.CommandSender sender)	Creates an instance of a Valid record class.

Method Summary

Modifier and Type	Method	Description
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.
org.bukkit.command.CommandSender	sender()	Returns the value of the sender 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

Constructor Details

Valid

public Valid(org.bukkit.command.CommandSender sender)

Creates an instance of a Valid record class.

Parameters:

sender - the value for the sender 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.

Specified by:

sender in interface Recipient.Sendable

Returns:

the value of the sender record component