Rework the provider system

Essentials/src/main/java/com/earth2me/essentials/AlternativeCommandsHandler.java

@@ -1,5 +1,6 @@
 package com.earth2me.essentials;
 
+import net.ess3.provider.KnownCommandsProvider;
 import org.bukkit.command.Command;
 import org.bukkit.command.PluginIdentifiableCommand;
 import org.bukkit.plugin.Plugin;
@@ -52,7 +53,7 @@ public final void addPlugin(final Plugin plugin) {
 
     private Map<String, Command> getPluginCommands(Plugin plugin) {
         final Map<String, Command> commands = new HashMap<>();
-        for (final Map.Entry<String, Command> entry : ess.getKnownCommandsProvider().getKnownCommands().entrySet()) {
+        for (final Map.Entry<String, Command> entry : ess.getProviders().get(KnownCommandsProvider.class).getKnownCommands().entrySet()) {
             if (entry.getValue() instanceof PluginIdentifiableCommand && ((PluginIdentifiableCommand) entry.getValue()).getPlugin().equals(plugin)) {
                 commands.put(entry.getKey(), entry.getValue());
             }

Essentials/src/main/java/com/earth2me/essentials/Essentials.java

@@ -57,22 +57,9 @@
 import net.ess3.nms.refl.providers.ReflSpawnEggProvider;
 import net.ess3.nms.refl.providers.ReflSpawnerBlockProvider;
 import net.ess3.nms.refl.providers.ReflSyncCommandsProvider;
-import net.ess3.provider.ContainerProvider;
-import net.ess3.provider.FormattedCommandAliasProvider;
-import net.ess3.provider.ItemUnbreakableProvider;
 import net.ess3.provider.KnownCommandsProvider;
-import net.ess3.provider.MaterialTagProvider;
-import net.ess3.provider.PersistentDataProvider;
-import net.ess3.provider.PotionMetaProvider;
 import net.ess3.provider.ProviderListener;
-import net.ess3.provider.SerializationProvider;
 import net.ess3.provider.ServerStateProvider;
-import net.ess3.provider.SignDataProvider;
-import net.ess3.provider.SpawnEggProvider;
-import net.ess3.provider.SpawnerBlockProvider;
-import net.ess3.provider.SpawnerItemProvider;
-import net.ess3.provider.SyncCommandsProvider;
-import net.ess3.provider.WorldInfoProvider;
 import net.ess3.provider.providers.BaseLoggerProvider;
 import net.ess3.provider.providers.BasePotionDataProvider;
 import net.ess3.provider.providers.BlockMetaSpawnerItemProvider;
@@ -146,6 +133,7 @@ public class Essentials extends JavaPlugin implements net.ess3.api.IEssentials {
     private static Logger LOGGER = null;
     private final transient TNTExplodeListener tntListener = new TNTExplodeListener(this);
     private final transient Set<String> vanishedPlayers = new LinkedHashSet<>();
+    private final transient ProviderFactory providerFactory = new ProviderFactory(this);
     private transient ISettings settings;
     private transient Jails jails;
     private transient Warps warps;
@@ -165,23 +153,7 @@ public class Essentials extends JavaPlugin implements net.ess3.api.IEssentials {
     private transient I18n i18n;
     private transient MetricsWrapper metrics;
     private transient EssentialsTimer timer;
-    private transient SpawnerItemProvider spawnerItemProvider;
-    private transient SpawnerBlockProvider spawnerBlockProvider;
-    private transient SpawnEggProvider spawnEggProvider;
-    private transient PotionMetaProvider potionMetaProvider;
-    private transient ServerStateProvider serverStateProvider;
-    private transient ContainerProvider containerProvider;
-    private transient SerializationProvider serializationProvider;
-    private transient KnownCommandsProvider knownCommandsProvider;
-    private transient FormattedCommandAliasProvider formattedCommandAliasProvider;
     private transient ProviderListener recipeBookEventProvider;
-    private transient MaterialTagProvider materialTagProvider;
-    private transient SyncCommandsProvider syncCommandsProvider;
-    private transient PersistentDataProvider persistentDataProvider;
-    private transient ReflOnlineModeProvider onlineModeProvider;
-    private transient ItemUnbreakableProvider unbreakableProvider;
-    private transient WorldInfoProvider worldInfoProvider;
-    private transient SignDataProvider signDataProvider;
     private transient Kits kits;
     private transient RandomTeleport randomTeleport;
     private transient UpdateChecker updateChecker;
@@ -359,98 +331,69 @@ public void onEnable() {
             execTimer.mark("Init(Jails)");
 
             EconomyLayers.onEnable(this);
+            execTimer.mark("Init(EconomyLayers)");
 
-            //Spawner item provider only uses one but it's here for legacy...
-            spawnerItemProvider = new BlockMetaSpawnerItemProvider();
+            // Spawner item provider only uses one, but it's here for legacy...
+            providerFactory.registerProvider(BlockMetaSpawnerItemProvider.class);
 
-            //Spawner block providers
-            if (VersionUtil.getServerBukkitVersion().isLowerThan(VersionUtil.v1_12_0_R01)) {
-                spawnerBlockProvider = new ReflSpawnerBlockProvider();
-            } else {
-                spawnerBlockProvider = new BukkitSpawnerBlockProvider();
-            }
+            // Spawner block providers
+            providerFactory.registerProvider(ReflSpawnerBlockProvider.class, BukkitSpawnerBlockProvider.class);
 
-            //Spawn Egg Providers
-            if (VersionUtil.getServerBukkitVersion().isLowerThan(VersionUtil.v1_9_R01)) {
-                spawnEggProvider = new LegacySpawnEggProvider();
-            } else if (VersionUtil.getServerBukkitVersion().isLowerThanOrEqualTo(VersionUtil.v1_12_2_R01)) {
-                spawnEggProvider = new ReflSpawnEggProvider();
-            } else {
-                spawnEggProvider = new FlatSpawnEggProvider();
-            }
+            // Spawn Egg Providers
+            providerFactory.registerProvider(LegacySpawnEggProvider.class, ReflSpawnEggProvider.class, FlatSpawnEggProvider.class);
 
-            //Potion Meta Provider
-            if (VersionUtil.getServerBukkitVersion().isLowerThan(VersionUtil.v1_9_R01)) {
-                potionMetaProvider = new LegacyPotionMetaProvider();
-            } else {
-                potionMetaProvider = new BasePotionDataProvider();
-            }
+            // Potion Meta Provider
+            providerFactory.registerProvider(LegacyPotionMetaProvider.class, BasePotionDataProvider.class);
 
-            //Server State Provider
-            //Container Provider
-            if (PaperLib.isPaper() && VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_15_2_R01)) {
-                serverStateProvider = new PaperServerStateProvider();
-                containerProvider = new PaperContainerProvider();
-                serializationProvider = new PaperSerializationProvider();
-            } else {
-                serverStateProvider = new ReflServerStateProvider();
-            }
+            // Server State Provider
+            providerFactory.registerProvider(ReflServerStateProvider.class, PaperServerStateProvider.class);
 
-            //Event Providers
-            if (PaperLib.isPaper()) {
-                try {
-                    Class.forName("com.destroystokyo.paper.event.player.PlayerRecipeBookClickEvent");
-                    recipeBookEventProvider = new PaperRecipeBookListener(event -> {
-                        if (this.getUser(((PlayerEvent) event).getPlayer()).isRecipeSee()) {
-                            ((Cancellable) event).setCancelled(true);
-                        }
-                    });
-                } catch (final ClassNotFoundException ignored) {
-                }
-            }
+            // Container Provider
+            providerFactory.registerProvider(PaperContainerProvider.class);
 
-            //Known Commands Provider
-            if (PaperLib.isPaper() && VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_11_2_R01)) {
-                knownCommandsProvider = new PaperKnownCommandsProvider();
-            } else {
-                knownCommandsProvider = new ReflKnownCommandsProvider();
-            }
+            // Serialization Provider
+            providerFactory.registerProvider(PaperSerializationProvider.class);
 
-            // Command aliases provider
-            formattedCommandAliasProvider = new ReflFormattedCommandAliasProvider(PaperLib.isPaper());
+            // Known Commands Provider
+            providerFactory.registerProvider(ReflKnownCommandsProvider.class, PaperKnownCommandsProvider.class);
+
+            // Command Aliases Provider
+            providerFactory.registerProvider(ReflFormattedCommandAliasProvider.class);
 
             // Material Tag Providers
-            if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_13_0_R01)) {
-                materialTagProvider = PaperLib.isPaper() ? new PaperMaterialTagProvider() : new BukkitMaterialTagProvider();
-            }
+            providerFactory.registerProvider(BukkitMaterialTagProvider.class, PaperMaterialTagProvider.class);
 
             // Sync Commands Provider
-            syncCommandsProvider = new ReflSyncCommandsProvider();
+            providerFactory.registerProvider(ReflSyncCommandsProvider.class);
 
-            if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_14_4_R01)) {
-                persistentDataProvider = new ModernPersistentDataProvider(this);
-            } else {
-                persistentDataProvider = new ReflPersistentDataProvider(this);
-            }
+            // Persistent Data Provider
+            providerFactory.registerProvider(ReflPersistentDataProvider.class, ModernPersistentDataProvider.class);
 
-            onlineModeProvider = new ReflOnlineModeProvider();
+            // Online Mode Provider
+            providerFactory.registerProvider(ReflOnlineModeProvider.class);
 
-            if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_11_2_R01)) {
-                unbreakableProvider = new ModernItemUnbreakableProvider();
-            } else {
-                unbreakableProvider = new LegacyItemUnbreakableProvider();
-            }
+            // Unbreakable Provider
+            providerFactory.registerProvider(LegacyItemUnbreakableProvider.class, ModernItemUnbreakableProvider.class);
 
