CommandException (core 0.5.7 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - org.enginehub.piston.exception.CommandException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CommandExecutionException, ConditionFailedException, NoSuchCommandException, StopExecutionException, UsageException
```
public class CommandException
extends java.lang.RuntimeException
```
Parent class for all command-related exceptions.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected com.google.common.collect.ImmutableList<Command> commands

Fields
Modifier and Type	Field and Description
`protected com.google.common.collect.ImmutableList<Command>`	`commands`

Constructor Summary

Constructors
Constructor and Description
`CommandException(net.kyori.text.Component message, com.google.common.collect.ImmutableList<Command> commands)`
`CommandException(net.kyori.text.Component message, java.lang.Throwable cause, com.google.common.collect.ImmutableList<Command> commands)`
`CommandException(com.google.common.collect.ImmutableList<Command> commands)`
`CommandException(java.lang.Throwable cause, com.google.common.collect.ImmutableList<Command> commands)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.common.collect.ImmutableList<Command>`	`getCommands()` Retrieves all commands associated with this exception.
`net.kyori.text.Component`	`getRichMessage()` Get the rich message, with extra formatting.

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

Field Detail

commands

protected final com.google.common.collect.ImmutableList<Command> commands

Constructor Detail

CommandException

public CommandException(com.google.common.collect.ImmutableList<Command> commands)

CommandException

public CommandException(net.kyori.text.Component message,
                        com.google.common.collect.ImmutableList<Command> commands)

CommandException

public CommandException(net.kyori.text.Component message,
                        java.lang.Throwable cause,
                        com.google.common.collect.ImmutableList<Command> commands)

CommandException

public CommandException(java.lang.Throwable cause,
                        com.google.common.collect.ImmutableList<Command> commands)

Method Detail
- getRichMessage
```
public net.kyori.text.Component getRichMessage()
```
  Get the rich message, with extra formatting.
- getCommands
```
public com.google.common.collect.ImmutableList<Command> getCommands()
```
  Retrieves all commands associated with this exception.
  This is intended to capture the parent command context upon exceptional state.

Class CommandException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

commands

Constructor Detail

CommandException

CommandException

CommandException

CommandException

Method Detail

getRichMessage

getCommands