Package be.seeseemelk.mockbukkit.plugin

Class PluginManagerMock

java.lang.Object

be.seeseemelk.mockbukkit.PermissionManagerMock

be.seeseemelk.mockbukkit.plugin.PluginManagerMock

All Implemented Interfaces:

PermissionManager, PluginManager

public class PluginManagerMock
extends PermissionManagerMock
implements PluginManager

Mock implementation of a PluginManager.

Constructor Summary

Constructors

Constructor	Description
PluginManagerMock(@NotNull ServerMock server)	Constructs a new PluginManagerMock for the provided ServerMock.

Method Summary

Modifier and Type	Method	Description
protected void	addCommandsFrom(@NotNull Plugin plugin)	Add commands from a certain plugin to the internal list of commands.
void	addPermission(@NotNull Permission perm)
void	assertEventFired(@NotNull Class<? extends Event> eventClass)	Asserts that a specific event or one of it's sub-events has been fired at least once.
<T extends Event> void	assertEventFired(@NotNull Class<T> eventClass, @NotNull Predicate<T> predicate)	Asserts that there is at least one event of a certain class for which the predicate is true.
void	assertEventFired(@NotNull Predicate<Event> predicate)	Asserts that at least one event conforms to the given predicate.
<T extends Event> void	assertEventFired(@Nullable String message, @NotNull Class<T> eventClass, @NotNull Predicate<T> predicate)	Asserts that there is at least one event of a certain class for which the predicate is true.
void	assertEventFired(@Nullable String message, @NotNull Predicate<Event> predicate)	Asserts that at least one event conforms to the given predicate.
void	assertEventNotFired(@NotNull Class<? extends Event> eventClass)	Asserts that a specific event or one of it's sub-event has not been fired.
void	assertEventNotFired(@NotNull Class<? extends Event> eventClass, @Nullable String message)	Asserts that a specific event or one of it's sub-event has not been fired.
void	callEvent(@NotNull Event event)
void	callEventAsynchronously(@NotNull Event event)	This method invokes callEvent(Event) from a different Thread using the BukkitSchedulerMock.
<T extends Event> void	callEventAsynchronously(T event, @Nullable Consumer<T> func)	This method invokes callEvent(Event) from a different Thread using the BukkitSchedulerMock.
void	clearEvents()	This method clears the history of events.
void	clearPlugins()
@NotNull File	createTemporaryDirectory(@NotNull String name)	Tries to create a temporary directory.
@NotNull File	createTemporaryPluginFile(@NotNull String name)	Tries to create a temporary plugin file.
void	disablePlugin(@NotNull Plugin plugin)
void	disablePlugins()
void	enablePlugin(@NotNull Plugin plugin)
@NotNull Collection<PluginCommand>	getCommands()	Get a collection of all available commands.
@NotNull Set<Permission>	getDefaultPermissions(boolean op)
@NotNull Set<Permissible>	getDefaultPermSubscriptions(boolean op)
@NotNull File	getParentTemporaryDirectory()	Creates a new unique temporary directory.
Permission	getPermission(@NotNull String name)
@NotNull Set<Permission>	getPermissions()
@NotNull Set<Permissible>	getPermissionSubscriptions(@NotNull String permission)
Plugin	getPlugin(@NotNull String name)
Plugin @NotNull []	getPlugins()
boolean	isPluginEnabled(@NotNull String name)
boolean	isPluginEnabled(@Nullable Plugin plugin)
boolean	isTransitiveDependency(PluginMeta pluginMeta, PluginMeta dependencyConfig)
Plugin	loadPlugin(@NotNull File file)
@NotNull JavaPlugin	loadPlugin(@NotNull Class<? extends JavaPlugin> class1, @NotNull PluginDescriptionFile description, @NotNull Object @NotNull [] parameters)	Load a plugin from a class.
@NotNull JavaPlugin	loadPlugin(@NotNull Class<? extends JavaPlugin> class1, Object @NotNull [] parameters)	Load a plugin from a class.
Plugin[]	loadPlugins(@NotNull File directory)
void	overridePermissionManager(@NotNull Plugin plugin, @Nullable PermissionManager permissionManager)
void	recalculatePermissionDefaults(@NotNull Permission perm)
void	registerEvent(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin)
void	registerEvent(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin, boolean ignoreCancelled)
void	registerEvents(@NotNull Listener listener, @NotNull Plugin plugin)
void	registerInterface(@NotNull Class<? extends PluginLoader> loader)
void	registerLoadedPlugin(@NotNull Plugin plugin)	Registers a plugin that has already been loaded.
void	removePermission(@NotNull String name)
void	removePermission(@NotNull Permission perm)
void	subscribeToDefaultPerms(boolean op, @NotNull Permissible permissible)
void	subscribeToPermission(@NotNull String permission, @NotNull Permissible permissible)
void	unload()	Should be called when the plugin manager is not used anymore.
void	unregisterPluginEvents(@NotNull Plugin plugin)	Unregisters all listeners for a plugin.
void	unsubscribeFromDefaultPerms(boolean op, @NotNull Permissible permissible)
void	unsubscribeFromPermission(@NotNull String permission, @NotNull 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 be.seeseemelk.mockbukkit.PermissionManagerMock

addPermissions, clearPermissions

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.papermc.paper.plugin.PermissionManager

addPermissions, clearPermissions

Constructor Details

PluginManagerMock

@Internal
public PluginManagerMock(@NotNull
 @NotNull ServerMock server)

Constructs a new PluginManagerMock for the provided ServerMock.

Parameters:

server - The server this is for.

Method Details

unload

public void unload()

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

assertEventFired

public void assertEventFired(@Nullable
 @Nullable String message,
 @NotNull
 @NotNull Predicate<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 Predicate<Event> predicate)

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

Parameters:

predicate - The predicate to test against.

assertEventFired

public <T extends Event> void assertEventFired(@Nullable
 @Nullable String message,
 @NotNull
 @NotNull Class<T> eventClass,
 @NotNull
 @NotNull 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 Event> void assertEventFired(@NotNull
 @NotNull Class<T> eventClass,
 @NotNull
 @NotNull 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 Class<? extends Event> eventClass)

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

Parameters:

eventClass - The class of the event to check for.

assertEventNotFired

public void assertEventNotFired(@NotNull
 @NotNull Class<? extends Event> eventClass)

Asserts that a specific event or one of it's sub-event has not been fired.

Parameters:

eventClass - The class of the event to check for.

assertEventNotFired

public void assertEventNotFired(@NotNull
 @NotNull Class<? extends Event> eventClass,
 @Nullable
 @Nullable String message)

Asserts that a specific event or one of it's sub-event has not been fired.

Parameters:

eventClass - The class of the event to check for.

message - The message to print when failed.

getPlugin

public Plugin getPlugin(@NotNull
 @NotNull String name)

Specified by:

getPlugin in interface PluginManager

getPlugins

public Plugin @NotNull [] getPlugins()

Specified by:

getPlugins in interface PluginManager

getCommands

@NotNull
public @NotNull Collection<PluginCommand> getCommands()

Get a collection of all available commands.

Returns:

A collection of all available commands.

getParentTemporaryDirectory

@NotNull
public @NotNull File getParentTemporaryDirectory()
                                          throws IOException

Creates a new unique temporary directory.

Returns:

The directory.

Throws:

IOException - If an IO error occurs.

createTemporaryDirectory

@NotNull
public @NotNull File createTemporaryDirectory(@NotNull
 @NotNull String name)
                                       throws IOException

Tries to create a temporary directory.

Parameters:

name - The name of the directory to create.

Returns:

The created temporary directory.

Throws:

IOException - when the directory could not be created.

createTemporaryPluginFile

@NotNull
public @NotNull File createTemporaryPluginFile(@NotNull
 @NotNull String name)
                                        throws IOException

Tries to create a temporary plugin file.

Parameters:

name - The name of the plugin.

Returns:

The created temporary file.

Throws:

IOException - when the file could not be created.

registerLoadedPlugin

public void registerLoadedPlugin(@NotNull
 @NotNull 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

@NotNull
public @NotNull JavaPlugin loadPlugin(@NotNull
 @NotNull Class<? extends JavaPlugin> class1,
 @NotNull
 @NotNull PluginDescriptionFile description,
 @NotNull
 @NotNull Object @NotNull [] 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

@NotNull
public @NotNull JavaPlugin loadPlugin(@NotNull
 @NotNull Class<? extends JavaPlugin> class1,
 Object @NotNull [] 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 Event event)

Specified by:

callEvent in interface PluginManager

callEventAsynchronously

public void callEventAsynchronously(@NotNull
 @NotNull Event event)

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

Parameters:

event - The asynchronous Event to call.

callEventAsynchronously

public <T extends Event> void callEventAsynchronously(@NotNull
 T event,
 @Nullable
 @Nullable Consumer<T> func)

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

Type Parameters:

T - The event type.

Parameters:

event - The asynchronous Event to call.

func - A function to invoke after the event has been called.

enablePlugin

public void enablePlugin(@NotNull
 @NotNull Plugin plugin)

Specified by:

enablePlugin in interface PluginManager

addCommandsFrom

protected void addCommandsFrom(@NotNull
 @NotNull 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 Class<? extends PluginLoader> loader)
                       throws IllegalArgumentException

Specified by:

registerInterface in interface PluginManager

Throws:

IllegalArgumentException

isPluginEnabled

public boolean isPluginEnabled(@NotNull
 @NotNull String name)

Specified by:

isPluginEnabled in interface PluginManager

isPluginEnabled

public boolean isPluginEnabled(@Nullable
 @Nullable Plugin plugin)

Specified by:

isPluginEnabled in interface PluginManager

loadPlugin

public Plugin loadPlugin(@NotNull
 @NotNull File file)
                  throws UnknownDependencyException

Specified by:

loadPlugin in interface PluginManager

Throws:

UnknownDependencyException

loadPlugins

public Plugin[] loadPlugins(@NotNull
 @NotNull File directory)

Specified by:

loadPlugins in interface PluginManager

disablePlugins

public void disablePlugins()

Specified by:

disablePlugins in interface PluginManager

clearPlugins

public void clearPlugins()

Specified by:

clearPlugins in interface 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 Listener listener,
 @NotNull
 @NotNull Plugin plugin)

Specified by:

registerEvents in interface PluginManager

unregisterPluginEvents

public void unregisterPluginEvents(@NotNull
 @NotNull Plugin plugin)

Unregisters all listeners for a plugin.

Parameters:

plugin - The plugin.

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)

Specified by:

registerEvent in interface PluginManager

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)

Specified by:

registerEvent in interface PluginManager

disablePlugin

public void disablePlugin(@NotNull
 @NotNull Plugin plugin)

Specified by:

disablePlugin in interface PluginManager

getPermission

public Permission getPermission(@NotNull
 @NotNull String name)

Specified by:

getPermission in interface PermissionManager

Specified by:

getPermission in interface PluginManager

Overrides:

getPermission in class PermissionManagerMock

addPermission

public void addPermission(@NotNull
 @NotNull Permission perm)

Specified by:

addPermission in interface PermissionManager

Specified by:

addPermission in interface PluginManager

Overrides:

addPermission in class PermissionManagerMock

removePermission

public void removePermission(@NotNull
 @NotNull Permission perm)

Specified by:

removePermission in interface PermissionManager

Specified by:

removePermission in interface PluginManager

Overrides:

removePermission in class PermissionManagerMock

removePermission

public void removePermission(@NotNull
 @NotNull String name)

Specified by:

removePermission in interface PermissionManager

Specified by:

removePermission in interface PluginManager

Overrides:

removePermission in class PermissionManagerMock

getDefaultPermissions

@NotNull
public @NotNull Set<Permission> getDefaultPermissions(boolean op)

Specified by:

getDefaultPermissions in interface PermissionManager

Specified by:

getDefaultPermissions in interface PluginManager

Overrides:

getDefaultPermissions in class PermissionManagerMock

recalculatePermissionDefaults

public void recalculatePermissionDefaults(@NotNull
 @NotNull Permission perm)

Specified by:

recalculatePermissionDefaults in interface PermissionManager

Specified by:

recalculatePermissionDefaults in interface PluginManager

Overrides:

recalculatePermissionDefaults in class PermissionManagerMock

subscribeToPermission

public void subscribeToPermission(@NotNull
 @NotNull String permission,
 @NotNull
 @NotNull Permissible permissible)

Specified by:

subscribeToPermission in interface PermissionManager

Specified by:

subscribeToPermission in interface PluginManager

Overrides:

subscribeToPermission in class PermissionManagerMock

unsubscribeFromPermission

public void unsubscribeFromPermission(@NotNull
 @NotNull String permission,
 @NotNull
 @NotNull Permissible permissible)

Specified by:

unsubscribeFromPermission in interface PermissionManager

Specified by:

unsubscribeFromPermission in interface PluginManager

Overrides:

unsubscribeFromPermission in class PermissionManagerMock

getPermissionSubscriptions

@NotNull
public @NotNull Set<Permissible> getPermissionSubscriptions(@NotNull
 @NotNull String permission)

Specified by:

getPermissionSubscriptions in interface PermissionManager

Specified by:

getPermissionSubscriptions in interface PluginManager

Overrides:

getPermissionSubscriptions in class PermissionManagerMock

subscribeToDefaultPerms

public void subscribeToDefaultPerms(boolean op,
 @NotNull
 @NotNull Permissible permissible)

Specified by:

subscribeToDefaultPerms in interface PermissionManager

Specified by:

subscribeToDefaultPerms in interface PluginManager

Overrides:

subscribeToDefaultPerms in class PermissionManagerMock

unsubscribeFromDefaultPerms

public void unsubscribeFromDefaultPerms(boolean op,
 @NotNull
 @NotNull Permissible permissible)

Specified by:

unsubscribeFromDefaultPerms in interface PermissionManager

Specified by:

unsubscribeFromDefaultPerms in interface PluginManager

Overrides:

unsubscribeFromDefaultPerms in class PermissionManagerMock

getDefaultPermSubscriptions

@NotNull
public @NotNull Set<Permissible> getDefaultPermSubscriptions(boolean op)

Specified by:

getDefaultPermSubscriptions in interface PermissionManager

Specified by:

getDefaultPermSubscriptions in interface PluginManager

Overrides:

getDefaultPermSubscriptions in class PermissionManagerMock

getPermissions

@NotNull
public @NotNull Set<Permission> getPermissions()

Specified by:

getPermissions in interface PermissionManager

Specified by:

getPermissions in interface PluginManager

Overrides:

getPermissions in class PermissionManagerMock

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 PluginManager

Returns:

boolean.false

isTransitiveDependency

public boolean isTransitiveDependency(PluginMeta pluginMeta,
 PluginMeta dependencyConfig)

Specified by:

isTransitiveDependency in interface PluginManager

overridePermissionManager

public void overridePermissionManager(@NotNull
 @NotNull Plugin plugin,
 @Nullable
 @Nullable PermissionManager permissionManager)

Specified by:

overridePermissionManager in interface PluginManager