me.lucko.luckperms.api.manager

Interface GroupManager

public interface GroupManager

Represents the object responsible for managing Group instances.

All blocking methods return CompletableFutures, which will be populated with the result once the data has been loaded/saved asynchronously. Care should be taken when using such methods to ensure that the main server thread is not blocked.

Methods such as CompletableFuture.get() and equivalent should not be called on the main server thread. If you need to use the result of these operations on the main server thread, register a callback using CompletableFuture.thenAcceptAsync(Consumer, Executor).

Since:

4.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Group>	createAndLoadGroup(String name) Creates a new group in the plugin's storage provider and then loads it into memory.
CompletableFuture<Void>	deleteGroup(Group group) Permanently deletes a group from the plugin's storage provider.
Group	getGroup(String name) Gets a loaded group.
default Optional<Group>	getGroupOpt(String name) Gets a loaded group.
Set<Group>	getLoadedGroups() Gets a set of all loaded groups.
CompletableFuture<List<HeldPermission<String>>>	getWithPermission(String permission) Searches for a list of groups with a given permission.
boolean	isLoaded(String name) Check if a group is loaded in memory
CompletableFuture<Void>	loadAllGroups() Loads all groups into memory.
CompletableFuture<Optional<Group>>	loadGroup(String name) Loads a group from the plugin's storage provider into memory.
CompletableFuture<Void>	saveGroup(Group group) Saves a group's data back to the plugin's storage provider.

Method Detail

createAndLoadGroup

@Nonnull
CompletableFuture<Group> createAndLoadGroup(@Nonnull
                                                      String name)

Creates a new group in the plugin's storage provider and then loads it into memory.

If a group by the same name already exists, it will be loaded.

This method is effectively the same as Storage.createAndLoadGroup(String), however, the Future returns the resultant group instance instead of a boolean flag.

Unlike the method in Storage, when a group cannot be loaded, the future will be completed exceptionally.

Parameters:

name - the name of the group

Returns:

the resultant group

Throws:

NullPointerException - if the name is null

Since:

4.1

loadGroup

@Nonnull
CompletableFuture<Optional<Group>> loadGroup(@Nonnull
                                                       String name)

Loads a group from the plugin's storage provider into memory.

Returns an empty optional if the group does not exist.

This method is effectively the same as Storage.loadGroup(String), however, the Future returns the resultant group instance instead of a boolean flag.

Unlike the method in Storage, when a group cannot be loaded, the future will be completed exceptionally.

Parameters:

name - the name of the group

Returns:

the resultant group

Throws:

NullPointerException - if the name is null

Since:

4.1

saveGroup

@Nonnull
CompletableFuture<Void> saveGroup(@Nonnull
                                            Group group)

Saves a group's data back to the plugin's storage provider.

You should call this after you make any changes to a group.

This method is effectively the same as Storage.saveGroup(Group), however, the Future returns void instead of a boolean flag.

Unlike the method in Storage, when a group cannot be saved, the future will be completed exceptionally.

Parameters:

group - the group to save

Returns:

a future to encapsulate the operation.

Throws:

NullPointerException - if group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

Since:

4.1

deleteGroup

@Nonnull
CompletableFuture<Void> deleteGroup(@Nonnull
                                              Group group)

Permanently deletes a group from the plugin's storage provider.

This method is effectively the same as Storage.deleteGroup(Group), however, the Future returns void instead of a boolean flag.

Unlike the method in Storage, when a group cannot be deleted, the future will be completed exceptionally.

Parameters:

group - the group to delete

Returns:

a future to encapsulate the operation.

Throws:

NullPointerException - if group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

Since:

4.1

loadAllGroups

@Nonnull
CompletableFuture<Void> loadAllGroups()

Loads all groups into memory.

This method is effectively the same as Storage.loadAllTracks(), however, the Future returns void instead of a boolean flag.

Unlike the method in Storage, when a group cannot be loaded, the future will be completed exceptionally.

Returns:

a future to encapsulate the operation.

Since:

4.1

getWithPermission

@Nonnull
CompletableFuture<List<HeldPermission<String>>> getWithPermission(@Nonnull
                                                                            String permission)

Searches for a list of groups with a given permission.

Parameters:

permission - the permission to search for

Returns:

a list of held permissions, or null if the operation failed

Throws:

NullPointerException - if the permission is null

Since:

4.2

getGroup

@Nullable
Group getGroup(@Nonnull
                          String name)

Gets a loaded group.

Parameters:

name - the name of the group to get

Returns:

a Group object, if one matching the name exists, or null if not

Throws:

NullPointerException - if the name is null

getGroupOpt

@Nonnull
default Optional<Group> getGroupOpt(@Nonnull
                                              String name)

Gets a loaded group.

This method does not return null, unlike getGroup(java.lang.String)

Parameters:

name - the name of the group to get

Returns:

an optional Group object

Throws:

NullPointerException - if the name is null

getLoadedGroups

@Nonnull
Set<Group> getLoadedGroups()

Gets a set of all loaded groups.

Returns:

a Set of Group objects

isLoaded

boolean isLoaded(@Nonnull
                 String name)

Check if a group is loaded in memory

Parameters:

name - the name to check for

Returns:

true if the group is loaded

Throws:

NullPointerException - if the name is null