Interface FetcharrAPI

API/src/main/java/me/egg82/fetcharr/api/FetcharrAPI.java:28–85

The Fetcharr API. The API allows plugins to read and modify Fetcharr data, change behavior of the app, listen to certain events, and integrate Fetcharr into other systems. This interface represents the base of the API package. All functions are accessed via this interface. To sta

 * accessor in {@link FetcharrAPIProvider}.</p>
 */
public interface FetcharrAPI {
    /**
     * Gets the main Fetcharr {@link EventRegistry},
     * where all {@link FetcharrEvent} API events pass through.
     *
     * @return the Fetcharr event registry
     */
    @NotNull EventRegistry<@NotNull FetcharrEvent> events();

    /**
     * Gets the main Fetcharr {@link EventBus},
     * where all {@link FetcharrEvent} API events are posted.
     *
     * @return the Fetcharr event bus
     */
    @NotNull EventBus<@NotNull FetcharrEvent> bus();

    /**
     * Gets the {@link UpdateManager}, responsible for
     * managing the *arr updaters.
     *
     * <p>This manager can be used to register
     * and hook into {@link Updater} instances.</p>
     *
     * @return the current update manager
     */
    @NotNull UpdateManager updateManager();

    /**
     * Sets the {@link UpdateManager} instance.
     *
     * @param manager the update manager
     */
    void updateManager(@NotNull UpdateManager manager);

    /**
     * Gets the {@link PluginManager}, responsible for
     * managing plugins.
     *
     * <p>This manager can be used to view
     * all currently-enabled plugins.</p>
     *
     * @return the current plugin manager
     */
    @NotNull PluginManager pluginManager();

    /**
     * Gets the {@link Registry}, responsible
     * for managing the plugin API registry.
     *
     * <p>This is useful for plugins registering
     * their own API objects to be used by other
     * plugins.</p>
     *
     * @return the registry
     */
    @NotNull Registry registry();
}