Package com.illumon.iris.db.util.scripts

Interface StateOverrideScriptPathLoader

All Superinterfaces:

ScriptPathLoader

All Known Implementing Classes:

ControllerScriptPathLoader

public interface StateOverrideScriptPathLoader
extends ScriptPathLoader

An extension to the ScriptPathLoader that allows the state to be overridden.

Method Summary

Modifier and Type	Method	Description
void	clearOverride()	Instead of using the previously set override, use the state the loader was created with.
String	getUseStateJson()	Get the currently active state as a JSON string created by ScriptPathLoaderState.encodeJSON()
void	setOverrideState(ScriptPathLoaderState state)	Sets a state that should be used for loading operations instead of the state the loader was created with.

Methods inherited from interface com.illumon.iris.db.util.scripts.ScriptPathLoader

close, getAvailableScriptDisplayPaths, getAvailableScriptDisplayPaths, getAvailableScriptRelativePaths, getAvailableScriptRelativePaths, getScriptBodyByDisplayPath, getScriptBodyByDisplayPath, getScriptBodyByRelativePath, getScriptBodyByRelativePath, getState, lock, makeState, refresh, unlock

Method Details

setOverrideState

void setOverrideState(ScriptPathLoaderState state)

Sets a state that should be used for loading operations instead of the state the loader was created with.

Parameters:

state - the state to use for loading operations.

clearOverride

void clearOverride()

Instead of using the previously set override, use the state the loader was created with.

getUseStateJson

String getUseStateJson()

Get the currently active state as a JSON string created by ScriptPathLoaderState.encodeJSON()

Returns:

the currently active state as a JSON string