be.seeseemelk.mockbukkit.plugin

Class PluginManagerMock

java.lang.Object

be.seeseemelk.mockbukkit.plugin.PluginManagerMock

All Implemented Interfaces:

org.bukkit.plugin.PluginManager

public class PluginManagerMock
extends java.lang.Object
implements org.bukkit.plugin.PluginManager

Constructor Summary

Constructors

Constructor and Description
PluginManagerMock(@NotNull ServerMock server)

Method Summary

Modifier and Type	Method and Description
protected void	addCommandsFrom(org.bukkit.plugin.Plugin plugin) Add commands from a certain plugin to the internal list of commands.
void	addPermission(@NotNull org.bukkit.permissions.Permission perm)
void	assertEventFired(@NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass) Asserts that a specific event or once of it's sub-events has been fired at least once.
<T extends org.bukkit.event.Event> void	assertEventFired(java.lang.Class<T> eventClass, java.util.function.Predicate<T> predicate) Asserts that there is at least one event of a certain class for which the predicate is true.
void	assertEventFired(@NotNull java.util.function.Predicate<org.bukkit.event.Event> predicate) Asserts that at least one event conforms to the given predicate.
<T extends org.bukkit.event.Event> void	assertEventFired(java.lang.String message, java.lang.Class<T> eventClass, java.util.function.Predicate<T> predicate) Asserts that there is at least one event of a certain class for which the predicate is true.
void	assertEventFired(@NotNull java.lang.String message, @NotNull java.util.function.Predicate<org.bukkit.event.Event> predicate) Asserts that at least one event conforms to the given predicate.
void	callEvent(@NotNull org.bukkit.event.Event event)
void	callEventAsynchronously(@NotNull org.bukkit.event.Event event) This method invokes callEvent(Event) from a different Thread using the BukkitSchedulerMock.
void	clearEvents() This method clears the history of events.
void	clearPlugins()
void	disablePlugin(@NotNull org.bukkit.plugin.Plugin plugin)
void	disablePlugins()
void	enablePlugin(@NotNull org.bukkit.plugin.Plugin plugin)
@NotNull java.util.Collection<org.bukkit.command.PluginCommand>	getCommands() Get a collection of all available commands.
@NotNull java.util.Set<org.bukkit.permissions.Permission>	getDefaultPermissions(boolean op)
@NotNull java.util.Set<org.bukkit.permissions.Permissible>	getDefaultPermSubscriptions(boolean op)
org.bukkit.permissions.Permission	getPermission(@NotNull java.lang.String name)
@NotNull java.util.Set<org.bukkit.permissions.Permission>	getPermissions()
@NotNull java.util.Set<org.bukkit.permissions.Permissible>	getPermissionSubscriptions(@NotNull java.lang.String permission)
org.bukkit.plugin.Plugin	getPlugin(@NotNull java.lang.String name)
org.bukkit.plugin.Plugin[]	getPlugins()
boolean	isPluginEnabled(org.bukkit.plugin.Plugin plugin)
boolean	isPluginEnabled(@NotNull java.lang.String name)
org.bukkit.plugin.java.JavaPlugin	loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1, java.lang.Object[] parameters) Load a plugin from a class.
org.bukkit.plugin.java.JavaPlugin	loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1, org.bukkit.plugin.PluginDescriptionFile description) Load a plugin from a class.
org.bukkit.plugin.java.JavaPlugin	loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1, org.bukkit.plugin.PluginDescriptionFile description, java.lang.Object[] parameters) Load a plugin from a class.
org.bukkit.plugin.Plugin	loadPlugin(@NotNull java.io.File file)
org.bukkit.plugin.Plugin[]	loadPlugins(@NotNull java.io.File directory)
void	recalculatePermissionDefaults(@NotNull org.bukkit.permissions.Permission perm)
void	registerEvent(@NotNull java.lang.Class<? extends org.bukkit.event.Event> event, @NotNull org.bukkit.event.Listener listener, @NotNull org.bukkit.event.EventPriority priority, @NotNull org.bukkit.plugin.EventExecutor executor, @NotNull org.bukkit.plugin.Plugin plugin)
void	registerEvent(@NotNull java.lang.Class<? extends org.bukkit.event.Event> event, @NotNull org.bukkit.event.Listener listener, @NotNull org.bukkit.event.EventPriority priority, @NotNull org.bukkit.plugin.EventExecutor executor, @NotNull org.bukkit.plugin.Plugin plugin, boolean ignoreCancelled)
void	registerEvents(@NotNull org.bukkit.event.Listener listener, @NotNull org.bukkit.plugin.Plugin plugin)
void	registerInterface(@NotNull java.lang.Class<? extends org.bukkit.plugin.PluginLoader> loader)
void	registerLoadedPlugin(@NotNull org.bukkit.plugin.Plugin plugin) Registers a plugin that has already been loaded.
void	removePermission(@NotNull org.bukkit.permissions.Permission perm)
void	removePermission(@NotNull java.lang.String name)
void	subscribeToDefaultPerms(boolean op, @NotNull org.bukkit.permissions.Permissible permissible)
void	subscribeToPermission(@NotNull java.lang.String permission, @NotNull org.bukkit.permissions.Permissible permissible)
void	unload() Should be called when the plugin manager is not used anymore.
void	unsubscribeFromDefaultPerms(boolean op, @NotNull org.bukkit.permissions.Permissible permissible)
void	unsubscribeFromPermission(@NotNull java.lang.String permission, @NotNull org.bukkit.permissions.Permissible permissible)
boolean	useTimings() Timings are used for event timings on a live server - they serve no purpose during a artificial test environ.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginManagerMock

