Package uk.co.terminological.rjava.threads

Class RFuture

java.lang.Object

uk.co.terminological.rjava.threads.RFuture

All Implemented Interfaces:

Future<Object>

public class RFuture
extends Object
implements Future<Object>

A slightly idiosyncratic implementation of a Java Future API that can be called from generated R code. This only executes a named method with supplied parameters which are validated at runtime using reflection. The use of this is triggered by an @RAsync annotation on a method. It is also used for @RBlocking annotated methods so as to allow long running blocking functions to be interrupted through R. This is intended really to be only accessible through generated R6 code and not generally expected to be used directly.

Version:

$Id: $Id

Author:

vp22681

Constructor Summary

Constructors

Constructor	Description
RFuture(Object o, String method, ArrayList<Object> parameters, String returnSig, String converter)	Constructor for RFuture.

Method Summary

Modifier and Type	Method	Description
void	attachProgressBar(String name)
boolean	cancel()	cancel.
boolean	cancel(boolean mayInterruptIfRunning)
Object	get()	This will only throw an interrupted exception if it was cancelled already or in interrupted whilst waiting to join the thread.
Object	get(long timeout)	get.
Object	get(long timeout, TimeUnit unit)
String	getConverter()
long	getId()
String	getMethod()
String	getProgressRCode()
String	getReturnSig()
String	getSystemMessages()	Gets the system messages from Java for thread in current method thread.
boolean	isCancelled()
boolean	isDone()
boolean	isStale()
boolean	poll(long ms)	Polls for completion for use in while loop.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RFuture

public RFuture(Object o,
 String method,
 ArrayList<Object> parameters,
 String returnSig,
 String converter)
        throws NoSuchMethodException,
SecurityException,
ClassNotFoundException

Constructor for RFuture.

Parameters:

o - a Object or a String representing a fully qualified class name

method - a String object to be run in a thread

parameters - a ArrayList object the parameters of the method (not checked)

returnSig - the return signature in JNI notation

converter - the R expression to convert the return value to a R value (as a string).

Throws:

NoSuchMethodException - if any.

SecurityException - if any.

ClassNotFoundException - if any.

Method Details

cancel

public boolean cancel()

cancel.

Returns:

a boolean

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Object>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Object>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Object>

isStale

public boolean isStale()

getMethod

public String getMethod()

get

public Object get()
           throws InterruptedException,
ExecutionException

This will only throw an interrupted exception if it was cancelled already or in interrupted whilst waiting to join the thread.

Specified by:

get in interface Future<Object>

Throws:

InterruptedException

ExecutionException

get

public Object get(long timeout)
           throws InterruptedException,
ExecutionException,
TimeoutException

get.

Parameters:

timeout - a long representing number of milliseconds

Returns:

a Object object

Throws:

InterruptedException - if the function was cancelled already or is cancelled in the . next `timeout` milliseconds.

ExecutionException - if any issues executing the function.

TimeoutException - if the function has not completed.

get

public Object get(long timeout,
 TimeUnit unit)
           throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<Object>

Throws:

InterruptedException

ExecutionException

TimeoutException

poll

public boolean poll(long ms)

Polls for completion for use in while loop.

Parameters:

ms - time in millisecods

Returns:

a boolean, true if completed, false if still running. Completed means thread is finished processing. It can be result of cancellation, error or completion.

getSystemMessages

public String getSystemMessages()

Gets the system messages from Java for thread in current method thread.

Returns:

the system messages

attachProgressBar

public void attachProgressBar(String name)

getProgressRCode

public String getProgressRCode()

toString

public String toString()

Overrides:

toString in class Object

getId

public long getId()

getReturnSig

public String getReturnSig()

getConverter

public String getConverter()