me.lucko.helper.js

Class HelperScript

java.lang.Object

me.lucko.helper.js.HelperScript

All Implemented Interfaces:

AutoCloseable, Runnable, Script, Terminable

public class HelperScript
extends Object
implements Script

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
HelperScript(Path path, SystemScriptLoader loader, SystemScriptBindings systemBindings)

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
void	run()
boolean	terminate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

bindWith, close, hasTerminated, of

Constructor Detail

HelperScript

public HelperScript(@Nonnull
                    Path path,
                    @Nonnull
                    SystemScriptLoader loader,
                    @Nonnull
                    SystemScriptBindings systemBindings)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: Script

Gets the name of the script

Specified by:

getName in interface Script

Returns:

the script name

getPath

@Nonnull
public Path getPath()

Description copied from interface: Script

Gets the file this script instance was created from

The returned path is relative to the loader directory.

Specified by:

getPath in interface Script

Returns:

the file path

getBindings

@Nonnull
public SystemScriptBindings getBindings()

Description copied from interface: Script

Gets the initial bindings used by this script

Specified by:

getBindings in interface Script

Returns:

the scripts bindings

getLogger

@Nonnull
public ScriptLogger getLogger()

Description copied from interface: Script

Gets the scripts logger instance

Specified by:

getLogger in interface Script

Returns:

the script logger

run

public void run()

Specified by:

run in interface Runnable

getDependencies

public Set<Path> getDependencies()

Description copied from interface: Script

Gets the other scripts depended on by this script.

Specified by:

getDependencies in interface Script

Returns:

this scripts dependencies

depend

public void depend(@Nonnull
                   String path)

Description copied from interface: Script

Marks that this script depends on another script.

Specified by:

depend in interface Script

Parameters:

path - the other script

depend

public void depend(@Nonnull
                   Path path)

Description copied from interface: Script

Marks that this script depends on another script.

Specified by:

depend in interface Script

Parameters:

path - the other script

terminate

public boolean terminate()

Specified by:

terminate in interface Terminable