Package org.sikuli.script.runners

Class SikulixRunner

java.lang.Object

org.sikuli.script.runners.AbstractScriptRunner

org.sikuli.script.runners.SikulixRunner

All Implemented Interfaces:

IScriptRunner

public class SikulixRunner
extends AbstractScriptRunner

Runs Sikulix scripts.

A sikulix script is a directory (optionally with a .sikuli extension)

Author:

mbalmer

Nested Class Summary

Nested classes/interfaces inherited from interface org.sikuli.script.support.IScriptRunner

IScriptRunner.EffectiveRunner, IScriptRunner.Options

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME
static String	TYPE

Constructor Summary

Constructors

Constructor	Description
SikulixRunner()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String identifier)	Checks if this runner can handle the given identifier.
protected void	doAbort()	Interrupts the worker thread.
protected int	doRunScript(String scriptFolder, String[] scriptArgs, IScriptRunner.Options options)
IScriptRunner.EffectiveRunner	getEffectiveRunner(String scriptFileOrFolder)	Needed in the IDE to detect the runner when file or folder is opened
String[]	getExtensions()	returns the list of possible script file extensions, first is the default
String	getName()	Gets the name of the ScriptRunner.
String	getType()	return the type of script this handler can execute.
boolean	isAbortSupported()	Checks if abort is supported by this script runner implementation.
boolean	isSupported()	Checks if the current platform supports this runner.

Methods inherited from class org.sikuli.script.runners.AbstractScriptRunner

abort, canHandleFileEnding, close, doClose, doEvalScript, doInit, doRedirect, doRunLines, evalScript, execAfter, execBefore, getDefaultExtension, getFileEndings, hasExtension, init, isAborted, isReady, isRunning, log, redirect, reset, runLines, runScript

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Details

SikulixRunner

public SikulixRunner()

Method Details

isSupported

public boolean isSupported()

Description copied from interface: IScriptRunner

Checks if the current platform supports this runner.

Specified by:

isSupported in interface IScriptRunner

Overrides:

isSupported in class AbstractScriptRunner

Returns:

true if platform supports this runner, false otherwise

getName

public String getName()

Description copied from interface: IScriptRunner

Gets the name of the ScriptRunner. Should be unique. This value is needed to distinguish between different ScriptRunners.

Returns:

Name to identify the ScriptRunner or null if not available

getExtensions

public String[] getExtensions()

Description copied from interface: IScriptRunner

returns the list of possible script file extensions, first is the default

Returns:

array of strings

getType

public String getType()

Description copied from interface: IScriptRunner

return the type of script this handler can execute.

Returns:

canHandle

public boolean canHandle(String identifier)

Description copied from interface: IScriptRunner

Checks if this runner can handle the given identifier.

Specified by:

canHandle in interface IScriptRunner

Overrides:

canHandle in class AbstractScriptRunner

Parameters:

identifier - Can be Runner name, type or one of its supported extensions Can also be script code prefixed with the runnerName (e.g. JavaScript*console.log("hello"))

Returns:

true if the runner can handle the identifier, false otherwise

doRunScript

protected int doRunScript(String scriptFolder, String[] scriptArgs, IScriptRunner.Options options)

Overrides:

doRunScript in class AbstractScriptRunner

getEffectiveRunner

public IScriptRunner.EffectiveRunner getEffectiveRunner(String scriptFileOrFolder)

Description copied from interface: IScriptRunner

Needed in the IDE to detect the runner when file or folder is opened

Specified by:

getEffectiveRunner in interface IScriptRunner

Overrides:

getEffectiveRunner in class AbstractScriptRunner

Returns:

array: EffectiveRunner object

isAbortSupported

public boolean isAbortSupported()

Description copied from interface: IScriptRunner

Checks if abort is supported by this script runner implementation.

Specified by:

isAbortSupported in interface IScriptRunner

Overrides:

isAbortSupported in class AbstractScriptRunner

Returns:

true is abort is supported, false otherwise

doAbort

protected void doAbort()

Description copied from class: AbstractScriptRunner

Interrupts the worker thread. Can be overridden by Runner implementations if an interrupt is not needed.

Overrides:

doAbort in class AbstractScriptRunner