java.lang.Object

com.jogamp.common.util.TaskBase

com.jogamp.common.util.RunnableTask

All Implemented Interfaces:: Runnable

public class RunnableTask extends TaskBase

Helper class to provide a Runnable queue implementation with a Runnable wrapper which notifies after execution for the invokeAndWait() semantics.

Field Summary

Fields

Modifier and Type

Field

Description

protected final Runnable

runnable

Fields inherited from class com.jogamp.common.util.TaskBase
attachment, catchExceptions, exceptionOut, execThread, isExecuted, isFlushed, runnableException, sourceStack, syncObject, tCreated, tExecuted, tStarted
Constructor Summary

Constructors

Constructor

Description

RunnableTask(Runnable runnable, Object syncObject, boolean catchExceptions, PrintStream exceptionOut)

Create a RunnableTask object w/ synchronization, ie.
Method Summary

Modifier and Type

Method

Description

final Runnable

getRunnable()

Return the user action

static void

invoke(boolean waitUntilDone, Runnable runnable)

Deprecated.
Simply invoke Runnable.run()

static Thread

invokeOnNewThread(ThreadGroup tg, boolean waitUntilDone, Runnable runnable, String threadName)

Deprecated.
Use invokeOnNewThread(ThreadGroup, String, boolean, Runnable)

static RunnableTask

invokeOnNewThread(ThreadGroup tg, String threadName, boolean waitUntilDone, Runnable runnable)

Invokes runnable on a new InterruptSource.Thread, see Thread(ThreadGroup, Runnable, String) for details.

final void

run()

Methods inherited from class com.jogamp.common.util.TaskBase
flush, getAttachment, getDurationInExec, getDurationInQueue, getDurationTotal, getExceptionOutIntro, getExecutionThread, getSyncObject, getThrowable, getTimestampAfterExec, getTimestampBeforeExec, getTimestampCreate, hasWaiter, isExecuted, isFlushed, isInQueue, printSourceTrace, setAttachment, toString

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

Field Details
- runnable
  
  protected final Runnable runnable
Constructor Details
- RunnableTask
  
  public RunnableTask(Runnable runnable, Object syncObject, boolean catchExceptions, PrintStream exceptionOut)
  
  Create a RunnableTask object w/ synchronization, ie. suitable for invokeAndWait(), i.e. invoke(true, runnable).
  
  Parameters:
  
  runnable - The user action
  
  syncObject - The synchronization object if caller wait until runnable execution is completed, or null if waiting is not desired.
  
  catchExceptions - Influence an occurring exception during runnable execution. If true, the exception is silenced and can be retrieved via TaskBase.getThrowable(), otherwise the exception is thrown.
  
  exceptionOut - If not null, exceptions are written to this PrintStream.
Method Details
- invoke
  
  public static void invoke(boolean waitUntilDone, Runnable runnable)
  
  Deprecated.
  Simply invoke Runnable.run()
- invokeOnNewThread
  
  public static Thread invokeOnNewThread(ThreadGroup tg, boolean waitUntilDone, Runnable runnable, String threadName)
  
  Deprecated.
  Use invokeOnNewThread(ThreadGroup, String, boolean, Runnable)
- invokeOnNewThread
  
  public static RunnableTask invokeOnNewThread(ThreadGroup tg, String threadName, boolean waitUntilDone, Runnable runnable)
  
  Invokes runnable on a new InterruptSource.Thread, see Thread(ThreadGroup, Runnable, String) for details.
  
  Parameters:
  
  tg - the ThreadGroup for the new thread, maybe null
  
  threadName - the name for the new thread, maybe null
  
  waitUntilDone - if true, waits until runnable execution is completed, otherwise returns immediately.
  
  runnable - the Runnable to execute on the new thread. If waitUntilDone is true, the runnable must exit, i.e. not loop forever.
  
  Returns:
  
  the newly created and invoked RunnableTask
  
  Since:
  
  2.3.2
- getRunnable
  
  public final Runnable getRunnable()
  
  Return the user action
- run
  
  public final void run()
  
  Specified by:
  
  run in interface Runnable
  
  Specified by:
  
  run in class TaskBase

Class RunnableTask

Field Summary

Fields inherited from class com.jogamp.common.util.TaskBase

Constructor Summary

Method Summary

Methods inherited from class com.jogamp.common.util.TaskBase

Methods inherited from class java.lang.Object

Field Details

runnable

Constructor Details

RunnableTask

Method Details

invoke

invokeOnNewThread

invokeOnNewThread

getRunnable

run