com.tvd12.gamebox.manager.PlayerManager Maven / Gradle / Ivy
package com.tvd12.gamebox.manager;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.locks.Lock;
import java.util.function.Predicate;
import com.tvd12.gamebox.entity.Player;
public interface PlayerManager {
/**
* Get player by id
*
* @param username the player's name
* @return the player
*/
P getPlayer(String username);
/**
* Get player by index
*
* @param index the player's index
* @return the player
*/
P getPlayerByIndex(int index);
/**
* Get players as list
*
* @return the player as list
*/
List
getPlayerList();
/**
* Get players as list
*
* @param predicate the predicate to test
* @return the player list
*/
List
getPlayerList(Predicate
predicate);
/**
* Get list of player name
*
* @return the list of player name
*/
List getPlayerNames();
/**
* Get count of players
*
* @return count of players
*/
int getPlayerCount();
/**
* Get max players count
*
* @return the max players count
*/
int getMaxPlayers();
/**
* available to add player or not
*
* @return available to add player or not
*/
boolean available();
/**
* Check whether contains player or not
*
* @param username the player's name
* @return true or false
*/
boolean containsPlayer(String username);
/**
* add player
*
* @param player player to add
* @param failIfAdded throw an exception if player has added
*/
void addPlayer(P player, boolean failIfAdded);
/**
* add players
*
* @param players players to add
* @param failIfAdded throw an exception if player has added
*/
void addPlayers(Collection players, boolean failIfAdded);
/**
* Remove player
*
* @param player the player
* @return removed player
*/
P removePlayer(P player);
/**
* remove collection of player
*
* @param players the player to remove
*/
void removePlayers(Collection
players);
/**
* Get lock mapped to player's name
*
* @param username the player's name
* @return the lock
*/
Lock getLock(String username);
/**
* Remove lock mapped to player's name
*
* @param username the player's name
*/
void removeLock(String username);
/**
* clear all user
*/
void clear();
/**
* count player
*
* @param tester the test function
* @return the player count
*/
int countPlayers(Predicate
tester);
/**
* filter player to list
*
* @param tester the test function
* @return list of filtered player
*/
List
filterPlayers(Predicate
tester);
/**
* check is empty
*
* @return empty or not
*/
public boolean isEmpty();
/**
* Check whether contains player or not
*
* @param player the player
* @return true or false
*/
default boolean containsPlayer(P player) {
return containsPlayer(player.getName());
}
/**
* add player
*
* @param player player to add
*/
default void addPlayer(P player) {
addPlayer(player, true);
}
/**
* add players
*
* @param players players to add
*/
default void addPlayers(Collection
players) {
addPlayers(players, true);
}
/**
* Remove player by name
*
* @param username the player name
* @return the removed player
*/
default P removePlayer(String username) {
return removePlayer(getPlayer(username));
}
}