Package org.spongepowered.api.util

Class ComponentMessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.spongepowered.api.util.ComponentMessageException

All Implemented Interfaces:

Serializable, ComponentMessageThrowable

Direct Known Subclasses:

CommandException

public class ComponentMessageException
extends Exception
implements ComponentMessageThrowable

A subclass of Exception that contains a rich message that is an instance of Component rather than a String. This allows formatted and localized exception messages.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComponentMessageException()	Constructs a new ComponentMessageException.
ComponentMessageException(@Nullable Component message)	Constructs a new ComponentMessageException with the given message.
ComponentMessageException(@Nullable Component message, Throwable throwable)	Constructs a new ComponentMessageException with the given message and cause.
ComponentMessageException(Throwable throwable)	Constructs a new ComponentMessageException with the given cause.

Method Summary

Modifier and Type	Method	Description
@Nullable Component	componentMessage()	Returns the text message for this exception, or null if nothing is present.
@Nullable String	getLocalizedMessage()
@Nullable String	getMessage()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ComponentMessageException

public ComponentMessageException()

Constructs a new ComponentMessageException.

ComponentMessageException

public ComponentMessageException(@Nullable Component message)

Constructs a new ComponentMessageException with the given message.

Parameters:

message - The detail message

ComponentMessageException

public ComponentMessageException(@Nullable Component message,
 Throwable throwable)

Constructs a new ComponentMessageException with the given message and cause.

Parameters:

message - The detail message

throwable - The cause

ComponentMessageException

public ComponentMessageException(Throwable throwable)

Constructs a new ComponentMessageException with the given cause.

Parameters:

throwable - The cause

Method Details

getMessage

public @Nullable String getMessage()

Overrides:

getMessage in class Throwable

componentMessage

public @Nullable Component componentMessage()

Returns the text message for this exception, or null if nothing is present.

Specified by:

componentMessage in interface ComponentMessageThrowable

Returns:

The text for this message

getLocalizedMessage

public @Nullable String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable