Package me.lucko.luckperms.common.model.manager.user

Class AbstractUserManager<T extends User>

java.lang.Object

me.lucko.luckperms.common.model.manager.AbstractManager<UUID,User,T>

me.lucko.luckperms.common.model.manager.user.AbstractUserManager<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

StandardUserManager

public abstract class AbstractUserManager<T extends User>
extends AbstractManager<UUID,User,T>
implements UserManager<T>

Constructor Summary

Constructors

Constructor	Description
AbstractUserManager(LuckPermsPlugin plugin, UserHousekeeper.TimeoutSettings timeoutSettings)

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 UserManager.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 class me.lucko.luckperms.common.model.manager.AbstractManager

getAll, getIfLoaded, getOrMake, isLoaded, retainAll, sanitizeIdentifier, unload

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Methods inherited from interface me.lucko.luckperms.common.model.manager.Manager

getAll, getIfLoaded, getOrMake, isLoaded, retainAll, unload

Constructor Details

AbstractUserManager

public AbstractUserManager(LuckPermsPlugin plugin,
 UserHousekeeper.TimeoutSettings timeoutSettings)

Method Details

getOrMake

public T getOrMake(UUID id,
 String username)

Specified by:

getOrMake in interface UserManager<T extends User>

getByUsername

public T getByUsername(String name)

Description copied from interface: UserManager

Get a user object by name

Specified by:

getByUsername in interface UserManager<T extends User>

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

public boolean giveDefaultIfNeeded(User user)

Description copied from interface: UserManager

Gives the user the default group if necessary.

Specified by:

giveDefaultIfNeeded in interface UserManager<T extends User>

Parameters:

user - the user to give to

isNonDefaultUser

public boolean isNonDefaultUser(User user)

Description copied from interface: UserManager

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

Specified by:

isNonDefaultUser in interface UserManager<T extends User>

Parameters:

user - the user to check

Returns:

true if the user should be saved

isDefaultNode

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

Description copied from interface: UserManager

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

Specified by:

isDefaultNode in interface UserManager<T extends User>

Parameters:

node - the node

Returns:

true if it is the default node

getHouseKeeper

public UserHousekeeper getHouseKeeper()

Description copied from interface: UserManager

Gets the instance responsible for unloading unneeded users.

Specified by:

getHouseKeeper in interface UserManager<T extends User>

Returns:

the housekeeper

loadAllUsers

public CompletableFuture<Void> loadAllUsers()

Description copied from interface: UserManager

Reloads the data of all *online* users

Specified by:

loadAllUsers in interface UserManager<T extends User>

invalidateAllUserCaches

public void invalidateAllUserCaches()

Description copied from interface: UserManager

Invalidates the cached data for *loaded* users.

Specified by:

invalidateAllUserCaches in interface UserManager<T extends User>

invalidateAllPermissionCalculators

public void invalidateAllPermissionCalculators()

Description copied from interface: UserManager

Invalidates the PermissionCalculators for *loaded* users.

Specified by:

invalidateAllPermissionCalculators in interface UserManager<T extends User>