public PluginManagerMock(@NotNull
                         @NotNull ServerMock server)

Method Detail

unload

public void unload()

Should be called when the plugin manager is not used anymore.

assertEventFired

public void assertEventFired(@NotNull
                             @NotNull java.lang.String message,
                             @NotNull
                             @NotNull java.util.function.Predicate<org.bukkit.event.Event> predicate)

Asserts that at least one event conforms to the given predicate.

Parameters:

message - The message to display when no event conforms.

predicate - The predicate to test against.

assertEventFired

public void assertEventFired(@NotNull
                             @NotNull java.util.function.Predicate<org.bukkit.event.Event> predicate)

Asserts that at least one event conforms to the given predicate.

Parameters:

predicate - The predicate to test against.

assertEventFired

public <T extends org.bukkit.event.Event> void assertEventFired(java.lang.String message,
                                                                java.lang.Class<T> eventClass,
                                                                java.util.function.Predicate<T> predicate)

Asserts that there is at least one event of a certain class for which the predicate is true.

Type Parameters:

T - The type of event that is expected.

Parameters:

message - The message to display if no event is found.

eventClass - The class type that the event should be an instance of.

predicate - The predicate to test the event against.

assertEventFired

public <T extends org.bukkit.event.Event> void assertEventFired(java.lang.Class<T> eventClass,
                                                                java.util.function.Predicate<T> predicate)

Asserts that there is at least one event of a certain class for which the predicate is true.

Type Parameters:

T - The type of event that is expected.

Parameters:

eventClass - The class type that the event should be an instance of.

predicate - The predicate to test the event against.

assertEventFired

public void assertEventFired(@NotNull
                             @NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass)

Asserts that a specific event or once of it's sub-events has been fired at least once.

Parameters:

eventClass - The class of the event to check for.

getPlugin

public org.bukkit.plugin.Plugin getPlugin(@NotNull
                                          @NotNull java.lang.String name)

Specified by:

getPlugin in interface org.bukkit.plugin.PluginManager

getPlugins

public org.bukkit.plugin.Plugin[] getPlugins()

Specified by:

getPlugins in interface org.bukkit.plugin.PluginManager

getCommands

@NotNull
public @NotNull java.util.Collection<org.bukkit.command.PluginCommand> getCommands()

Get a collection of all available commands.

Returns:

A collection of all available commands.

registerLoadedPlugin

public void registerLoadedPlugin(@NotNull
                                 @NotNull org.bukkit.plugin.Plugin plugin)

Registers a plugin that has already been loaded. This is necessary to register plugins loaded from external jars.

Parameters:

plugin - The plugin that has been loaded.

loadPlugin

public org.bukkit.plugin.java.JavaPlugin loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1,
                                                    org.bukkit.plugin.PluginDescriptionFile description,
                                                    java.lang.Object[] parameters)

Load a plugin from a class. It will use the system resource plugin.yml as the resource file.

Parameters:

description - The PluginDescriptionFile that contains information about the plugin.

class1 - The plugin to load.

