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

There is a newer version: 4.4

/*
 * 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 java.util.UUID;

import javax.annotation.Nonnull;

/**
 * A UUID cache for online users, between external Mojang UUIDs, and internal
 * LuckPerms UUIDs.
 *
 * @deprecated this feature is now handled internally - and the API returns a
 *             No-op implementation of this class.
 */
@Deprecated
public interface UuidCache {

    /**
     * Gets a users "internal" LuckPerms UUID, from the one given by the server.
     *
     * When use-server-uuids is true, this returns the same UUID
     * instance.
     *
     * @param mojangUuid the UUID assigned by the server, through
     *                   Player#getUniqueId or
     *                   ProxiedPlayer#getUniqueId
     * @return the corresponding internal UUID
     */
    @Nonnull
    @Deprecated
    UUID getUUID(@Nonnull UUID mojangUuid);

    /**
     * Gets a users "external", server assigned unique id, from the internal
     * one used within LuckPerms.
     *
     * @param internalUuid the UUID used within LuckPerms, through
     *                     User#getUuid
     * @return the corresponding external UUID
     */
    @Nonnull
    @Deprecated
    UUID getExternalUUID(@Nonnull UUID internalUuid);

}