Package org.incendo.cloud.processors.cooldown.profile

Interface CooldownProfile

@API(status=STABLE,
     since="1.0.0")
public interface CooldownProfile

Profile that stores cooldowns identified by groups.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
void	deleteCooldown(@NonNull CooldownGroup group)	Deletes the cooldown for the given group, if it exists.
@Nullable CooldownInstance	getCooldown(@NonNull CooldownGroup group)	Returns the cooldown for the given group if it exists and it's active.
boolean	isEmpty()	Returns whether the profile is empty.
void	setCooldown(@NonNull CooldownGroup group, @NonNull CooldownInstance cooldown)	Sets the cooldown for the given group.

Method Details

getCooldown

@Nullable CooldownInstance getCooldown(@NonNull CooldownGroup group)

Returns the cooldown for the given group if it exists and it's active.

Parameters:

group - group that identifies the cooldown

Returns:

the active cooldown, or null

setCooldown

void setCooldown(@NonNull CooldownGroup group,
 @NonNull CooldownInstance cooldown)

Sets the cooldown for the given group.

Parameters:

group - group that identifies the cooldown

cooldown - cooldown value

deleteCooldown

void deleteCooldown(@NonNull CooldownGroup group)

Deletes the cooldown for the given group, if it exists.

Parameters:

group - the group

isEmpty

boolean isEmpty()

Returns whether the profile is empty.

Returns:

true if the profile is empty, else false