// @formatter:off
/*
 * Pexel Project - Minecraft minigame server platform. 
 * Copyright (C) 2014 Matej Kormuth <http://www.matejkormuth.eu>
 * 
 * This file is part of Pexel.
 * 
 * Pexel 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, either version 3 of the License, or (at your option) any later version.
 * 
 * Pexel 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/>.
 *
 */
// @formatter:on
package eu.matejkormuth.pexel.PexelCore.core;

import java.util.Collection;

import org.bukkit.entity.Player;

/**
 * Specifies class that hold collection of players.
 * 
 * @author Mato Kormuth
 * 
 */
public interface PlayerHolder {
    /**
     * Returns collection of players in this object.
     * 
     * @return list of players.
     */
    public Collection<Player> getPlayers();
    
    /**
     * Returns number of players in this object.
     * 
     * @return player count
     */
    public int getPlayerCount();
    
    /**
     * Returns whether object contains specified player.
     * 
     * @param player
     *            specified player to check
     * @return whether the object contains player or not
     */
    public boolean contains(Player player);
}
