/*
 * Copyright (C) 2011-2018 lishid. All rights reserved.
 *
 * 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, version 3.
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

package com.lishid.openinv.internal;

import java.util.Collection;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface IPlayerDataManager {

    /**
     * Loads a Player for an OfflinePlayer.
     * </p>
     * This method is potentially blocking, and should not be called on the main thread.
     *
     * @param offline the OfflinePlayer
     * @return the Player loaded
     */
    @Nullable
    Player loadPlayer(@NotNull OfflinePlayer offline);

    /**
     * Gets a unique identifying string for an OfflinePlayer.
     *
     * @param offline the OfflinePlayer
     * @return the unique identifier
     */
    @NotNull
    String getPlayerDataID(@NotNull OfflinePlayer offline);

    /**
     * Gets an OfflinePlayer by the given unique identifier.
     *
     * @param identifier the unique identifier
     * @return the OfflinePlayer, or null if no exact match was found
     */
    @Nullable
    OfflinePlayer getPlayerByID(@NotNull String identifier);

    /**
     * Gets a Collection of all Players currently online.
     *
     * @return the Collection of Players
     */
    @NotNull
    Collection<? extends Player> getOnlinePlayers();

}