parameters - Extra parameters to pass on to the plugin constructor. Must not be null.

Returns:

The loaded plugin.

loadPlugin

public org.bukkit.plugin.java.JavaPlugin loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1,
                                                    org.bukkit.plugin.PluginDescriptionFile description)

Load a plugin from a class. It will use the system resource plugin.yml as the resource file.

Parameters:

description - The PluginDescriptionFile that contains information about the plugin.

class1 - The plugin to load.

Returns:

The loaded plugin.

loadPlugin

public org.bukkit.plugin.java.JavaPlugin loadPlugin(java.lang.Class<? extends org.bukkit.plugin.java.JavaPlugin> class1,
                                                    java.lang.Object[] parameters)

Load a plugin from a class. It will use the system resource plugin.yml as the resource file.

Parameters:

class1 - The plugin to load.

parameters - Extra parameters to pass on to the plugin constructor.

Returns:

The loaded plugin.

callEvent

public void callEvent(@NotNull
                      @NotNull org.bukkit.event.Event event)

Specified by:

callEvent in interface org.bukkit.plugin.PluginManager

callEventAsynchronously

public void callEventAsynchronously(@NotNull
                                    @NotNull org.bukkit.event.Event event)

This method invokes callEvent(Event) from a different Thread using the BukkitSchedulerMock.

Parameters:

event - The asynchronous Event to call.

enablePlugin

public void enablePlugin(@NotNull
                         @NotNull org.bukkit.plugin.Plugin plugin)

Specified by:

enablePlugin in interface org.bukkit.plugin.PluginManager

addCommandsFrom

protected void addCommandsFrom(org.bukkit.plugin.Plugin plugin)

Add commands from a certain plugin to the internal list of commands.

Parameters:

plugin - The plugin from which to read commands.

registerInterface

public void registerInterface(@NotNull
                              @NotNull java.lang.Class<? extends org.bukkit.plugin.PluginLoader> loader)
                       throws java.lang.IllegalArgumentException

Specified by:

registerInterface in interface org.bukkit.plugin.PluginManager

Throws:

java.lang.IllegalArgumentException

isPluginEnabled

public boolean isPluginEnabled(@NotNull
                               @NotNull java.lang.String name)

Specified by:

isPluginEnabled in interface org.bukkit.plugin.PluginManager

isPluginEnabled

public boolean isPluginEnabled(org.bukkit.plugin.Plugin plugin)

Specified by:

isPluginEnabled in interface org.bukkit.plugin.PluginManager

loadPlugin

public org.bukkit.plugin.Plugin loadPlugin(@NotNull
                                           @NotNull java.io.File file)
                                    throws org.bukkit.plugin.InvalidPluginException,
                                           org.bukkit.plugin.InvalidDescriptionException,
                                           org.bukkit.plugin.UnknownDependencyException

Specified by:

loadPlugin in interface org.bukkit.plugin.PluginManager

Throws:

org.bukkit.plugin.InvalidPluginException

org.bukkit.plugin.InvalidDescriptionException

org.bukkit.plugin.UnknownDependencyException

loadPlugins

public org.bukkit.plugin.Plugin[] loadPlugins(@NotNull
                                              @NotNull java.io.File directory)

Specified by:

loadPlugins in interface org.bukkit.plugin.PluginManager

disablePlugins

public void disablePlugins()

Specified by:

disablePlugins in interface org.bukkit.plugin.PluginManager

clearPlugins

public void clearPlugins()

Specified by:

clearPlugins in interface org.bukkit.plugin.PluginManager

clearEvents

public void clearEvents()

This method clears the history of events. Doing that can be very useful if you want to assert fresh events using assertEventFired(Class) or similar.

registerEvents

public void registerEvents(@NotNull
                           @NotNull org.bukkit.event.Listener listener,
                           @NotNull
                           @NotNull org.bukkit.plugin.Plugin plugin)

Specified by:

registerEvents in interface org.bukkit.plugin.PluginManager

registerEvent

public void registerEvent(@NotNull
                          @NotNull java.lang.Class<? extends org.bukkit.event.Event> event,
                          @NotNull
                          @NotNull org.bukkit.event.Listener listener,
                          @NotNull
                          @NotNull org.bukkit.event.EventPriority priority,
                          @NotNull
                          @NotNull org.bukkit.plugin.EventExecutor executor,
                          @NotNull
                          @NotNull org.bukkit.plugin.Plugin plugin)

