PlayerElement.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * 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 com.jcwhatever.nucleus.collections.players;

import com.jcwhatever.nucleus.mixins.IPlayerReference;
import org.bukkit.entity.Player;

import javax.annotation.Nullable;
import java.util.UUID;


/**
 * Encapsulates a player object and provides hashCode and
 * equals based on player UUID.
 *
 * <p>Used to compensate for CraftBukkit player objects dynamic hashCode.</p>
 */
public final class PlayerElement {

    private Player _player;

    /**
     * Constructor.
     *
     * @param player  The {@link Player} object to encapsulate.
     */
    public PlayerElement(Player player) {
        _player = player;
    }

    /**
     * Get the encapsulated player object.
     */
    public Player getPlayer() {
        return _player;
    }

    /**
     * Get the encapsulated players unique id.
     */
    public UUID getUniqueId() {
        return _player.getUniqueId();
    }

    @Override
    public int hashCode() {
        return _player.getUniqueId().hashCode();
    }

    @Override
    public boolean equals(Object obj) {

        if (obj instanceof Player) {
            return ((Player) obj).getUniqueId().equals(_player.getUniqueId());
        }
        else if (obj instanceof PlayerElement) {
            return ((PlayerElement) obj)._player.getUniqueId().equals(_player.getUniqueId());
        }

        return false;
    }

    /**
     * Used to match an object with a {@link PlayerElement} object.
     */
    public static class PlayerElementMatcher {
        Object object;
        UUID id;
        int hash;

        public PlayerElementMatcher(Object object) {
            this.object = object;

            PlayerElement entry = null;

            if (object instanceof Player) {
                entry = new PlayerElement((Player)object);
                hash = entry.getUniqueId().hashCode();
                id = entry.getUniqueId();
            } else if (object instanceof PlayerElement) {
                entry = (PlayerElement)object;
                hash = entry.getUniqueId().hashCode();
            }
            else if (object instanceof UUID) {
                id = (UUID)object;
                hash = id.hashCode();
            }
            else if (object instanceof IPlayerReference) {
                entry = new PlayerElement(((IPlayerReference) object).getPlayer());
                hash = entry.hashCode();
                id = entry.getUniqueId();
            }
            else {
                hash = object.hashCode();
            }

            this.object = entry != null ? entry : object;
        }

        @Nullable
        public UUID getUniqueId() {
            return id;
        }

        @Override
        public int hashCode() {
            return hash;
        }

        @Override
        public boolean equals(Object obj) {
            if (object == obj)
                return true;

            if (obj instanceof PlayerElementMatcher) {
                return id.equals(((PlayerElementMatcher) obj).id);
            }
            else if (obj instanceof PlayerElement) {
                return ((PlayerElement) obj)._player.getUniqueId().equals(id);
            }

            return object.equals(obj);
        }
    }
}