-            if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_17_1_R01)) {
-                worldInfoProvider = new ModernDataWorldInfoProvider();
-            } else if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_16_5_R01)) {
-                worldInfoProvider = new ReflDataWorldInfoProvider();
-            } else {
-                worldInfoProvider = new FixedHeightWorldInfoProvider();
-            }
+            // World Info Provider
+            providerFactory.registerProvider(FixedHeightWorldInfoProvider.class, ReflDataWorldInfoProvider.class, ModernDataWorldInfoProvider.class);
 
-            if (VersionUtil.getServerBukkitVersion().isHigherThanOrEqualTo(VersionUtil.v1_14_4_R01)) {
-                signDataProvider = new ModernSignDataProvider(this);
+            // Sign Data Provider
+            providerFactory.registerProvider(ModernSignDataProvider.class);
+
+            providerFactory.finalizeRegistration();
+
+            // Event Providers
+            if (PaperLib.isPaper()) {
+                try {
+                    Class.forName("com.destroystokyo.paper.event.player.PlayerRecipeBookClickEvent");
+                    recipeBookEventProvider = new PaperRecipeBookListener(event -> {
+                        if (this.getUser(((PlayerEvent) event).getPlayer()).isRecipeSee()) {
+                            ((Cancellable) event).setCancelled(true);
+                        }
+                    });
+                } catch (final ClassNotFoundException ignored) {
+                }
             }
 
             execTimer.mark("Init(Providers)");
@@ -556,9 +499,14 @@ private void registerListeners(final PluginManager pm) {
         jails.resetListener();
     }
 
+    @Override
+    public ProviderFactory getProviders() {
+        return providerFactory;
+    }
+
     @Override
     public void onDisable() {
-        final boolean stopping = getServerStateProvider().isStopping();
+        final boolean stopping = getProviders().get(ServerStateProvider.class).isStopping();
         if (!stopping) {
             LOGGER.log(Level.SEVERE, tl("serverReloading"));
         }
@@ -671,8 +619,8 @@ public List<String> onTabCompleteEssentials(final CommandSender cSender, final C
 
             // Check for disabled commands
             if (getSettings().isCommandDisabled(commandLabel)) {
-                if (getKnownCommandsProvider().getKnownCommands().containsKey(commandLabel)) {
-                    final Command newCmd = getKnownCommandsProvider().getKnownCommands().get(commandLabel);
+                if (getProviders().get(KnownCommandsProvider.class).getKnownCommands().containsKey(commandLabel)) {
+                    final Command newCmd = getProviders().get(KnownCommandsProvider.class).getKnownCommands().get(commandLabel);
                     if (!(newCmd instanceof PluginIdentifiableCommand) || ((PluginIdentifiableCommand) newCmd).getPlugin() != this) {
                         return newCmd.tabComplete(cSender, commandLabel, args);
                     }
@@ -777,8 +725,8 @@ public boolean onCommandEssentials(final CommandSender cSender, final Command co
 
             // Check for disabled commands
             if (getSettings().isCommandDisabled(commandLabel)) {
-                if (getKnownCommandsProvider().getKnownCommands().containsKey(commandLabel)) {
-                    final Command newCmd = getKnownCommandsProvider().getKnownCommands().get(commandLabel);
+                if (getProviders().get(KnownCommandsProvider.class).getKnownCommands().containsKey(commandLabel)) {
+                    final Command newCmd = getProviders().get(KnownCommandsProvider.class).getKnownCommands().get(commandLabel);
                     if (!(newCmd instanceof PluginIdentifiableCommand) || !isEssentialsPlugin(((PluginIdentifiableCommand) newCmd).getPlugin())) {
                         return newCmd.execute(cSender, commandLabel, args);
                     }
@@ -1268,90 +1216,11 @@ public Iterable<User> getOnlineUsers() {
         return onlineUsers;
     }
 
-    @Override
-    public SpawnerItemProvider getSpawnerItemProvider() {
-        return spawnerItemProvider;
-    }
-
-    @Override
-    public SpawnerBlockProvider getSpawnerBlockProvider() {
-        return spawnerBlockProvider;
-    }
-
-    @Override
-    public SpawnEggProvider getSpawnEggProvider() {
-        return spawnEggProvider;
-    }
-
-    @Override
-    public PotionMetaProvider getPotionMetaProvider() {
-        return potionMetaProvider;
-    }
-
     @Override
     public CustomItemResolver getCustomItemResolver() {
         return customItemResolver;
     }
 
-    @Override
-    public ServerStateProvider getServerStateProvider() {
-        return serverStateProvider;
-    }
-
-    public MaterialTagProvider getMaterialTagProvider() {
-        return materialTagProvider;
-    }
-
-    @Override
-    public ContainerProvider getContainerProvider() {
-        return containerProvider;
-    }
-
-    @Override
-    public KnownCommandsProvider getKnownCommandsProvider() {
-        return knownCommandsProvider;
-    }
-
-    @Override
-    public SerializationProvider getSerializationProvider() {
-        return serializationProvider;
-    }
-
-    @Override
-    public FormattedCommandAliasProvider getFormattedCommandAliasProvider() {
-        return formattedCommandAliasProvider;
-    }
-
-    @Override
-    public SyncCommandsProvider getSyncCommandsProvider() {
-        return syncCommandsProvider;
-    }
-
-    @Override
-    public PersistentDataProvider getPersistentDataProvider() {
-        return persistentDataProvider;
-    }
-
-    @Override
-    public ReflOnlineModeProvider getOnlineModeProvider() {
-        return onlineModeProvider;
-    }
-
-    @Override
-    public ItemUnbreakableProvider getItemUnbreakableProvider() {
-        return unbreakableProvider;
-    }
-
-    @Override
-    public WorldInfoProvider getWorldInfoProvider() {
-        return worldInfoProvider;
-    }
-
-    @Override
-    public SignDataProvider getSignDataProvider() {
-        return signDataProvider;
-    }
-
     @Override
     public PluginCommand getPluginCommand(final String cmd) {
         return this.getCommand(cmd);

Essentials/src/main/java/com/earth2me/essentials/EssentialsBlockListener.java

@@ -2,6 +2,8 @@
 
 import com.earth2me.essentials.utils.MaterialUtil;
 import net.ess3.api.IEssentials;
+import net.ess3.provider.PersistentDataProvider;
+import net.ess3.provider.SpawnerItemProvider;
 import org.bukkit.GameMode;
 import org.bukkit.block.BlockState;
 import org.bukkit.block.CreatureSpawner;
@@ -25,11 +27,11 @@ public EssentialsBlockListener(final IEssentials ess) {
     public void onBlockPlace(final BlockPlaceEvent event) {
         final ItemStack is = event.getItemInHand();
 
-        if (is.getType() == MaterialUtil.SPAWNER && ess.getPersistentDataProvider().getString(is, "convert") != null) {
+        if (is.getType() == MaterialUtil.SPAWNER && ess.getProviders().get(PersistentDataProvider.class).getString(is, "convert") != null) {
             final BlockState blockState = event.getBlockPlaced().getState();
             if (blockState instanceof CreatureSpawner) {
                 final CreatureSpawner spawner = (CreatureSpawner) blockState;
-                final EntityType type = ess.getSpawnerItemProvider().getEntityType(event.getItemInHand());
+                final EntityType type = ess.getProviders().get(SpawnerItemProvider.class).getEntityType(event.getItemInHand());
                 if (type != null && Mob.fromBukkitType(type) != null) {
                     if (ess.getUser(event.getPlayer()).isAuthorized("essentials.spawnerconvert." + Mob.fromBukkitType(type).name().toLowerCase(Locale.ENGLISH))) {
                         spawner.setSpawnedType(type);

Essentials/src/main/java/com/earth2me/essentials/EssentialsPlayerListener.java

@@ -14,6 +14,8 @@
 import net.ess3.api.IEssentials;
 import net.ess3.api.events.AfkStatusChangeEvent;
 import net.ess3.provider.CommandSendListenerProvider;
+import net.ess3.provider.FormattedCommandAliasProvider;
+import net.ess3.provider.KnownCommandsProvider;
 import net.ess3.provider.providers.BukkitCommandSendListenerProvider;
 import net.ess3.provider.providers.PaperCommandSendListenerProvider;
 import net.essentialsx.api.v2.events.AsyncUserDataLoadEvent;
@@ -582,10 +584,10 @@ public void onPlayerCommandPreprocess(final PlayerCommandPreprocessEvent event)
 
         // If the plugin command does not exist, check if it is an alias from commands.yml
         if (ess.getServer().getPluginCommand(cmd) == null) {
-            final Command knownCommand = ess.getKnownCommandsProvider().getKnownCommands().get(cmd);
+            final Command knownCommand = ess.getProviders().get(KnownCommandsProvider.class).getKnownCommands().get(cmd);
             if (knownCommand instanceof FormattedCommandAlias) {
                 final FormattedCommandAlias command = (FormattedCommandAlias) knownCommand;
-                for (String fullCommand : ess.getFormattedCommandAliasProvider().createCommands(command, event.getPlayer(), args.split(" "))) {
+                for (String fullCommand : ess.getProviders().get(FormattedCommandAliasProvider.class).createCommands(command, event.getPlayer(), args.split(" "))) {
                     handlePlayerCommandPreprocess(event, fullCommand);
                 }
                 return;