com.plotsquared.core.permissions.PermissionHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of PlotSquared-Core Show documentation
PlotSquared, a land and world management plugin for Minecraft.
There is a newer version: 6.11.2
/*
 *       _____  _       _    _____                                _
 *      |  __ \| |     | |  / ____|                              | |
 *      | |__) | | ___ | |_| (___   __ _ _   _  __ _ _ __ ___  __| |
 *      |  ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
 *      | |    | | (_) | |_ ____) | (_| | |_| | (_| | | |  __/ (_| |
 *      |_|    |_|\___/ \__|_____/ \__, |\__,_|\__,_|_|  \___|\__,_|
 *                                    | |
 *                                    |_|
 *            PlotSquared plot management system for Minecraft
 *               Copyright (C) 2014 - 2022 IntellectualSites
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see .
 */
package com.plotsquared.core.permissions;

import com.plotsquared.core.player.OfflinePlotPlayer;
import com.plotsquared.core.player.PlotPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;

import java.util.Optional;
import java.util.Set;

/**
 * Permission handler
 */
public interface PermissionHandler {

    /**
     * Initialize the permission handler
     */
    void initialize();

    /**
     * Attempt to construct a permission profile for a plot player
     *
     * @param playerPlotPlayer Plot player
     * @return Permission profile, if one was able to be constructed
     */
    @NonNull Optional getPermissionProfile(
            @NonNull PlotPlayer playerPlotPlayer
    );

    /**
     * Attempt to construct a permission profile for an offline plot player
     *
     * @param offlinePlotPlayer Offline player
     * @return Permission profile, if one was able to be constructed
     */
    @NonNull Optional getPermissionProfile(
            @NonNull OfflinePlotPlayer offlinePlotPlayer
    );

    /**
     * Get all capabilities that the permission handler has
     *
     * @return Immutable set of capabilities
     */
    @NonNull Set getCapabilities();

    /**
     * Check whether the permission handler has a given capability
     *
     * @param capability Capability
     * @return {@code true} if the handler has the capability, else {@code false}
     */
    default boolean hasCapability(final @NonNull PermissionHandlerCapability capability) {
        return this.getCapabilities().contains(capability);
    }


    /**
     * Permission handler capabilities
     */
    enum PermissionHandlerCapability {
        /**
         * The ability to check for online (player) permissions
         */
        ONLINE_PERMISSIONS,
        /**
         * The ability to check for offline (player) permissions
         */
        OFFLINE_PERMISSIONS,
        /**
         * Per world permissions
         */
        PER_WORLD_PERMISSIONS
    }

}