Package org.sgrewritten.stargate.exception

Class LocalisedMessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.sgrewritten.stargate.exception.TranslatableException

org.sgrewritten.stargate.exception.LocalisedMessageException

All Implemented Interfaces:

Serializable

public class LocalisedMessageException
extends TranslatableException

Generic exception for any exception that can directly provide a localized message

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocalisedMessageException(String localizedMessage)
LocalisedMessageException(String localizedMessage, @Nullable Portal portal, @Nullable MessageType messageType)

Method Summary

Modifier and Type	Method	Description
String	getLocalisedMessage(LanguageManager manager)
@Nullable MessageType	getMessageType()
@Nullable Portal	getPortal()
protected TranslatableMessage	getTranslatableMessage()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

LocalisedMessageException

public LocalisedMessageException(String localizedMessage)

Parameters:

localizedMessage -

The localized message of this exception

LocalisedMessageException

public LocalisedMessageException(String localizedMessage,
 @Nullable
 @Nullable Portal portal,
 @Nullable
 @Nullable MessageType messageType)

Parameters:

localizedMessage -

the localized message of this exception

portal -

The the portal of this exception

messageType -

The message type of this exception

Method Details

getTranslatableMessage

protected TranslatableMessage getTranslatableMessage()

Specified by:

getTranslatableMessage in class TranslatableException

Returns:

A translatable message that can be used to determine the localized message of this exception

getLocalisedMessage

public String getLocalisedMessage(LanguageManager manager)

Overrides:

getLocalisedMessage in class TranslatableException

Parameters:

manager -

A language manager able to provide localized messages

Returns:

The localized message of this exception

getPortal

@Nullable
public @Nullable Portal getPortal()

Returns:

The portal where this exception came from

getMessageType

@Nullable
public @Nullable MessageType getMessageType()

Returns:

The type of this localized message