me.lucko.scriptcontroller

Interface ScriptController

All Known Implementing Classes:

ScriptControllerImpl

public interface ScriptController

Controls the execution and management of ScriptEnvironments.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ScriptController.Builder Builds a ScriptController

Method Summary

Modifier and Type	Method and Description
static ScriptController.Builder	builder() Creates a new ScriptController.Builder using the internal implementation.
Collection<ScriptEnvironment>	getEnvironments() Gets the ScriptEnvironments being processed by the controller
default ScriptEnvironment	setupNewEnvironment(Path loadDirectory) Sets up a new ScriptEnvironment in the given load directory.
ScriptEnvironment	setupNewEnvironment(Path loadDirectory, EnvironmentSettings settings) Sets up a new ScriptEnvironment in the given load directory.
void	shutdown() Shuts down this script controller

Method Detail

builder

static ScriptController.Builder builder()

Creates a new ScriptController.Builder using the internal implementation.

Returns:

the builder

getEnvironments

Collection<ScriptEnvironment> getEnvironments()

Gets the ScriptEnvironments being processed by the controller

Returns:

the environments

setupNewEnvironment

ScriptEnvironment setupNewEnvironment(Path loadDirectory,
                                      EnvironmentSettings settings)

Sets up a new ScriptEnvironment in the given load directory.

Parameters:

loadDirectory - the directory

settings - the environment settings

Returns:

the new environment

Throws:

UnsupportedOperationException - if the controller does not support setting up new environments after construction

setupNewEnvironment

default ScriptEnvironment setupNewEnvironment(Path loadDirectory)

Sets up a new ScriptEnvironment in the given load directory.

Parameters:

loadDirectory - the directory

Returns:

the new environment

Throws:

UnsupportedOperationException - if the controller does not support setting up new environments after construction

shutdown

void shutdown()

Shuts down this script controller