Package com.winterhavenmc.lodestar.models.destination

Record Class InvalidDestination

java.lang.Object

java.lang.Record

com.winterhavenmc.lodestar.models.destination.InvalidDestination

Record Components:

displayName -

All Implemented Interfaces:

com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable, Destination

public record InvalidDestination(String displayName, String reason)
extends Record
implements Destination

Record class that represents an invalid destination

Field Summary

Fields inherited from interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable

VALID_DISPLAY_NAME

Constructor Summary

Constructors

Constructor	Description
InvalidDestination(String displayName, String reason)	Creates an instance of a InvalidDestination record class.

Method Summary

Modifier and Type	Method	Description
String	displayName()	Returns the value of the displayName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getDisplayName()
final int	hashCode()	Returns a hash code value for this object.
String	reason()	Returns the value of the reason record component.
@NotNull 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 com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable

extractDisplayName

Constructor Details

InvalidDestination

public InvalidDestination(String displayName,
 String reason)

Creates an instance of a InvalidDestination record class.

Parameters:

displayName - the value for the displayName record component

reason - the value for the reason record component

Method Details

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Destination

Specified by:

getDisplayName in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable

toString

@NotNull
public @NotNull 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.

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component