org.anvilpowered.anvil.api.util.PermissionService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of anvil-api Show documentation

A cross-platform database API / ORM / entity framework with useful services for minecraft plugins

The newest version!

/*
 *   Anvil - AnvilPowered
 *   Copyright (C) 2020
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with this program.  If not, see .
 */

package org.anvilpowered.anvil.api.util;

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

public interface PermissionService {

    /**
     * Checks whether the provided {@code subject} has
     * the provided {@code permission}. Depending on
     * the target platform, this can be a
     * Player, User, Group etc...
     *
     * 
     * If the provided {@code subject} is the console, returns {@code true}
     * 
     *
     * 
     * If the provided {@code subject} is {@code null}, returns {@code false}
     * 
     *
     * @param subject    The {@code subject} to test
     * @param permission The {@code permission} to check
     * @return Whether the provided {@code subject} has
     * the provided {@code permission} or is the console.
     */
    boolean hasPermission(@Nullable Object subject, String permission);
}