Package dev.unnm3d.redischat.chat.filters

Record Class FilterResult

java.lang.Object

java.lang.Record

dev.unnm3d.redischat.chat.filters.FilterResult

Record Components:

message - The resulting message (it can be the same as the filter input message or a modified version)

filtered - Whether the message was filtered (if true, the message will not be sent)

public record FilterResult(@NotNull ChatMessage message, boolean filtered, @NotNull Optional<net.kyori.adventure.text.Component> filteredReason)
extends Record

The result of a filter

Constructor Summary

Constructors

Constructor	Description
FilterResult(@NotNull ChatMessage message, boolean filtered, @NotNull Optional<net.kyori.adventure.text.Component> filteredReason)	Creates an instance of a FilterResult record class.
FilterResult(ChatMessage message, boolean filtered)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	filtered()	Returns the value of the filtered record component.
@NotNull Optional<net.kyori.adventure.text.Component>	filteredReason()	Returns the value of the filteredReason record component.
final int	hashCode()	Returns a hash code value for this object.
@NotNull ChatMessage	message()	Returns the value of the message 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

FilterResult

public FilterResult(ChatMessage message,
 boolean filtered)

FilterResult

public FilterResult(@NotNull
 @NotNull ChatMessage message,
 boolean filtered,
 @NotNull
 @NotNull Optional<net.kyori.adventure.text.Component> filteredReason)

Creates an instance of a FilterResult record class.

Parameters:

message - the value for the message record component

filtered - the value for the filtered record component

filteredReason - the value for the filteredReason 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

message

@NotNull
public @NotNull ChatMessage message()

Returns the value of the message record component.

Returns:

the value of the message record component

filtered

public boolean filtered()

Returns the value of the filtered record component.

Returns:

the value of the filtered record component

filteredReason

@NotNull
public @NotNull Optional<net.kyori.adventure.text.Component> filteredReason()

Returns the value of the filteredReason record component.

Returns:

the value of the filteredReason record component