Class SimplePluginManager
- All Implemented Interfaces:
PermissionManager
,PluginManager
-
Field Summary
Modifier and TypeFieldDescriptionfinal Map
<Boolean, Set<Permission>> Deprecated, for removal: This API element is subject to removal in a future version.final Map
<Boolean, Map<Permissible, Boolean>> Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.final Map
<String, Permission> Deprecated, for removal: This API element is subject to removal in a future version.final Map
<String, Map<Permissible, Boolean>> Deprecated, for removal: This API element is subject to removal in a future version. -
Constructor Summary
ConstructorDescriptionSimplePluginManager
(@NotNull Server instance, @NotNull SimpleCommandMap commandMap) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPermission
(@NotNull Permission perm) Deprecated, for removal: This API element is subject to removal in a future version.Adds aPermission
to this plugin manager.void
addPermission
(@NotNull Permission perm, boolean dirty) Deprecated.void
addPermissions
(@NotNull List<Permission> perm) Deprecated, for removal: This API element is subject to removal in a future version.Adds a list of permissions.void
Deprecated, for removal: This API element is subject to removal in a future version.Calls an event with the given details.void
Deprecated, for removal: This API element is subject to removal in a future version.Clears the current registered permissinos.void
Deprecated, for removal: This API element is subject to removal in a future version.Disables and removes all pluginsvoid
Deprecated.void
disablePlugin
(@NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Disables the specified pluginvoid
Deprecated, for removal: This API element is subject to removal in a future version.Disables all the loaded pluginsvoid
enablePlugin
(@NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Enables the specified plugingetDefaultPermissions
(boolean op) Deprecated, for removal: This API element is subject to removal in a future version.Gets the default permissions for the given op statusgetDefaultPermSubscriptions
(boolean op) Deprecated, for removal: This API element is subject to removal in a future version.Gets a set containing all subscribedPermissible
s to the given default list, by op statusgetPermission
(@NotNull String name) Deprecated, for removal: This API element is subject to removal in a future version.Gets aPermission
from its fully qualified nameDeprecated, for removal: This API element is subject to removal in a future version.Gets a set of all registered permissions.getPermissionSubscriptions
(@NotNull String permission) Deprecated, for removal: This API element is subject to removal in a future version.Gets a set containing all subscribedPermissible
s to the given permission, by nameDeprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is loaded and returns it when applicableDeprecated, for removal: This API element is subject to removal in a future version.Gets a list of all currently loaded pluginsboolean
isPluginEnabled
(@NotNull String name) Deprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is enabled or notboolean
isPluginEnabled
(@Nullable Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is enabled or notboolean
isTransitiveDepend
(@NotNull PluginDescriptionFile plugin, @NotNull PluginDescriptionFile depend) Deprecated, for removal: This API element is subject to removal in a future version.boolean
isTransitiveDependency
(PluginMeta pluginMeta, PluginMeta dependencyConfig) Deprecated, for removal: This API element is subject to removal in a future version.loadPlugin
(@NotNull File file) Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugin in the specified fileloadPlugins
(@NotNull File directory) Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugins contained within the specified directoryloadPlugins
(@NotNull File[] files) Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugins in the list of the filesDeprecated, for removal: This API element is subject to removal in a future version.void
overridePermissionManager
(@NotNull Plugin plugin, PermissionManager permissionManager) Deprecated, for removal: This API element is subject to removal in a future version.Sets the permission manager to be used for this server.void
Deprecated, for removal: This API element is subject to removal in a future version.Recalculates the defaults for the givenPermission
.void
registerEvent
(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Registers the specified executor to the given event classvoid
registerEvent
(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin, boolean ignoreCancelled) Deprecated, for removal: This API element is subject to removal in a future version.Registers the given event to the specified listener using a directly passed EventExecutorvoid
registerEvents
(@NotNull Listener listener, @NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Registers all the events in the given listener classvoid
registerInterface
(@NotNull Class<? extends PluginLoader> loader) Deprecated, for removal: This API element is subject to removal in a future version.Registers the specified plugin loadervoid
removePermission
(@NotNull String name) Deprecated, for removal: This API element is subject to removal in a future version.Removes aPermission
registration from this plugin manager.void
Deprecated, for removal: This API element is subject to removal in a future version.Removes aPermission
registration from this plugin manager.void
subscribeToDefaultPerms
(boolean op, @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Subscribes to the given Default permissions by operator statusvoid
subscribeToPermission
(@NotNull String permission, @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Subscribes the given Permissible for information about the requested Permission, by name.void
unsubscribeFromDefaultPerms
(boolean op, @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Unsubscribes from the given Default permissions by operator statusvoid
unsubscribeFromPermission
(@NotNull String permission, @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Unsubscribes the given Permissible for information about the requested Permission, by name.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Returns whether or not timing code should be used for event callsvoid
useTimings
(boolean use) Deprecated, for removal: This API element is subject to removal in a future version.
-
Field Details
-
permissions
Deprecated, for removal: This API element is subject to removal in a future version. -
defaultPerms
Deprecated, for removal: This API element is subject to removal in a future version. -
permSubs
Deprecated, for removal: This API element is subject to removal in a future version. -
defSubs
Deprecated, for removal: This API element is subject to removal in a future version. -
paperPluginManager
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Constructor Details
-
Method Details
-
registerInterface
public void registerInterface(@NotNull @NotNull Class<? extends PluginLoader> loader) throws IllegalArgumentException Deprecated, for removal: This API element is subject to removal in a future version.Registers the specified plugin loader- Specified by:
registerInterface
in interfacePluginManager
- Parameters:
loader
- Class name of the PluginLoader to register- Throws:
IllegalArgumentException
- Thrown when the given Class is not a valid PluginLoader
-
loadPlugins
Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugins contained within the specified directory- Specified by:
loadPlugins
in interfacePluginManager
- Parameters:
directory
- Directory to check for plugins- Returns:
- A list of all plugins loaded
-
loadPlugins
@NotNull public @NotNull Plugin[] loadPlugins(@NotNull @NotNull File directory, @NotNull @NotNull List<File> extraPluginJars) Deprecated, for removal: This API element is subject to removal in a future version. -
loadPlugins
Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugins in the list of the files- Specified by:
loadPlugins
in interfacePluginManager
- Parameters:
files
- List of files containing plugins to load- Returns:
- A list of all plugins loaded
-
loadPlugin
@Nullable public @Nullable Plugin loadPlugin(@NotNull @NotNull File file) throws InvalidPluginException, UnknownDependencyException Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugin in the specified fileFile must be valid according to the current enabled Plugin interfaces
- Specified by:
loadPlugin
in interfacePluginManager
- Parameters:
file
- File containing the plugin to load- Returns:
- The Plugin loaded, or null if it was invalid
- Throws:
InvalidPluginException
- Thrown when the specified file is not a valid pluginUnknownDependencyException
- If a required dependency could not be found
-
getPlugin
Deprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is loaded and returns it when applicablePlease note that the name of the plugin is case-sensitive
- Specified by:
getPlugin
in interfacePluginManager
- Parameters:
name
- Name of the plugin to check- Returns:
- Plugin if it exists, otherwise null
-
getPlugins
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets a list of all currently loaded plugins- Specified by:
getPlugins
in interfacePluginManager
- Returns:
- Array of Plugins
-
isPluginEnabled
Deprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is enabled or notPlease note that the name of the plugin is case-sensitive.
- Specified by:
isPluginEnabled
in interfacePluginManager
- Parameters:
name
- Name of the plugin to check- Returns:
- true if the plugin is enabled, otherwise false
-
isPluginEnabled
Deprecated, for removal: This API element is subject to removal in a future version.Checks if the given plugin is enabled or not- Specified by:
isPluginEnabled
in interfacePluginManager
- Parameters:
plugin
- Plugin to check- Returns:
- true if the plugin is enabled, otherwise false
-
enablePlugin
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Enables the specified pluginAttempting to enable a plugin that is already enabled will have no effect
- Specified by:
enablePlugin
in interfacePluginManager
- Parameters:
plugin
- Plugin to enable
-
disablePlugins
public void disablePlugins()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Disables all the loaded plugins- Specified by:
disablePlugins
in interfacePluginManager
-
disablePlugin
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Disables the specified pluginAttempting to disable a plugin that is not enabled will have no effect
- Specified by:
disablePlugin
in interfacePluginManager
- Parameters:
plugin
- Plugin to disable
-
clearPlugins
public void clearPlugins()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Disables and removes all plugins- Specified by:
clearPlugins
in interfacePluginManager
-
callEvent
Deprecated, for removal: This API element is subject to removal in a future version.Calls an event with the given details.- Specified by:
callEvent
in interfacePluginManager
- Parameters:
event
- Event details
-
registerEvents
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Registers all the events in the given listener class- Specified by:
registerEvents
in interfacePluginManager
- Parameters:
listener
- Listener to registerplugin
- Plugin to register
-
registerEvent
public void registerEvent(@NotNull @NotNull Class<? extends Event> event, @NotNull @NotNull Listener listener, @NotNull @NotNull EventPriority priority, @NotNull @NotNull EventExecutor executor, @NotNull @NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Registers the specified executor to the given event class- Specified by:
registerEvent
in interfacePluginManager
- Parameters:
event
- Event type to registerlistener
- Listener to registerpriority
- Priority to register this event atexecutor
- EventExecutor to registerplugin
- Plugin to register
-
registerEvent
public void registerEvent(@NotNull @NotNull Class<? extends Event> event, @NotNull @NotNull Listener listener, @NotNull @NotNull EventPriority priority, @NotNull @NotNull EventExecutor executor, @NotNull @NotNull Plugin plugin, boolean ignoreCancelled) Deprecated, for removal: This API element is subject to removal in a future version.Registers the given event to the specified listener using a directly passed EventExecutor- Specified by:
registerEvent
in interfacePluginManager
- Parameters:
event
- Event class to registerlistener
- PlayerListener to registerpriority
- Priority of this eventexecutor
- EventExecutor to registerplugin
- Plugin to registerignoreCancelled
- Do not call executor if event was already cancelled
-
getPermission
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets aPermission
from its fully qualified name- Specified by:
getPermission
in interfacePermissionManager
- Specified by:
getPermission
in interfacePluginManager
- Parameters:
name
- Name of the permission- Returns:
- Permission, or null if none
-
addPermission
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Adds aPermission
to this plugin manager.If a permission is already defined with the given name of the new permission, an exception will be thrown.
- Specified by:
addPermission
in interfacePermissionManager
- Specified by:
addPermission
in interfacePluginManager
- Parameters:
perm
- Permission to add
-
addPermission
Deprecated. -
getDefaultPermissions
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets the default permissions for the given op status- Specified by:
getDefaultPermissions
in interfacePermissionManager
- Specified by:
getDefaultPermissions
in interfacePluginManager
- Parameters:
op
- Which set of default permissions to get- Returns:
- The default permissions
-
removePermission
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Removes aPermission
registration from this plugin manager.If the specified permission does not exist in this plugin manager, nothing will happen.
Removing a permission registration will not remove the permission from any
Permissible
s that have it.- Specified by:
removePermission
in interfacePermissionManager
- Specified by:
removePermission
in interfacePluginManager
- Parameters:
perm
- Permission to remove
-
removePermission
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Removes aPermission
registration from this plugin manager.If the specified permission does not exist in this plugin manager, nothing will happen.
Removing a permission registration will not remove the permission from any
Permissible
s that have it.- Specified by:
removePermission
in interfacePermissionManager
- Specified by:
removePermission
in interfacePluginManager
- Parameters:
name
- Permission to remove
-
recalculatePermissionDefaults
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Recalculates the defaults for the givenPermission
.This will have no effect if the specified permission is not registered here.
- Specified by:
recalculatePermissionDefaults
in interfacePermissionManager
- Specified by:
recalculatePermissionDefaults
in interfacePluginManager
- Parameters:
perm
- Permission to recalculate
-
dirtyPermissibles
Deprecated. -
subscribeToPermission
public void subscribeToPermission(@NotNull @NotNull String permission, @NotNull @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Subscribes the given Permissible for information about the requested Permission, by name.If the specified Permission changes in any form, the Permissible will be asked to recalculate.
- Specified by:
subscribeToPermission
in interfacePermissionManager
- Specified by:
subscribeToPermission
in interfacePluginManager
- Parameters:
permission
- Permission to subscribe topermissible
- Permissible subscribing
-
unsubscribeFromPermission
public void unsubscribeFromPermission(@NotNull @NotNull String permission, @NotNull @NotNull Permissible permissible) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Unsubscribes the given Permissible for information about the requested Permission, by name.- Specified by:
unsubscribeFromPermission
in interfacePermissionManager
- Specified by:
unsubscribeFromPermission
in interfacePluginManager
- Parameters:
permission
- Permission to unsubscribe frompermissible
- Permissible subscribing
-
getPermissionSubscriptions
@NotNull public @NotNull Set<Permissible> getPermissionSubscriptions(@NotNull @NotNull String permission) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets a set containing all subscribedPermissible
s to the given permission, by name- Specified by:
getPermissionSubscriptions
in interfacePermissionManager
- Specified by:
getPermissionSubscriptions
in interfacePluginManager
- Parameters:
permission
- Permission to query for- Returns:
- Set containing all subscribed permissions
-
subscribeToDefaultPerms
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Subscribes to the given Default permissions by operator statusIf the specified defaults change in any form, the Permissible will be asked to recalculate.
- Specified by:
subscribeToDefaultPerms
in interfacePermissionManager
- Specified by:
subscribeToDefaultPerms
in interfacePluginManager
- Parameters:
op
- Default list to subscribe topermissible
- Permissible subscribing
-
unsubscribeFromDefaultPerms
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Unsubscribes from the given Default permissions by operator status- Specified by:
unsubscribeFromDefaultPerms
in interfacePermissionManager
- Specified by:
unsubscribeFromDefaultPerms
in interfacePluginManager
- Parameters:
op
- Default list to unsubscribe frompermissible
- Permissible subscribing
-
getDefaultPermSubscriptions
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets a set containing all subscribedPermissible
s to the given default list, by op status- Specified by:
getDefaultPermSubscriptions
in interfacePermissionManager
- Specified by:
getDefaultPermSubscriptions
in interfacePluginManager
- Parameters:
op
- Default list to query for- Returns:
- Set containing all subscribed permissions
-
getPermissions
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Gets a set of all registered permissions.This set is a copy and will not be modified live.
- Specified by:
getPermissions
in interfacePermissionManager
- Specified by:
getPermissions
in interfacePluginManager
- Returns:
- Set containing all current registered permissions
-
isTransitiveDepend
public boolean isTransitiveDepend(@NotNull @NotNull PluginDescriptionFile plugin, @NotNull @NotNull PluginDescriptionFile depend) Deprecated, for removal: This API element is subject to removal in a future version. -
useTimings
public boolean useTimings()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Returns whether or not timing code should be used for event calls- Specified by:
useTimings
in interfacePluginManager
- Returns:
- True if event timings are to be used
-
useTimings
Deprecated, for removal: This API element is subject to removal in a future version.Sets whether or not per event timing code should be used- Parameters:
use
- True if per event timing code should be used
-
clearPermissions
public void clearPermissions()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PermissionManager
Clears the current registered permissinos.This is used for reloading.
- Specified by:
clearPermissions
in interfacePermissionManager
-
isTransitiveDependency
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
isTransitiveDependency
in interfacePluginManager
-
overridePermissionManager
public void overridePermissionManager(@NotNull @NotNull Plugin plugin, @Nullable PermissionManager permissionManager) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PluginManager
Sets the permission manager to be used for this server.- Specified by:
overridePermissionManager
in interfacePluginManager
- Parameters:
permissionManager
- permission manager
-
addPermissions
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PermissionManager
Adds a list of permissions.This is meant as an optimization for adding multiple permissions without recalculating each permission.
- Specified by:
addPermissions
in interfacePermissionManager
- Parameters:
perm
- permission
-