Interface UserManager<T extends User>

All Superinterfaces:

Function<UUID,T>, Manager<UUID,User,T>

All Known Implementing Classes:

AbstractUserManager, StandardUserManager

public interface UserManager<T extends User>
extends Manager<UUID,User,T>

Method Summary

Modifier and Type	Method	Description
T	getByUsername(String name)	Get a user object by name
UserHousekeeper	getHouseKeeper()	Gets the instance responsible for unloading unneeded users.
T	getOrMake(UUID id, String username)
boolean	giveDefaultIfNeeded(User user)	Gives the user the default group if necessary.
void	invalidateAllPermissionCalculators()	Invalidates the PermissionCalculators for *loaded* users.
void	invalidateAllUserCaches()	Invalidates the cached data for *loaded* users.
boolean	isDefaultNode(net.luckperms.api.node.Node node)	Gets whether the given node is a default node given by giveDefaultIfNeeded(User).
boolean	isNonDefaultUser(User user)	Check whether the user's state indicates that they should be persisted to storage.
CompletableFuture<Void>	loadAllUsers()	Reloads the data of all *online* users

Methods inherited from interface Function

andThen, apply, compose

Methods inherited from interface Manager

getAll, getIfLoaded, getOrMake, isLoaded, retainAll, unload

Method Details

getOrMake

T getOrMake(UUID id,
 String username)

getByUsername

T getByUsername(String name)

Get a user object by name

Parameters:

name - The name to search by

Returns:

a User object if the user is loaded, returns null if the user is not loaded

giveDefaultIfNeeded

boolean giveDefaultIfNeeded(User user)

Gives the user the default group if necessary.

Parameters:

user - the user to give to

isNonDefaultUser

boolean isNonDefaultUser(User user)

Check whether the user's state indicates that they should be persisted to storage.

Parameters:

user - the user to check

Returns:

true if the user should be saved

isDefaultNode

boolean isDefaultNode(net.luckperms.api.node.Node node)

Gets whether the given node is a default node given by giveDefaultIfNeeded(User).

Parameters:

node - the node

Returns:

true if it is the default node

getHouseKeeper

UserHousekeeper getHouseKeeper()

Gets the instance responsible for unloading unneeded users.

Returns:

the housekeeper

loadAllUsers

CompletableFuture<Void> loadAllUsers()

Reloads the data of all *online* users

invalidateAllUserCaches

void invalidateAllUserCaches()

Invalidates the cached data for *loaded* users.

invalidateAllPermissionCalculators

void invalidateAllPermissionCalculators()

Invalidates the PermissionCalculators for *loaded* users.