IScoreboard.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.managed.scoreboards;

import org.bukkit.OfflinePlayer;
import org.bukkit.scoreboard.DisplaySlot;

import java.util.Collection;

/**
 * Scoreboard wrapper interface.
 */
public interface IScoreboard extends IManagedScoreboard {

    /**
     * Register and get a new scoreboard objective.
     *
     * @param name      The name of the objective.
     * @param criteria  The objective criteria.
     *
     * @return  The new objective.
     */
    IScorableObjective registerNewObjective(String name, String criteria);

    /**
     * Register and get a new scoreboard HUD objective.
     *
     * @param name  The name of the objective.
     *
     * @return  The new HUD objective.
     */
    IHudObjective registerNewHud(String name);

    /**
     * Get a registered objective by name.
     *
     * @param name  The name of the objective.
     *
     * @return  The objective or null if not found.
     */
    IObjective getObjective(String name);

    /**
     * Get all registered objectives with the specified criteria.
     *
     * @param criteria  The criteria to search for.
     */
    Collection<IObjective> getObjectivesByCriteria(String criteria);

    /**
     * Get all registered objectives with the specified criteria.
     *
     * @param criteria  The criteria to search for.
     * @param output    The output collection to add results to.
     *
     * @return  The output collection.
     */
    <T extends Collection<IObjective>> T getObjectivesByCriteria(String criteria, T output);

    /**
     * Get all registered objectives.
     */
    Collection<IObjective> getObjectives();

    /**
     * Get all registered objectives.
     *
     * @param output  The output collection to add results to.
     *
     * @return  The output collection.
     */
    <T extends Collection<IObjective>> T getObjectives(T output);

    /**
     * Get the objective assigned to the specified display slot.
     *
     * @param slot  The display slot.
     */
    IObjective getObjective(DisplaySlot slot);

    /**
     * Get scores for the specified entry.
     *
     * @param entry  The entry.
     */
    Collection<IScore> getScores(String entry);

    /**
     * Get scores for the specified entry.
     *
     * @param entry   The entry.
     * @param output  The output collection to add results to.
     *
     * @return  The output collection.
     */
    <T extends Collection<IScore>> T getScores(String entry, T output);

    /**
     * Reset the scores for a specified entry.
     *
     * @param entry  The entry.
     */
    void resetScores(String entry);

    /**
     * Register a new team.
     *
     * @param name  The name of the team.
     */
    ITeam registerNewTeam(String name);

    /**
     * Get the team a player is on.
     *
     * @param player  The player to check.
     */
    ITeam getPlayerTeam(OfflinePlayer player);

    /**
     * Get a team by name.
     *
     * @param name  The name of the team.
     */
    ITeam getTeam(String name);

    /**
     * Get all registered teams.
     */
    Collection<ITeam> getTeams();

    /**
     * Get all registered teams.
     *
     * @param output  The output collection to add results to.
     *
     * @return  The output collection.
     */
    <T extends Collection<ITeam>> T getTeams(T output);

    /**
     * Get all score entries.
     */
    Collection<String> getEntries();

    /**
     * Get all score entries.
     *
     * @param output  The output collection to add results to.
     *
     * @return  The output collection.
     */
    <T extends Collection<String>> T getEntries(T output);

    /**
     * Clear display slot.
     *
     * @param slot  The display slot.
     */
    void clearSlot(DisplaySlot slot);
}