me.lucko.luckperms.api.manager

Interface TrackManager

public interface TrackManager

Represents the object responsible for managing Track 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<Track>	createAndLoadTrack(String name) Creates a new track in the plugin's storage provider and then loads it into memory.
CompletableFuture<Void>	deleteTrack(Track track) Permanently deletes a track from the plugin's storage provider.
Set<Track>	getLoadedTracks() Gets a set of all loaded tracks.
Track	getTrack(String name) Gets a loaded track.
default Optional<Track>	getTrackOpt(String name) Gets a loaded track.
boolean	isLoaded(String name) Check if a track is loaded in memory
CompletableFuture<Void>	loadAllTracks() Loads all tracks into memory.
CompletableFuture<Optional<Track>>	loadTrack(String name) Loads a track from the plugin's storage provider into memory.
CompletableFuture<Void>	saveTrack(Track track) Saves a track's data back to the plugin's storage provider.

Method Detail

createAndLoadTrack

@Nonnull
CompletableFuture<Track> createAndLoadTrack(@Nonnull
                                                      String name)

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

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

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

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

Parameters:

name - the name of the track

Returns:

the resultant track

Throws:

NullPointerException - if the name is null

Since:

4.1

loadTrack

@Nonnull
CompletableFuture<Optional<Track>> loadTrack(@Nonnull
                                                       String name)

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

Returns an empty optional if the track does not exist.

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

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

Parameters:

name - the name of the track

Returns:

the resultant track

Throws:

NullPointerException - if the name is null

Since:

4.1

saveTrack

@Nonnull
CompletableFuture<Void> saveTrack(@Nonnull
                                            Track track)

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

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

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

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

Parameters:

track - the track to save

Returns:

a future to encapsulate the operation.

Throws:

NullPointerException - if track is null

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

Since:

4.1

deleteTrack

@Nonnull
CompletableFuture<Void> deleteTrack(@Nonnull
                                              Track track)

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

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

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

Parameters:

track - the track to delete

Returns:

a future to encapsulate the operation.

Throws:

NullPointerException - if track is null

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

Since:

4.1

loadAllTracks

@Nonnull
CompletableFuture<Void> loadAllTracks()

Loads all tracks 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 track cannot be loaded, the future will be completed exceptionally.

Returns:

a future to encapsulate the operation.

Since:

4.1

getTrack

@Nullable
Track getTrack(@Nonnull
                          String name)

Gets a loaded track.

Parameters:

name - the name of the track to get

Returns:

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

Throws:

NullPointerException - if the name is null

getTrackOpt

@Nonnull
default Optional<Track> getTrackOpt(@Nonnull
                                              String name)

Gets a loaded track.

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

Parameters:

name - the name of the track to get

Returns:

an optional Track object

Throws:

NullPointerException - if the name is null

getLoadedTracks

@Nonnull
Set<Track> getLoadedTracks()

Gets a set of all loaded tracks.

Returns:

a Set of Track objects

isLoaded

boolean isLoaded(@Nonnull
                 String name)

Check if a track is loaded in memory

Parameters:

name - the name to check for

Returns:

true if the track is loaded

Throws:

NullPointerException - if the name is null