Package org.sikuli.script.runners

Class JythonRunner

java.lang.Object

org.sikuli.script.runners.AbstractScriptRunner

org.sikuli.script.runners.AbstractLocalFileScriptRunner

org.sikuli.script.runners.JythonRunner

All Implemented Interfaces:

IScriptRunner

Direct Known Subclasses:

RobotRunner

public class JythonRunner
extends AbstractLocalFileScriptRunner

Executes Sikuliscripts written in Python/Jython.

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[]	EXTENSIONS
static String	NAME
static String	TYPE

Constructor Summary

Constructors

Constructor	Description
JythonRunner()

Method Summary

Modifier and Type	Method	Description
void	doClose()
protected int	doEvalScript(String script, IScriptRunner.Options options)
protected void	doInit(String[] param)
protected boolean	doRedirect(PrintStream stdout, PrintStream stderr)
protected void	doRunLines(String lines, IScriptRunner.Options options)
protected int	doRunScript(String scriptFile, String[] argv, IScriptRunner.Options options)	Executes the jythonscript
String[]	getExtensions()	returns the list of possible script file extensions, first is the default
String[]	getFileEndings()	Usually the same as getExtensions() but with the leading dot.
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.AbstractLocalFileScriptRunner

canHandle, prepareFileLocation

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

abort, canHandleFileEnding, close, doAbort, evalScript, execAfter, execBefore, getDefaultExtension, getEffectiveRunner, 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

EXTENSIONS

public static final String[] EXTENSIONS

Constructor Details

JythonRunner

public JythonRunner()

Method Details

isSupported

public boolean isSupported()

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()

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()

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:

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

getFileEndings

public String[] getFileEndings()

Description copied from interface: IScriptRunner

Usually the same as getExtensions() but with the leading dot.

Some files (e.g. $py.class) might have a somewhat unusual but very specific file ending.

Specified by:

getFileEndings in interface IScriptRunner

Overrides:

getFileEndings in class AbstractScriptRunner

Returns:

An Array containing the supported line endings

doInit

protected void doInit(String[] param)

Overrides:

doInit in class AbstractScriptRunner

doClose

public void doClose()

Overrides:

doClose in class AbstractScriptRunner

doEvalScript

protected int doEvalScript(String script, IScriptRunner.Options options)

Overrides:

doEvalScript in class AbstractScriptRunner

doRunScript

protected int doRunScript(String scriptFile, String[] argv, IScriptRunner.Options options)

Executes the jythonscript

Overrides:

doRunScript in class AbstractScriptRunner

Parameters:

scriptFile -

argv - arguments to be populated into sys.argv

options -

Returns:

The exitcode

doRunLines

protected void doRunLines(String lines, IScriptRunner.Options options)

Overrides:

doRunLines in class AbstractScriptRunner

doRedirect

protected boolean doRedirect(PrintStream stdout, PrintStream stderr)

Overrides:

doRedirect in class AbstractScriptRunner