Specified by:

registerEvent in interface org.bukkit.plugin.PluginManager

registerEvent

public void registerEvent(@NotNull
                          @NotNull java.lang.Class<? extends org.bukkit.event.Event> event,
                          @NotNull
                          @NotNull org.bukkit.event.Listener listener,
                          @NotNull
                          @NotNull org.bukkit.event.EventPriority priority,
                          @NotNull
                          @NotNull org.bukkit.plugin.EventExecutor executor,
                          @NotNull
                          @NotNull org.bukkit.plugin.Plugin plugin,
                          boolean ignoreCancelled)

Specified by:

registerEvent in interface org.bukkit.plugin.PluginManager

disablePlugin

public void disablePlugin(@NotNull
                          @NotNull org.bukkit.plugin.Plugin plugin)

Specified by:

disablePlugin in interface org.bukkit.plugin.PluginManager

getPermission

public org.bukkit.permissions.Permission getPermission(@NotNull
                                                       @NotNull java.lang.String name)

Specified by:

getPermission in interface org.bukkit.plugin.PluginManager

addPermission

public void addPermission(@NotNull
                          @NotNull org.bukkit.permissions.Permission perm)

Specified by:

addPermission in interface org.bukkit.plugin.PluginManager

removePermission

public void removePermission(@NotNull
                             @NotNull org.bukkit.permissions.Permission perm)

Specified by:

removePermission in interface org.bukkit.plugin.PluginManager

removePermission

public void removePermission(@NotNull
                             @NotNull java.lang.String name)

Specified by:

removePermission in interface org.bukkit.plugin.PluginManager

getDefaultPermissions

@NotNull
public @NotNull java.util.Set<org.bukkit.permissions.Permission> getDefaultPermissions(boolean op)

Specified by:

getDefaultPermissions in interface org.bukkit.plugin.PluginManager

recalculatePermissionDefaults

public void recalculatePermissionDefaults(@NotNull
                                          @NotNull org.bukkit.permissions.Permission perm)

Specified by:

recalculatePermissionDefaults in interface org.bukkit.plugin.PluginManager

subscribeToPermission

public void subscribeToPermission(@NotNull
                                  @NotNull java.lang.String permission,
                                  @NotNull
                                  @NotNull org.bukkit.permissions.Permissible permissible)

Specified by:

subscribeToPermission in interface org.bukkit.plugin.PluginManager

unsubscribeFromPermission

public void unsubscribeFromPermission(@NotNull
                                      @NotNull java.lang.String permission,
                                      @NotNull
                                      @NotNull org.bukkit.permissions.Permissible permissible)

Specified by:

unsubscribeFromPermission in interface org.bukkit.plugin.PluginManager

getPermissionSubscriptions

@NotNull
public @NotNull java.util.Set<org.bukkit.permissions.Permissible> getPermissionSubscriptions(@NotNull
                                                                                                      @NotNull java.lang.String permission)

Specified by:

getPermissionSubscriptions in interface org.bukkit.plugin.PluginManager

subscribeToDefaultPerms

public void subscribeToDefaultPerms(boolean op,
                                    @NotNull
                                    @NotNull org.bukkit.permissions.Permissible permissible)

Specified by:

subscribeToDefaultPerms in interface org.bukkit.plugin.PluginManager

unsubscribeFromDefaultPerms

public void unsubscribeFromDefaultPerms(boolean op,
                                        @NotNull
                                        @NotNull org.bukkit.permissions.Permissible permissible)

Specified by:

unsubscribeFromDefaultPerms in interface org.bukkit.plugin.PluginManager

getDefaultPermSubscriptions

@NotNull
public @NotNull java.util.Set<org.bukkit.permissions.Permissible> getDefaultPermSubscriptions(boolean op)

Specified by:

getDefaultPermSubscriptions in interface org.bukkit.plugin.PluginManager

getPermissions

@NotNull
public @NotNull java.util.Set<org.bukkit.permissions.Permission> getPermissions()

Specified by:

getPermissions in interface org.bukkit.plugin.PluginManager

useTimings

public boolean useTimings()

Timings are used for event timings on a live server - they serve no purpose during a artificial test environ.

Specified by:

useTimings in interface org.bukkit.plugin.PluginManager

Returns:

boolean.false