com.github.rcaller.rstuff

Class RCallerOptions

java.lang.Object

com.github.rcaller.rstuff.RCallerOptions

public class RCallerOptions
extends Object

Method Summary

Modifier and Type	Method and Description
static RCallerOptions	create()
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime)
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime, long initialWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(String rScriptExecutable, String rExecutable, FailurePolicy failurePolicy, long maxWaitTime, long initialWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
FailurePolicy	getFailurePolicy()
long	getInitialWaitTime()
long	getMaxWaitTime() How long this R caller will wait for the R process to terminate before forcibly killing it
int	getRetries()
String	getrExecutable()
RProcessStartUpOptions	getrProcessStartUpOptions()
String	getrScriptExecutable()
String	getStartUpOptionsAsCommand()
void	incrementRetries()
void	resetRetries()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RCallerOptions create()

Returns:

a default RCallerOptions object

create

public static RCallerOptions create(RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    long initialWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(String rScriptExecutable,
                                    String rExecutable,
                                    FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    long initialWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

getrScriptExecutable

public String getrScriptExecutable()

getrExecutable

public String getrExecutable()

getFailurePolicy

public FailurePolicy getFailurePolicy()

getMaxWaitTime

public long getMaxWaitTime()

How long this R caller will wait for the R process to terminate before forcibly killing it

Returns:

maxWaitTime - the max time to wait

getInitialWaitTime

public long getInitialWaitTime()

getrProcessStartUpOptions

public RProcessStartUpOptions getrProcessStartUpOptions()

getRetries

public int getRetries()

getStartUpOptionsAsCommand

public String getStartUpOptionsAsCommand()

incrementRetries

public void incrementRetries()

resetRetries

public void resetRetries()