com.elikill58.negativity.universal.ban.storage

Interface ActiveBanStorage

All Known Implementing Classes:

DatabaseActiveBanStorage, FileActiveBanStorage

public interface ActiveBanStorage

A class responsible for loading and saving active bans.

Implementations must not retain any state since they can be replaced at any time, caching is fine as long as it does not require saving cached values implicitly.

Method Summary

Modifier and Type	Method and Description
List<Ban>	getAll() Get all active bans
@Nullable Ban	load(UUID playerId) Loads the active ban of the player identified by the given UUID.
List<Ban>	loadBanOnIP(String ip) Get all active ban on given IP
void	remove(UUID playerId) Removes the ban associated to the player identified by the given UUID.
void	save(Ban ban) Saves the given active ban.

Method Detail

load

@Nullable Ban load(UUID playerId)

Loads the active ban of the player identified by the given UUID.

Parameters:

playerId - the UUID of a player.

Returns:

the active ban of the player, or null if the player is not banned

save

void save(Ban ban)

Saves the given active ban.

Parameters:

ban - the active ban to save.

remove

void remove(UUID playerId)

Removes the ban associated to the player identified by the given UUID.

Parameters:

playerId - the UUID of the player

loadBanOnIP

List<Ban> loadBanOnIP(String ip)

Get all active ban on given IP

Parameters:

ip - which we are looking for bans

Returns:

all active ban on ip

getAll

List<Ban> getAll()

Get all active bans

Returns:

all active bans