me.lucko.luckperms.api.manager.TrackManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of luckperms-api Show documentation
An advanced permissions plugin for Bukkit/Spigot, BungeeCord, Sponge, Nukkit and Velocity.
The newest version!
/*
 * This file is part of LuckPerms, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) 
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package me.lucko.luckperms.api.manager;

import me.lucko.luckperms.api.Storage;
import me.lucko.luckperms.api.Track;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import java.util.function.Consumer;

/**
 * Represents the object responsible for managing {@link Track} instances.
 *
 * All blocking methods return {@link CompletableFuture}s, 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 {@link 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 {@link CompletableFuture#thenAcceptAsync(Consumer, Executor)}.
 *
 * @since 4.0
 */
public interface TrackManager {

    /**
     * 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
     * {@link Storage#createAndLoadTrack(String)}, however, the Future returns
     * the resultant track instance instead of a boolean flag.
     *
     * Unlike the method in {@link Storage}, when a track cannot be loaded,
     * the future will be {@link CompletableFuture completed exceptionally}.
     *
     * @param name the name of the track
     * @return the resultant track
     * @throws NullPointerException if the name is null
     * @since 4.1
     */
    @NonNull CompletableFuture createAndLoadTrack(@NonNull String name);

    /**
     * Loads a track from the plugin's storage provider into memory.
     *
     * Returns an {@link Optional#empty() empty optional} if the track does
     * not exist.
     *
     * This method is effectively the same as
     * {@link Storage#loadTrack(String)}, however, the Future returns
     * the resultant track instance instead of a boolean flag.
     *
     * Unlike the method in {@link Storage}, when a track cannot be loaded,
     * the future will be {@link CompletableFuture completed exceptionally}.
     *
     * @param name the name of the track
     * @return the resultant track
     * @throws NullPointerException if the name is null
     * @since 4.1
     */
    @NonNull CompletableFuture> loadTrack(@NonNull String name);

    /**
     * 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 {@link Storage#saveTrack(Track)},
     * however, the Future returns void instead of a boolean flag.
     *
     * Unlike the method in {@link Storage}, when a track cannot be saved,
     * the future will be {@link CompletableFuture completed exceptionally}.
     *
     * @param track the track to save
     * @return a future to encapsulate the operation.
     * @throws NullPointerException  if track is null
     * @throws IllegalStateException if the track instance was not obtained from LuckPerms.
     * @since 4.1
     */
    @NonNull CompletableFuture saveTrack(@NonNull Track track);

    /**
     * Permanently deletes a track from the plugin's storage provider.
     *
     * This method is effectively the same as {@link Storage#deleteTrack(Track)},
     * however, the Future returns void instead of a boolean flag.
     *
     * Unlike the method in {@link Storage}, when a track cannot be deleted,
     * the future will be {@link CompletableFuture completed exceptionally}.
     *
     * @param track the track to delete
     * @return a future to encapsulate the operation.
     * @throws NullPointerException  if track is null
     * @throws IllegalStateException if the track instance was not obtained from LuckPerms.
     * @since 4.1
     */
    @NonNull CompletableFuture deleteTrack(@NonNull Track track);

    /**
     * Loads all tracks into memory.
     *
     * This method is effectively the same as {@link Storage#loadAllTracks()},
     * however, the Future returns void instead of a boolean flag.
     *
     * Unlike the method in {@link Storage}, when a track cannot be loaded,
     * the future will be {@link CompletableFuture completed exceptionally}.
     *
     * @return a future to encapsulate the operation.
     * @since 4.1
     */
    @NonNull CompletableFuture loadAllTracks();

    /**
     * Gets a loaded track.
     *
     * @param name the name of the track to get
     * @return a {@link Track} object, if one matching the name exists, or null if not
     * @throws NullPointerException if the name is null
     */
    @Nullable Track getTrack(@NonNull String name);

    /**
     * Gets a loaded track.
     *
     * This method does not return null, unlike {@link #getTrack}
     *
     * @param name the name of the track to get
     * @return an optional {@link Track} object
     * @throws NullPointerException if the name is null
     */
    default @NonNull Optional getTrackOpt(@NonNull String name) {
        return Optional.ofNullable(getTrack(name));
    }

    /**
     * Gets a set of all loaded tracks.
     *
     * @return a {@link Set} of {@link Track} objects
     */
    @NonNull Set getLoadedTracks();

    /**
     * Check if a track is loaded in memory
     *
     * @param name the name to check for
     * @return true if the track is loaded
     * @throws NullPointerException if the name is null
     */
    boolean isLoaded(@NonNull String name);

}