Class DelayedCommandInputManager

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.managers.DelayedCommandInputManager

All Implemented Interfaces:

IDebuggable

@Singleton
public class DelayedCommandInputManager
extends Object
implements IDebuggable

Represents a manager for outstanding DelayedCommandInputRequests for BaseCommands.

Constructor Summary

Constructors

Constructor	Description
DelayedCommandInputManager(DebuggableRegistry debuggableRegistry)

Method Summary

Modifier and Type	Method	Description
void	cancelAll(ICommandSender commandSender)	Deregisters and cancels all registered DelayedCommandInputRequests for an ICommandSender.
void	deregister(ICommandSender commandSender, DelayedCommandInputRequest<?> delayedCommandInputRequest)	Deregisters a registered DelayedCommandInputRequest for an ICommandSender if the registered input request 1) exists and 2) is the same (reference equality) as the provided input request.
void	deregisterAll(ICommandSender commandSender)	Deregisters all registered DelayedCommandInputRequests for an ICommandSender.
@Nullable String	getDebugInformation()	Gets the debug information for this object.
Optional<DelayedCommandInputRequest<?>>	getInputRequest(ICommandSender commandSender)	Gets the DelayedCommandInputRequest registered for a command sender if one exists.
void	register(ICommandSender commandSender, DelayedCommandInputRequest<?> inputRequest)	Registers an input request for a command sender.

Methods inherited from class Object

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

Constructor Details

DelayedCommandInputManager

@Inject
public DelayedCommandInputManager(DebuggableRegistry debuggableRegistry)

Method Details

register

public void register(ICommandSender commandSender,
 DelayedCommandInputRequest<?> inputRequest)

Registers an input request for a command sender.

Parameters:

commandSender - The ICommandSender for which to register the input request.

inputRequest - The DelayedCommandInputRequest to register.

deregisterAll

public void deregisterAll(ICommandSender commandSender)

Deregisters all registered DelayedCommandInputRequests for an ICommandSender.

Parameters:

commandSender - The ICommandSender for which to deregister the input requests.

cancelAll

public void cancelAll(ICommandSender commandSender)

Deregisters and cancels all registered DelayedCommandInputRequests for an ICommandSender.

Parameters:

commandSender - The ICommandSender for which to deregister the input requests.

deregister

public void deregister(ICommandSender commandSender,
 DelayedCommandInputRequest<?> delayedCommandInputRequest)

Deregisters a registered DelayedCommandInputRequest for an ICommandSender if the registered input request 1) exists and 2) is the same (reference equality) as the provided input request.

This method is useful if the goal is to remove the exact request and not any new requests that may have overridden it.

Parameters:

commandSender - The ICommandSender for which to deregister the input request.

delayedCommandInputRequest - The DelayedCommandInputRequest instance to compare any registered requests to. If the reference of the registered request and this one are the same, it will be deregistered.

getInputRequest

public Optional<DelayedCommandInputRequest<?>> getInputRequest(ICommandSender commandSender)

Gets the DelayedCommandInputRequest registered for a command sender if one exists.

Parameters:

commandSender - The ICommandSender for which to retrieve the input request.

Returns:

The DelayedCommandInputRequest registered for a command sender, if one is registered.

getDebugInformation

public @Nullable String getDebugInformation()

Description copied from interface: IDebuggable

Gets the debug information for this object.

Specified by:

getDebugInformation in interface IDebuggable

Returns:

The debug information or null if there's nothing to log at this time.