Package studio.mevera.imperat.exception

Class InvalidSyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

studio.mevera.imperat.exception.CommandException

studio.mevera.imperat.exception.InvalidSyntaxException

All Implemented Interfaces:

Serializable

public final class InvalidSyntaxException
extends CommandException

Thrown when a command's syntax does not match any valid usage pathway.

Carries %invalid_usage% and %closest_usage% placeholders which are used by the throwable resolver in ImperatConfigImpl.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidSyntaxException(String invalidUsage, @Nullable CommandPathway<S> closestUsage)

Method Summary

Modifier and Type	Method	Description
@Nullable CommandPathway<? extends CommandSource>	getClosestUsage()
String	getInvalidUsage()

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

InvalidSyntaxException

public InvalidSyntaxException(String invalidUsage,
 @Nullable
 @Nullable CommandPathway<S> closestUsage)

Parameters:

invalidUsage - what the user actually typed (e.g. "/give sword stone")

closestUsage - the closest valid usage hint, or null if unavailable

Method Details

getInvalidUsage

public String getInvalidUsage()

getClosestUsage

@Nullable
public @Nullable CommandPathway<? extends CommandSource> getClosestUsage()