Record Class DefaultErrorMessageFactory

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.embeds.error.DefaultErrorMessageFactory

All Implemented Interfaces:

ErrorMessageFactory

public record DefaultErrorMessageFactory(Embeds embeds)
extends Record
implements ErrorMessageFactory

The default implementation of ErrorMessageFactory. Supports loading the embeds from an EmbedDataSource.

See Also:

• JDACBuilder.embeds(Consumer)

Nested Class Summary

Nested classes/interfaces inherited from interface ErrorMessageFactory

ErrorMessageFactory.ErrorContext

Constructor Summary

Constructors

Constructor	Description
DefaultErrorMessageFactory(Embeds embeds)	Creates an instance of a DefaultErrorMessageFactory record class.

Method Summary

Modifier and Type	Method	Description
Embeds	embeds()	Returns the value of the embeds record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
net.dv8tion.jda.api.utils.messages.MessageCreateData	getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext context, Throwable exception)	Gets a MessageCreateData to send when the command execution failed.
net.dv8tion.jda.api.utils.messages.MessageCreateData	getConstraintFailedMessage(ErrorMessageFactory.ErrorContext context, String message)	Gets a MessageCreateData to send when a parameter constraint fails.
net.dv8tion.jda.api.utils.messages.MessageCreateData	getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext context)	Gets a MessageCreateData to send when a user is missing permissions.
net.dv8tion.jda.api.utils.messages.MessageCreateData	getTimedOutComponentMessage(net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent event)	Gets a MessageCreateData to send when an incoming component interaction already timed out.
net.dv8tion.jda.api.utils.messages.MessageCreateData	getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext context, io.github.kaktushose.proteus.conversion.ConversionResult.Failure<?> failure)	Gets a MessageCreateData to send when type adapting of the user input failed.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultErrorMessageFactory

public DefaultErrorMessageFactory(Embeds embeds)

Creates an instance of a DefaultErrorMessageFactory record class.

Parameters:

embeds - the value for the embeds record component

Method Details

getTypeAdaptingFailedMessage

public net.dv8tion.jda.api.utils.messages.MessageCreateData getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext context,
 io.github.kaktushose.proteus.conversion.ConversionResult.Failure<?> failure)

Gets a MessageCreateData to send when type adapting of the user input failed. Use EmbedConfig.errorSource(EmbedDataSource) to replace the default embed of this error message. Alternatively, pass your own ErrorMessageFactory implementation to JDACBuilder.errorMessageFactory(ErrorMessageFactory).

Specified by:

getTypeAdaptingFailedMessage in interface ErrorMessageFactory

Parameters:

context - the ErrorMessageFactory.ErrorContext

failure - the ConversionResult.Failure

Returns:

a MessageCreateData to send when type adapting failed

getInsufficientPermissionsMessage

public net.dv8tion.jda.api.utils.messages.MessageCreateData getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext context)

Gets a MessageCreateData to send when a user is missing permissions. Use EmbedConfig.errorSource(EmbedDataSource) to replace the default embed of this error message. Alternatively, pass your own ErrorMessageFactory implementation to JDACBuilder.errorMessageFactory(ErrorMessageFactory).

Specified by:

getInsufficientPermissionsMessage in interface ErrorMessageFactory

Parameters:

context - the ErrorMessageFactory.ErrorContext

Returns:

a MessageCreateData to send when a user is missing permissions

getConstraintFailedMessage

public net.dv8tion.jda.api.utils.messages.MessageCreateData getConstraintFailedMessage(ErrorMessageFactory.ErrorContext context,
 String message)

Gets a MessageCreateData to send when a parameter constraint fails. Use EmbedConfig.errorSource(EmbedDataSource) to replace the default embed of this error message. Alternatively, pass your own ErrorMessageFactory implementation to JDACBuilder.errorMessageFactory(ErrorMessageFactory).

Specified by:

getConstraintFailedMessage in interface ErrorMessageFactory

Parameters:

context - the ErrorMessageFactory.ErrorContext

Returns:

a MessageCreateData to send when a parameter constraint fails

getCommandExecutionFailedMessage

public net.dv8tion.jda.api.utils.messages.MessageCreateData getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext context,
 Throwable exception)

Gets a MessageCreateData to send when the command execution failed. Use EmbedConfig.errorSource(EmbedDataSource) to replace the default embed of this error message. Alternatively, pass your own ErrorMessageFactory implementation to JDACBuilder.errorMessageFactory(ErrorMessageFactory).

Specified by:

getCommandExecutionFailedMessage in interface ErrorMessageFactory

Parameters:

context - the ErrorMessageFactory.ErrorContext

exception - the Throwable that made the command execution fail

Returns:

a MessageCreateData to send when the command execution failed

getTimedOutComponentMessage

public net.dv8tion.jda.api.utils.messages.MessageCreateData getTimedOutComponentMessage(net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent event)

Gets a MessageCreateData to send when an incoming component interaction already timed out. Use EmbedConfig.errorSource(EmbedDataSource) to replace the default embed of this error message. Alternatively, pass your own ErrorMessageFactory implementation to JDACBuilder.errorMessageFactory(ErrorMessageFactory).

Specified by:

getTimedOutComponentMessage in interface ErrorMessageFactory

Parameters:

event - the GenericInteractionCreateEvent mo runtime was found for

Returns:

a MessageCreateData to send when an incoming component interaction already timed out

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.

embeds

public Embeds embeds()

Returns the value of the embeds record component.

Returns:

the value of the embeds record component