TestRunnable (threadly-test 0.1 API)

java.lang.Object
- org.threadly.test.concurrent.TestRunnable

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

BlockingTestRunnable
```
public class TestRunnable
extends java.lang.Object
implements java.lang.Runnable
```
Generic runnable implementation that can be used in unit tests for verifying execution occurred.
This structure is used extensively within threadly's own unit tests. Please use those as examples using this class.

Since:

1.0 (since 1.0.0 in threadly artifact)

Constructor Summary

Constructors
Constructor and Description

TestRunnable()
Constructs a new runnable for unit testing.

TestRunnable(int runTimeInMillis)
Constructs a new runnable for unit testing.

Constructors
Constructor and Description
`TestRunnable()` Constructs a new runnable for unit testing.
`TestRunnable(int runTimeInMillis)` Constructs a new runnable for unit testing.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`blockTillFinished()` Blocks until run has completed at least once.
`void`	`blockTillFinished(int timeout)` Blocks until run has completed at least once.
`void`	`blockTillFinished(int timeout, int expectedRunCount)` Blocks until run completed been called the provided quantity of times.
`void`	`blockTillStarted()` Blocks until run has been called at least once.
`void`	`blockTillStarted(int timeout)` Blocks until run has been called at least once.
`long`	`getCreationTime()` Returns the millis returned from `Clock.accurateForwardProgressingMillis()`, that was recorded when this runnable was constructed.
`long`	`getDelayTillFirstRun()` This function blocks till the first run completes then will return the time until the first run started it's call.
`long`	`getDelayTillRun(int runNumber)` This function blocks till the run provided, and then gets the time between creation and a given run.
`long`	`getDelayTillRun(int runNumber, int timeout)` This function blocks till the run provided, and then gets the time between creation and a given run.
`int`	`getRunCount()` Getter for the number of times the run function has completed.
`int`	`getRunDelayInMillis()` Getter for the currently set amount of time the `TestRunnable` will block after `handleRunStart()` and before `handleRunFinish()` is called.
`void`	`handleRunFinish()` Function to be overloaded by extending classes if more data or operations need to happen at the run point.
`void`	`handleRunStart()` Function to be overloaded by extending classes if more data or operations need to happen at the run point.
`boolean`	`isRunning()` Check to see if the run function has started but has not completed returned yet.
`boolean`	`ranConcurrently()` Check if this instance has ever been detected to run concurrently.
`boolean`	`ranOnce()` Getter to check if the runnable has run exactly once.
`void`	`run()`
`void`	`setRunDelayInMillis(int runDelayInMillis)` Changes the amount of time the runnable will sleep/block when called.

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

- Constructor Detail
  - TestRunnable
```
public TestRunnable()
```
    Constructs a new runnable for unit testing.
  - TestRunnable
```
public TestRunnable(int runTimeInMillis)
```
    Constructs a new runnable for unit testing.
    This constructor allows the parameter for the runnable to sleep after handleRunStart() was called and before handleRunFinish() is called.
    
    Parameters:
    
    runTimeInMillis - time for runnable to sleep in milliseconds
- Method Detail
  - setRunDelayInMillis
```
public void setRunDelayInMillis(int runDelayInMillis)
```
    Changes the amount of time the runnable will sleep/block when called. This change will only be for future run calls that are not already blocking.
    
    Parameters:
    
    runDelayInMillis - new amount to wait when run is called
  - getRunDelayInMillis
```
public int getRunDelayInMillis()
```
    Getter for the currently set amount of time the TestRunnable will block after handleRunStart() and before handleRunFinish() is called.
    
    Returns:
    
    current set sleep time in milliseconds
  - getCreationTime
```
public long getCreationTime()
```
    Returns the millis returned from Clock.accurateForwardProgressingMillis(), that was recorded when this runnable was constructed.
    
    Returns:
    
    Forward progressing time in milliseconds TestRunnable was constructed
  - ranConcurrently
