Package net.kyori.adventure.util

Interface ComponentMessageThrowable

public interface ComponentMessageThrowable

An extension interface for Throwables to provide a Component-based message.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
@Nullable Component	componentMessage()	Gets the message.
static @Nullable Component	getMessage(@Nullable Throwable throwable)	Gets the Component-based message from a Throwable, if available.
static @Nullable Component	getOrConvertMessage(@Nullable Throwable throwable)	Gets the Component-based message from a Throwable, or converts Throwable.getMessage().

Method Details

getMessage

static @Nullable Component getMessage(@Nullable Throwable throwable)

Gets the Component-based message from a Throwable, if available.

Parameters:

throwable - the throwable

Returns:

the message

Since:

4.0.0

getOrConvertMessage

static @Nullable Component getOrConvertMessage(@Nullable Throwable throwable)

Gets the Component-based message from a Throwable, or converts Throwable.getMessage().

Parameters:

throwable - the throwable

Returns:

the message

Since:

4.0.0

componentMessage

@Nullable Component componentMessage()

Gets the message.

Returns:

the message

Since:

4.0.0