me.lucko.helper.js.script

Interface Script

All Superinterfaces:

AutoCloseable, Runnable, Terminable

All Known Implementing Classes:

HelperScript

public interface Script
extends Terminable, Runnable

Represents a Script

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	depend(Path path) Marks that this script depends on another script.
void	depend(String path) Marks that this script depends on another script.
SystemScriptBindings	getBindings() Gets the initial bindings used by this script
Set<Path>	getDependencies() Gets the other scripts depended on by this script.
ScriptLogger	getLogger() Gets the scripts logger instance
String	getName() Gets the name of the script
Path	getPath() Gets the file this script instance was created from

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, hasTerminated, of, terminate

Methods inherited from interface java.lang.Runnable

run

Method Detail

getName

@Nonnull
String getName()

Gets the name of the script

Returns:

the script name

getPath

@Nonnull
Path getPath()

Gets the file this script instance was created from

The returned path is relative to the loader directory.

Returns:

the file path

getBindings

@Nonnull
SystemScriptBindings getBindings()

Gets the initial bindings used by this script

Returns:

the scripts bindings

getLogger

@Nonnull
ScriptLogger getLogger()

Gets the scripts logger instance

Returns:

the script logger

getDependencies

Set<Path> getDependencies()

Gets the other scripts depended on by this script.

Returns:

this scripts dependencies

depend

void depend(@Nonnull
            String path)

Marks that this script depends on another script.

Parameters:

path - the other script

depend

void depend(@Nonnull
            Path path)

Marks that this script depends on another script.

Parameters:

path - the other script