Package dev.jorel.commandapi

Class MockCommandAPI

java.lang.Object

dev.jorel.commandapi.MockCommandAPI

public class MockCommandAPI
extends Object

Additional logic that helps the CommandAPI run in a MockBukkit testing environment. Does not rely on any version-specific Minecraft code to (ideally) support testing in any version.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ENABLE_LOGGING	A global toggle for whether the default logger returned by CommandAPIBukkit.getLogger() should print messages to the console.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MockCommandAPI(CommandAPIBukkit<MockCommandSource> commandAPIBukkit)

Method Summary

Modifier and Type	Method	Description
CommandAPIBukkit<MockCommandSource>	getCommandAPIBukkit()
CommandAPIHandlerSpy	getCommandAPIHandlerSpy()
MockCommandRegistrationStrategy	getCommandRegistrationStrategy()
static MockCommandAPI	getInstance()
void	onLoad()
static <Target> void	setField(Class<? super Target> targetClass, String fieldName, Target target, Object value)	Sets a field inside a target object to the given value.

Methods inherited from class java.lang.Object

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

Field Details

ENABLE_LOGGING

public static boolean ENABLE_LOGGING

A global toggle for whether the default logger returned by CommandAPIBukkit.getLogger() should print messages to the console. This is false by default, so not messages will appear. If you don't provide your own logger using CommandAPI.setLogger(CommandAPILogger) and set this to true before calling CommandAPI.onLoad(CommandAPIConfig), then the CommandAPI will write messages into the test log.

Constructor Details

MockCommandAPI

protected MockCommandAPI(CommandAPIBukkit<MockCommandSource> commandAPIBukkit)

Method Details

getInstance

public static MockCommandAPI getInstance()

Returns:

The MockCommandAPI instance currently loaded.

getCommandAPIBukkit

public CommandAPIBukkit<MockCommandSource> getCommandAPIBukkit()

Returns:

The implementation of CommandAPIBukkit which is currently loaded. This is the same object as is returned by CommandAPIBukkit.get(), but explicitly using the MockCommandSource class.

setField

public static <Target> void setField(Class<? super Target> targetClass,
 String fieldName,
 Target target,
 Object value)

Sets a field inside a target object to the given value. Ignores private access or final status.

Type Parameters:

Target - The type of the target object.

Parameters:

targetClass - The Class that contains the field.

fieldName - The name of the field to change.

target - The object whose field will be changed. If the field is static, this is ignored and can be null.

value - The new value for the field.

Throws:

IllegalArgumentException - If the field cannot be set.

onLoad

public void onLoad()

getCommandAPIHandlerSpy

public CommandAPIHandlerSpy getCommandAPIHandlerSpy()

Returns:

The CommandAPIHandlerSpy object intercepting calls to CommandAPIHandler methods.

getCommandRegistrationStrategy

public MockCommandRegistrationStrategy getCommandRegistrationStrategy()

Returns:

The MockCommandRegistrationStrategy handling Brigadier command logic.