Class KamiCommonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.kamikazejam.kamicommon.util.exception.KamiCommonException

All Implemented Interfaces:

Serializable

public class KamiCommonException
extends Exception

A checked exception whose payload is a message for the sender rather than a stack trace. Throw it from a Type or from a command's perform method to stop execution and tell the sender why; the command framework catches it, sends the attached message if there is one, and prints nothing to the console. Construct it empty and attach the message with one of the addMsg methods, each of which returns this for chaining.

See Also:

• Writing your own Type (wiki)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable VersionedComponent	message

Constructor Summary

Constructors

Constructor	Description
KamiCommonException()

Method Summary

Modifier and Type	Method	Description
@NotNull KamiCommonException	addMsg(@NotNull VersionedComponent msg)
@NotNull KamiCommonException	addMsg(@Nullable String msg)	Deprecated. Use addMsgFromLegacyColors(String) instead for clarity
@NotNull KamiCommonException	addMsg(@Nullable String msg, Object... args)	Deprecated. Use addMsgFromLegacyColors(String, Object...) instead for clarity
@NotNull KamiCommonException	addMsgFromLegacyColors(@Nullable String msg)
@NotNull KamiCommonException	addMsgFromLegacyColors(@Nullable String msg, Object... args)
@NotNull KamiCommonException	addMsgFromMiniMessage(@Nullable String miniMessage)
@NotNull KamiCommonException	addMsgFromMiniMessage(@Nullable String miniMessage, Object... args)
@NotNull KamiCommonException	addMsgFromPlainText(@Nullable String plainText)
@Nullable VersionedComponent	getComponent()
@Nullable String	getMessage()
boolean	hasMessage()

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Field Details

message

@Nullable
protected @Nullable VersionedComponent message

Constructor Details

KamiCommonException

public KamiCommonException()

Method Details

hasMessage

public boolean hasMessage()

getMessage

@Nullable
public @Nullable String getMessage()

Overrides:

getMessage in class Throwable

getComponent

@Nullable
public @Nullable VersionedComponent getComponent()

addMsg

@Deprecated
@NotNull
public @NotNull KamiCommonException addMsg(@Nullable
 @Nullable String msg)

Deprecated.

Use addMsgFromLegacyColors(String) instead for clarity

addMsgFromLegacyColors

@NotNull
public @NotNull KamiCommonException addMsgFromLegacyColors(@Nullable
 @Nullable String msg)

addMsg

@Deprecated
@NotNull
public @NotNull KamiCommonException addMsg(@Nullable
 @Nullable String msg,
 Object... args)

Deprecated.

Use addMsgFromLegacyColors(String, Object...) instead for clarity

addMsgFromLegacyColors

@NotNull
public @NotNull KamiCommonException addMsgFromLegacyColors(@Nullable
 @Nullable String msg,
 Object... args)

addMsg

@NotNull
public @NotNull KamiCommonException addMsg(@NotNull
 @NotNull VersionedComponent msg)

addMsgFromMiniMessage

@NotNull
public @NotNull KamiCommonException addMsgFromMiniMessage(@Nullable
 @Nullable String miniMessage)

addMsgFromMiniMessage

@NotNull
public @NotNull KamiCommonException addMsgFromMiniMessage(@Nullable
 @Nullable String miniMessage,
 Object... args)

addMsgFromPlainText

@NotNull
public @NotNull KamiCommonException addMsgFromPlainText(@Nullable
 @Nullable String plainText)