IScriptRunner.Options (SikuliX API 2.0.5 API)

java.lang.Object
- org.sikuli.script.support.IScriptRunner.Options

Enclosing interface:

IScriptRunner
```
public static class IScriptRunner.Options
extends Object
```
Special options to pass to the runner.
Options are more to be interpreted as hints instead of strict directives. A specific runner implementation can decide to ignore an option entirely.

Author:

mbalmer

Constructor Summary

Constructors
Constructor Description

Options()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File`	`getBaseFolder()`
`int`	`getErrorLine()`	Get the error source line set by the runner.
`long`	`getTimeout()`
`boolean`	`isRunningFromScript()`
`boolean`	`isRunningInIDE()`
`boolean`	`isSilent()`
`void`	`setBaseFolder(File baseFolder)`
`IScriptRunner.Options`	`setErrorLine(int errorLine)`	If a script run fails, the runner can set the source line where the error happened.
`IScriptRunner.Options`	`setRunningFromScript()`
`IScriptRunner.Options`	`setRunningInIDE()`
`void`	`setRunningInIDE(boolean runningInIDE)`
`IScriptRunner.Options`	`setSilent(boolean silent)`	Indicates that the runner should behave silent.
`IScriptRunner.Options`	`setTimeout(long timeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Options
```
public Options()
```

Method Detail

isSilent
```
public boolean isSilent()
```

setSilent
```
public IScriptRunner.Options setSilent(boolean silent)
```
Indicates that the runner should behave silent. E.g. not making output to SDTIO.

Parameters:

silent -

Returns:

this to allow chaining

getErrorLine
```
public int getErrorLine()
```
Get the error source line set by the runner.

Returns:

source line where the error happened

setErrorLine
```
public IScriptRunner.Options setErrorLine(int errorLine)
```
If a script run fails, the runner can set the source line where the error happened.
There is no effect setting this from the outside.

Parameters:

errorLine -

isRunningInIDE
```
public boolean isRunningInIDE()
```

setRunningInIDE

public IScriptRunner.Options setRunningInIDE()

isRunningFromScript
```
public boolean isRunningFromScript()
```

setRunningFromScript

public IScriptRunner.Options setRunningFromScript()

setRunningInIDE

public void setRunningInIDE(boolean runningInIDE)

getTimeout
```
public long getTimeout()
```

setTimeout

public IScriptRunner.Options setTimeout(long timeout)

getBaseFolder
```
public File getBaseFolder()
```

setBaseFolder

public void setBaseFolder(File baseFolder)