io.github.nucleuspowered.nucleus.api.util.data

Interface TimedEntry

All Known Subinterfaces:

Jailing, Mute, Warning

public interface TimedEntry

Indicates that there might be a time limit on this entry.

Method Summary

Modifier and Type	Method and Description
boolean	expired() Returns whether this entry can be considered expired.
java.util.Optional<java.time.Duration>	getRemainingTime() The amount of time remaining before this entry expires, if applicable.
boolean	isCurrentlyTicking() Denotes whether the timer is currently ticking down (that is, if getRemainingTime() should be decreasing with each call.

Method Detail

getRemainingTime

java.util.Optional<java.time.Duration> getRemainingTime()

The amount of time remaining before this entry expires, if applicable.

Returns:

The remaining amount of time.

expired

boolean expired()

Returns whether this entry can be considered expired.

Returns:

if expired.

isCurrentlyTicking

boolean isCurrentlyTicking()

Denotes whether the timer is currently ticking down (that is, if getRemainingTime() should be decreasing with each call.

Returns:

true if so.