revxrsal.commands.exception

Class CooldownException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

revxrsal.commands.exception.CooldownException

All Implemented Interfaces:

java.io.Serializable

public class CooldownException
extends java.lang.RuntimeException

Thrown when the CommandActor has to wait before executing a command again. This is set by Cooldown.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CooldownException(long timeLeft) Creates a new CooldownException with the given timestamp in milliseconds
CooldownException(java.util.concurrent.TimeUnit unit, long timeLeft) Creates a new CooldownException with the given timestamp in any unit

Method Summary

Modifier and Type	Method and Description
long	getTimeLeft(@NotNull java.util.concurrent.TimeUnit unit) Returns the time left in the given unit
long	getTimeLeftMillis() Returns the time left before being able to execute again

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 Detail

CooldownException

public CooldownException(long timeLeft)

Creates a new CooldownException with the given timestamp in milliseconds

Parameters:

timeLeft - The time left in milliseconds

CooldownException

public CooldownException(java.util.concurrent.TimeUnit unit,
                         long timeLeft)

Creates a new CooldownException with the given timestamp in any unit

Parameters:

unit - The time unit in which the time left is given

timeLeft - The time left in the given unit

Method Detail

getTimeLeftMillis

public long getTimeLeftMillis()

Returns the time left before being able to execute again

Returns:

Time left in milliseconds

getTimeLeft

public long getTimeLeft(@NotNull
                        @NotNull java.util.concurrent.TimeUnit unit)

Returns the time left in the given unit

Parameters:

unit - Unit to convert to

Returns:

The time left