Package me.lucko.scriptcontroller.environment.settings

Interface EnvironmentSettings.Builder

Enclosing interface:

EnvironmentSettings

public static interface EnvironmentSettings.Builder

Builds EnvironmentSettings

Method Summary

Modifier and Type	Method	Description
EnvironmentSettings	build()	Builds a new EnvironmentSettings instance.
EnvironmentSettings.Builder	initScript(String path)	Defines the init script for the environment
EnvironmentSettings.Builder	loadExecutor(ScriptLoadingExecutor executor)	Define the executor service used to setup task to poll scripts for changes and load new scripts.
EnvironmentSettings.Builder	mergeSettingsFrom(EnvironmentSettings other)	Applies the settings from the give instance to this builder
EnvironmentSettings.Builder	pollRate(long time, TimeUnit unit)	Define how often the script loader should poll scripts for updates
EnvironmentSettings.Builder	runExecutor(Executor executor)	Define the executor used to run scripts
EnvironmentSettings.Builder	withBindings(BindingsSupplier supplier)	Adds a bindings supplier to the settings
EnvironmentSettings.Builder	withDefaultPackageImport(String packageName)	Marks that a Package should be imported by default.
EnvironmentSettings.Builder	withDefaultPackageImports(Collection<String> packageNames)	Marks that Packages should be imported by default.
EnvironmentSettings.Builder	withDefaultTypeImport(String type)	Marks that a Class should be imported by default.
EnvironmentSettings.Builder	withDefaultTypeImports(Collection<String> types)	Marks that Classes should be imported by default.

Method Detail

mergeSettingsFrom

EnvironmentSettings.Builder mergeSettingsFrom(EnvironmentSettings other)

Applies the settings from the give instance to this builder

Parameters:

other - the other settings

Returns:

this builder

loadExecutor

EnvironmentSettings.Builder loadExecutor(ScriptLoadingExecutor executor)

Define the executor service used to setup task to poll scripts for changes and load new scripts.

Parameters:

executor - the executor

Returns:

this builder

runExecutor

EnvironmentSettings.Builder runExecutor(Executor executor)

Define the executor used to run scripts

Parameters:

executor - the executor

Returns:

this builder

withBindings

EnvironmentSettings.Builder withBindings(BindingsSupplier supplier)

Adds a bindings supplier to the settings

Parameters:

supplier - the bindings supplier

Returns:

this builder

withDefaultPackageImport

EnvironmentSettings.Builder withDefaultPackageImport(String packageName)

Marks that a Package should be imported by default.

Parameters:

packageName - the name of the package - see Package.getName().

Returns:

this builder

withDefaultPackageImports

EnvironmentSettings.Builder withDefaultPackageImports(Collection<String> packageNames)

Marks that Packages should be imported by default.

Parameters:

packageNames - the package names - see Package.getName().

Returns:

this builder

withDefaultTypeImport

EnvironmentSettings.Builder withDefaultTypeImport(String type)

Marks that a Class should be imported by default.

Parameters:

type - the name of the class - see Class.getName()

Returns:

this builder

withDefaultTypeImports

EnvironmentSettings.Builder withDefaultTypeImports(Collection<String> types)

Marks that Classes should be imported by default.

Parameters:

types - class names - see Class.getName()

Returns:

this builder

pollRate

EnvironmentSettings.Builder pollRate(long time,
                                     TimeUnit unit)

Define how often the script loader should poll scripts for updates

Parameters:

time - the time

unit - the unit

Returns:

this builder

initScript

EnvironmentSettings.Builder initScript(String path)

Defines the init script for the environment

Parameters:

path - the path

Returns:

this builder

build

EnvironmentSettings build()

Builds a new EnvironmentSettings instance.

Returns:

the resultant environment settings