me.lucko.luckperms.api.User 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;

import me.lucko.luckperms.api.caching.UserData;

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

import java.util.UUID;

/**
 * A player which holds permission data.
 */
public interface User extends PermissionHolder {

    /**
     * Gets the users unique ID
     *
     * @return the users Mojang assigned unique id
     */
    @NonNull UUID getUuid();

    /**
     * Gets the users username
     *
     * Returns null if no username is known for the user.
     *
     * @return the users username
     */
    @Nullable String getName();

    /**
     * Gets the users current primary group.
     *
     * The result of this method depends on which method is configured for primary group
     * calculation. It may not be the same as any value set through
     * {@link #setPrimaryGroup(String)}.
     *
     * @return the users primary group
     */
    @NonNull String getPrimaryGroup();

    /**
     * Sets a users primary group.
     *
     * This modifies the "stored value" for the users primary group, which may or may not
     * actually take effect, depending on how the platform is calculating primary groups.
     *
     * @param group the new primary group
     * @return if the change was applied successfully
     * @throws IllegalStateException if the user is not a member of that group
     * @throws NullPointerException  if the group is null
     */
    @NonNull DataMutateResult setPrimaryGroup(@NonNull String group);

    /**
     * Gets the user's {@link UserData} cache.
     *
     * @return the users cached data.
     * @since 3.2
     */
    @Override
    @NonNull UserData getCachedData();

    /**
     * Refresh and re-assign the users permissions.
     *
     * @deprecated Calling this method is no longer necessary. Permissions data is now refreshed on
     * demand, as changes are made. Consider use of {@link #refreshCachedData()}
     * instead. This method is now implemented as a no-op.
     */
    @Deprecated
    void refreshPermissions();

    /**
     * Pre-calculates some values in the user's data cache.
     *
     * @since 2.17
     * @deprecated Use of this method is no longer necessary. It is implemented as a no-op.
     */
    @Deprecated
    void setupDataCache();

}