Class CommandExecutionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

nl.pim16aap2.animatedarchitecture.core.exceptions.CommandExecutionException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CannotAddPropertyException, CannotEditPropertyException, CannotRemovePropertyException, InvalidCommandInputException, NoAccessToStructureCommandException, NonPlayerExecutingPlayerCommandException, NoStructuresForCommandException, PlayerExecutingNonPlayerCommandException, PropertyIsHiddenException, RequiredPropertiesMissingForCommandException

public class CommandExecutionException
extends RuntimeException

The generic exception that is thrown when a command fails to execute.

Generally, this exception should not be thrown directly, but rather one of its subclasses.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommandExecutionException(boolean userInformed)
CommandExecutionException(boolean userInformed, @Nullable String message)
CommandExecutionException(boolean userInformed, @Nullable String message, @Nullable Throwable cause)
CommandExecutionException(boolean userInformed, @Nullable Throwable cause)

Method Summary

Modifier and Type	Method	Description
final boolean	isUserInformed()	Returns whether the user has been informed about this exception.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

CommandExecutionException

public CommandExecutionException(boolean userInformed)

CommandExecutionException

public CommandExecutionException(boolean userInformed,
 @Nullable String message)

CommandExecutionException

public CommandExecutionException(boolean userInformed,
 @Nullable Throwable cause)

CommandExecutionException

public CommandExecutionException(boolean userInformed,
 @Nullable String message,
 @Nullable Throwable cause)

Method Details

isUserInformed

public final boolean isUserInformed()

Returns whether the user has been informed about this exception.

When this is true, a message has been sent to the user when this exception was thrown. When this is false, no message has been sent to the user and a generic error message should be sent.

Returns:

true if the user has been informed, false otherwise.