NoIssue: Update docs

This commit is contained in:
2026-01-26 13:38:37 +01:00
parent b971d50175
commit 4e9da9c530

View File

@@ -1,22 +1,24 @@
package com.r35157.nenjim.kicker;
import org.jetbrains.annotations.NotNull;
import java.util.HashMap;
public interface Kicker {
/**
* Starts a process based on the provided fully qualified interface name.
* The actual implementation that is run is binded according to the Context.
* The actual implementation that is run is bound according to the Context.
*
* @param fqInterfaceName the fully qualified interface name for the actual class to start as a process. The interface must extend the {@code NenjimProcess} interface.
*/
void startProcess(String fqInterfaceName);
void startProcess(@NotNull String fqInterfaceName);
/**
* Provides a map of all running processes managed by the NenjimHub, keyed by the processId.
*
* @return a map of {@code NenjimProcess} running processes
*/
HashMap<Integer, NenjimProcess> getRunningProcesses();
@NotNull HashMap<Integer, NenjimProcess> getRunningProcesses();
/**
* A no-operation (noop). This method does nothing.