org.spongepowered.api.util

Class TextMessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.spongepowered.api.util.TextMessageException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandException

public class TextMessageException
extends Exception

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextMessageException() Constructs a new TextMessageException.
TextMessageException(Text message) Constructs a new TextMessageException with the given message.
TextMessageException(Text message, Throwable throwable) Constructs a new TextMessageException with the given message and cause.
TextMessageException(Throwable throwable) Constructs a new TextMessageException with the given cause.

Method Summary

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

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 Detail

TextMessageException

public TextMessageException()

Constructs a new TextMessageException.

TextMessageException

public TextMessageException(Text message)

Constructs a new TextMessageException with the given message.

Parameters:

message - The detail message

TextMessageException

public TextMessageException(Text message,
                            Throwable throwable)

Constructs a new TextMessageException with the given message and cause.

Parameters:

message - The detail message

throwable - The cause

TextMessageException

public TextMessageException(Throwable throwable)

Constructs a new TextMessageException with the given cause.

Parameters:

throwable - The cause

Method Detail

getMessage

@Nullable
public String getMessage()

Overrides:

getMessage in class Throwable

getText

@Nullable
public Text getText()

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

Returns:

The text for this message

getLocalizedMessage

@Nullable
public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable