Package me.remigio07.chatplugin.api.common.util.manager

Interface ChatPluginManager

All Known Subinterfaces:

DenyChatReasonHandler

All Known Implementing Classes:

AccountCheckManager, ActionbarManager, AdManager, AnticheatManager, AntispamManager, BanManager, BanwaveManager, BossbarManager, ChatLogManager, ChatManager, ConfigurationManager, CustomSuffixManager, DatabaseManager, DiscordIntegrationManager, EventManager, F3ServerNameManager, FlatFileManager, FormattedChatManager, GUIManager, HoverInfoManager, InstantEmojisManager, IntegrationManager, IPLookupManager, JoinMessageManager, JoinTitleManager, KickManager, LanguageManager, LocalIPLookupManager, LogManager, MoTDManager, MuteManager, PingManager, PlaceholderManager, PlayerIgnoreManager, PlayerManager, PlayerPingManager, PrivateMessagesManager, ProxyManager, ProxyMessageManager, ProxyMoTDManager, ProxyPlayerManager, PunishmentManager, QuitMessageManager, RangedChatManager, RankManager, ScoreboardManager, ServerMoTDManager, ServerPlayerManager, StaffChatManager, StorageManager, SuggestedVersionManager, SwitchMessageManager, TablistManager, TaskManager, TelegramIntegrationManager, TPSManager, VanishManager, WarningManager, WelcomeMessageManager

public interface ChatPluginManager

Interface that represents one of the managers used by ChatPlugin.

Method Summary

Modifier and Type	Method	Description
default boolean	checkAvailability(boolean warnIfUnavailable)	Checks if this manager specifies a GameFeature annotation.
static GameFeature	checkInterfaces(Class<?> clazz)
boolean	isEnabled()	Checks if this manager is enabled.
default boolean	isReloadable()	Checks if this manager will be reloaded on a plugin reload.
void	load()	Loads (or reloads) this manager.
default void	reload()	Reloads this manager.
default void	unload()	Unloads this manager.

Method Details

load

void load()
   throws ChatPluginManagerException

Loads (or reloads) this manager.

Throws:

ChatPluginManagerException - If something goes wrong

unload

default void unload()
             throws ChatPluginManagerException

Unloads this manager.

Will do nothing if this method is not overridden.

Throws:

ChatPluginManagerException - If something goes wrong

reload

default void reload()
             throws ChatPluginManagerException

Reloads this manager.

Will call unload() and then load() if not overridden.

Throws:

ChatPluginManagerException - If something goes wrong

isEnabled

boolean isEnabled()

Checks if this manager is enabled.

Returns:

Whether this manager is enabled

isReloadable

default boolean isReloadable()

Checks if this manager will be reloaded on a plugin reload.

Will return true if this method is not overridden.

Returns:

Whether this manager is reloadable

checkAvailability

default boolean checkAvailability(boolean warnIfUnavailable)

Checks if this manager specifies a GameFeature annotation.

In that case, if Environment.isProxy() == false (GameFeatures are not used on proxies), the feature's availability on the current environment is checked through three steps:

1. environment compatibility - whether the feature is available on Bukkit/Sponge
2. Spigot requirement - whether the feature requires Spigot or a fork; Bukkit only
3. minimum version - the minimum Vanilla version required to run the feature

Parameters:

warnIfUnavailable - Whether to send a message if the feature is unavailable

Returns:

Whether this manager's features may run on Environment.getCurrent()

checkInterfaces

static GameFeature checkInterfaces(Class<?> clazz)