Package dev.getelements.elements.sdk.local

Interface ElementsLocal

All Superinterfaces:

AutoCloseable

public interface ElementsLocal
extends AutoCloseable

Runs a local instance of Elements suitable for debugging. This works by interacting with the local build system to ensure that the artifacts are installed and then loading them directly from the result of the build system. This is intended to be used stand alone, or in conjunction with an IDE for debugging. In an IDE, it is strongly recommended that the local SDK be the only entry on the runtime classpath and let the artifact loader system read the installed artifacts from the local repository.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this ElementsLocal.
MutableElementRegistry	getRootElementRegistry()	Gets the root ElementRegistry used by the local runner.
ElementRuntimeService	getRuntimeService()	Gets the ElementRuntimeService for this ElementsLocal instance.
ElementsLocal	run()	Runs the instance and will block until shutdown.
ElementsLocal	start()	Starts this ElementsLocal.

Method Details

start

ElementsLocal start()

Starts this ElementsLocal.

Returns:

this instance

run

ElementsLocal run()

Runs the instance and will block until shutdown.

Returns:

this instance

getRuntimeService

ElementRuntimeService getRuntimeService()

Gets the ElementRuntimeService for this ElementsLocal instance. This can be used to load and unload Elements from the runtime on the fly.

Returns:

the ElementRuntimeService

getRootElementRegistry

MutableElementRegistry getRootElementRegistry()

Gets the root ElementRegistry used by the local runner.

Returns:

the ElementRegistry

close

void close()

Closes this ElementsLocal.

Specified by:

close in interface AutoCloseable