api/src/main/java/us/myles/ViaVersion/ViaManager.java

/*
 * This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
 * Copyright (C) 2016-2021 ViaVersion and contributors
 *
 * 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 us.myles.ViaVersion;

import us.myles.ViaVersion.api.command.ViaVersionCommand;
import us.myles.ViaVersion.api.platform.ViaConnectionManager;
import us.myles.ViaVersion.api.platform.ViaInjector;
import us.myles.ViaVersion.api.platform.ViaPlatform;
import us.myles.ViaVersion.api.platform.ViaPlatformLoader;
import us.myles.ViaVersion.api.platform.providers.ViaProviders;
import us.myles.ViaVersion.api.protocol.ProtocolManager;

import java.util.Set;

public interface ViaManager {

    /**
     * Returns the protocol manager for registering/getting protocols and their mapping data loading.
     *
     * @return protocol manager
     */
    ProtocolManager getProtocolManager();

    /**
     * Returns platform for handling platform specific configuration, tasks, and plugin data.
     *
     * @return platform
     */
    ViaPlatform<?> getPlatform();

    /**
     * Returns the userconnection manager for handling clients connected to the server.
     *
     * @return userconnection manager
     */
    ViaConnectionManager getConnectionManager();

    /**
     * Returns the manager for Via providers.
     *
     * @return provider manager
     */
    ViaProviders getProviders();

    /**
     * Returns the injector for injecting netty handlers and initially getting the server protocol version.
     *
     * @return injector
     */
    ViaInjector getInjector();

    /**
     * Returns the command handler for managing ViaVersion subcommands.
     *
     * @return command handler
     */
    ViaVersionCommand getCommandHandler();

    /**
     * Returns the platform loader responsible for registering listeners, providers and such.
     *
     * @return platform loader
     */
    ViaPlatformLoader getLoader();

    /**
     * If debug is enabled, packets and other otherwise suppressed warnings will be logged.
     *
     * @return true if enabled
     */
    boolean isDebug();

    /**
     * Sets the debug mode. If enabled, packets and other otherwise suppressed warnings will be logged.
     *
     * @param debug whether debug should be enabled
     */
    void setDebug(boolean debug);

    /**
     * Returns a mutable set of self-added subplatform version strings.
     * This set is expanded by the subplatform itself (e.g. ViaBackwards), and may not contain all running ones.
     *
     * @return mutable set of subplatform versions
     */
    Set<String> getSubPlatforms();

    /**
     * Adds a runnable to be executed when ViaVersion has finished its init before the full server load.
     *
     * @param runnable runnable to be executed
     */
    void addEnableListener(Runnable runnable);
}