001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package net.tridentsdk.registry;
018
019import net.tridentsdk.entity.living.Player;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.UUID;
023
024/**
025 * The player registry
026 *
027 * @author The TridentSDK Team
028 * @since 0.4-alpha
029 */
030@ThreadSafe
031public interface Players extends Registry<Player> {
032    /**
033     * Obtains a player from the player's UUID
034     *
035     * @param uuid the player's uuid
036     * @return the player with that UUID, or null if the player is not online
037     */
038    Player fromUuid(UUID uuid);
039
040    /**
041     * Obtains a potentially offline player
042     *
043     * @param uuid the uuid to find
044     * @return a non-null player that could be offline
045     */
046    Player offline(UUID uuid);
047}