Package org.incendo.cloud.processors.cooldown

Class CooldownRepository.MappingCooldownRepository<C,K>

java.lang.Object

org.incendo.cloud.processors.cooldown.CooldownRepository.MappingCooldownRepository<C,K>

All Implemented Interfaces:

CooldownRepository<C>

Enclosing interface:

CooldownRepository<K>

public static final class CooldownRepository.MappingCooldownRepository<C,K>
extends Object
implements CooldownRepository<C>

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.processors.cooldown.CooldownRepository

CooldownRepository.AbstractCooldownRepository<K>, CooldownRepository.CacheCooldownRepository<K>, CooldownRepository.MapCooldownRepository<K>, CooldownRepository.MappingCooldownRepository<C,K>

Method Summary

Modifier and Type	Method	Description
void	deleteCooldown(@NonNull C key, @NonNull CooldownGroup group)	Deletes the cooldown identified by the given key belonging to the given group.
void	deleteProfile(@NonNull C key)	Deletes the profile identified by the given key.
@NonNull CooldownProfile	getProfile(@NonNull C key, @NonNull CooldownProfileFactory profileFactory)	Returns the profile for the given key.
@Nullable CooldownProfile	getProfileIfExists(@NonNull C key)	Returns the profile for the given key, if it exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getProfile

public @NonNull CooldownProfile getProfile(@NonNull C key,
 @NonNull CooldownProfileFactory profileFactory)

Description copied from interface: CooldownRepository

Returns the profile for the given key.

If no profile exists in the repository, a new profile will be persisted and returned.

Specified by:

getProfile in interface CooldownRepository<C>

Parameters:

key - key that identifies the profile

profileFactory - factory that creates profiles

Returns:

the profile

getProfileIfExists

public @Nullable CooldownProfile getProfileIfExists(@NonNull C key)

Description copied from interface: CooldownRepository

Returns the profile for the given key, if it exists.

Specified by:

getProfileIfExists in interface CooldownRepository<C>

Parameters:

key - key that identifies the profile

Returns:

the profile, or null

deleteProfile

public void deleteProfile(@NonNull C key)

Description copied from interface: CooldownRepository

Deletes the profile identified by the given key.

Specified by:

deleteProfile in interface CooldownRepository<C>

Parameters:

key - the key

deleteCooldown

public void deleteCooldown(@NonNull C key,
 @NonNull CooldownGroup group)

Description copied from interface: CooldownRepository

Deletes the cooldown identified by the given key belonging to the given group.

If the profile is empty after the deletion, then the profile is deleted too.

Specified by:

deleteCooldown in interface CooldownRepository<C>

Parameters:

key - key identifying the profile

group - group to delete