Added some javadocs.

master
Tomasz Polgrabia 2024-12-27 16:03:34 +01:00
parent 65f022304f
commit 4b34b31928
2 changed files with 16 additions and 0 deletions

View File

@ -7,6 +7,10 @@ public class PluginRunner {
private static final Logger logger = LoggerFactory.getLogger(PluginRunner.class);
private final PluginRunnerConfig config;
/**
* Create plugin with the given config
* @param config plugin runner config to create with
*/
public PluginRunner(PluginRunnerConfig config) {
this.config = config;
}
@ -16,6 +20,9 @@ public class PluginRunner {
.execute();
}
/**
* Execute plugin runner
*/
public void execute() {
logger.info("Started runner id: {}, name: {}", config.id(), config.name());
}

View File

@ -1,7 +1,16 @@
package pl.polgrabia.demos;
/**
* Plugin runner config
*/
public record PluginRunnerConfig(
/**
* id of the plugin runner
*/
String id,
/**
* name of the plguin runner
*/
String name
) {