UsageException (core 0.5.7 API)

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ConversionFailedException, NoSuchFlagException
```
public class UsageException
extends CommandException
```
Parent class for all usage-related exceptions. Provides a partially complete parsing result to assist in providing better help messages.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.enginehub.piston.exception.CommandException
  commands

Constructor Summary

Constructors
Constructor and Description
`UsageException(CommandParseResult commandParseResult)`
`UsageException(net.kyori.text.Component message, CommandParseResult commandParseResult)`
`UsageException(net.kyori.text.Component message, java.lang.Throwable cause, CommandParseResult commandParseResult)`
`UsageException(java.lang.Throwable cause, CommandParseResult commandParseResult)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

CommandParseResult getCommandParseResult()
- Methods inherited from class org.enginehub.piston.exception.CommandException
  getCommands, getRichMessage
- 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommandParseResult`	`getCommandParseResult()`

Constructor Detail

UsageException

public UsageException(CommandParseResult commandParseResult)

UsageException

public UsageException(net.kyori.text.Component message,
                      CommandParseResult commandParseResult)

UsageException

public UsageException(net.kyori.text.Component message,
                      java.lang.Throwable cause,
                      CommandParseResult commandParseResult)

UsageException

public UsageException(java.lang.Throwable cause,
                      CommandParseResult commandParseResult)

Method Detail

getCommandParseResult

public CommandParseResult getCommandParseResult()

Class UsageException

Field Summary

Fields inherited from class org.enginehub.piston.exception.CommandException

Constructor Summary

Method Summary

Methods inherited from class org.enginehub.piston.exception.CommandException

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

UsageException

UsageException

UsageException

UsageException

Method Detail

getCommandParseResult