```
public boolean ranConcurrently()
```
    Check if this instance has ever been detected to run concurrently. Keep in mind that just because this call returns false does not guarantee the runnable is incapable of running parallel. It does it's best to detect a situation where it is started while another instance has not returned from the run function. Adding a delay in handleRunStart(), handleRunFinish(), or in the constructor increases the chances of detecting concurrency.
    
    Returns:
    
    True if this instance ran in parallel at least once
  - ranOnce
```
public boolean ranOnce()
```
    Getter to check if the runnable has run exactly once.
    
    Returns:
    
    true if the runnable has been called once
  - isRunning
```
public boolean isRunning()
```
    Check to see if the run function has started but has not completed returned yet.
    
    Returns:
    
    True if the runnable's run function is being called currently.
  - getRunCount
```
public int getRunCount()
```
    Getter for the number of times the run function has completed.
    
    Returns:
    
    The number of times the run function has been called
  - getDelayTillFirstRun
```
public long getDelayTillFirstRun()
```
    This function blocks till the first run completes then will return the time until the first run started it's call.
    
    Returns:
    
    The amount of time between construction and run being called
  - getDelayTillRun
```
public long getDelayTillRun(int runNumber)
```
    This function blocks till the run provided, and then gets the time between creation and a given run.
    
    Parameters:
    
    runNumber - the run count to get delay to
    
    Returns:
    
    The amount of time between construction and run being called
  - getDelayTillRun
```
public long getDelayTillRun(int runNumber,
                            int timeout)
```
    This function blocks till the run provided, and then gets the time between creation and a given run.
    
    Parameters:
    
    runNumber - the run count to get delay to
    
    timeout - timeout to wait for given run count to finish
    
    Returns:
    
    The amount of time between construction and run being called
  - blockTillFinished
```
public void blockTillFinished()
```
    Blocks until run has completed at least once. Will throw an exception if runnable does not run within 10 seconds.
  - blockTillFinished
```
public void blockTillFinished(int timeout)
```
    Blocks until run has completed at least once.
    
    Parameters:
    
    timeout - time to wait for run to be called before throwing exception
  - blockTillFinished
```
public void blockTillFinished(int timeout,
                              int expectedRunCount)
```
    Blocks until run completed been called the provided quantity of times.
    
    Parameters:
    
    timeout - time to wait for run to be called before throwing exception
    
    expectedRunCount - run count to wait for
  - blockTillStarted
```
public void blockTillStarted()
```
    Blocks until run has been called at least once. Will throw an exception if run is not called within 10 seconds.
  - blockTillStarted
```
public void blockTillStarted(int timeout)
```
    Blocks until run has been called at least once.
    
    Parameters:
    
    timeout - time to wait for run to be called before throwing exception
  - run
```
public final void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - handleRunStart
```
public void handleRunStart()
                    throws java.lang.InterruptedException
```
    Function to be overloaded by extending classes if more data or operations need to happen at the run point.
    This is also the first call to be made in the runnable, but all necessary TestRunnable actions are in a finally block so it is safe to throw any exceptions necessary here.
    
    Throws:
    
    java.lang.InterruptedException - only InterruptedExceptions will be swallowed
  - handleRunFinish
```
public void handleRunFinish()
```
    Function to be overloaded by extending classes if more data or operations need to happen at the run point.
    This is the last call to be made in the runnable. If you want a RuntimeException to get thrown to the caller, it must be thrown from here.

Class TestRunnable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestRunnable

TestRunnable

Method Detail

setRunDelayInMillis

getRunDelayInMillis

getCreationTime

ranConcurrently

ranOnce

isRunning

getRunCount

getDelayTillFirstRun

getDelayTillRun

getDelayTillRun

blockTillFinished

blockTillFinished

blockTillFinished

blockTillStarted

blockTillStarted

run

handleRunStart

handleRunFinish