com.vmlens.api

Class AllInterleavings

java.lang.Object

com.vmlens.api.AllInterleavings

All Implemented Interfaces:

AutoCloseable

public class AllInterleavings
extends Object
implements AutoCloseable

The class AllInterleavings let you test all thread interleavings for your test. Enclose your test in a while loop to iterate through all thread interleavings like in the following example:

 
 try (AllInterleavings allInterleavings = 
    new AllInterleavings("ConcurrencyTestUniqueId");) {
    while (allInterleavings.hasNext()) {
        firstId  = 0L;
        secondId = 0L;
        UniqueId uniqueId = new UniqueId();
        Thread first = new Thread(() -> {
            firstId = uniqueId.nextId();
        });
        first.start();
        secondId = uniqueId.nextId();
        first.join();
        assertTrue(firstId != secondId);
    }
  }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
int	maximumRuns see AllInterleavingsBuilder.maximumRuns(int) for a description and how to set this value.
int	maximumSynchronizationActionsPerThread see AllInterleavingsBuilder.maximumSynchronizationActionsPerThread(int) for a description and how to set this value.
String	name The name shown in the interleave report.
Class[]	removeAtomicAnnotationFromClassArray see AllInterleavingsBuilder.removeAtomicAnnotation(java.lang.Class) for a description and how to set this value.
boolean	showNonVolatileSharedMemoryAccess see AllInterleavingsBuilder.showNonVolatileSharedMemoryAccess for a description and how to set this value.
boolean	showStatementsInExecutor see AllInterleavingsBuilder.showStatementsInExecutor for a description and how to set this value.
boolean	showStatementsWhenSingleThreaded see AllInterleavingsBuilder.showStatementsWhenSingleThreaded for a description and how to set this value.

Constructor Summary

Constructors

Constructor and Description
AllInterleavings(String name) Creates a new AllInterleavings instance.

Method Summary

Modifier and Type	Method and Description
static AllInterleavingsBuilder	builder(String name) Create a new AllInterleavingsBuilder.
void	close() closes this instance
boolean	hasNext() Return true if there are still thread interleavings to be executed and select the next thread interleaving.

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

The name shown in the interleave report.

showStatementsWhenSingleThreaded

public final boolean showStatementsWhenSingleThreaded

see AllInterleavingsBuilder.showStatementsWhenSingleThreaded for a description and how to set this value.

showStatementsInExecutor

public final boolean showStatementsInExecutor

see AllInterleavingsBuilder.showStatementsInExecutor for a description and how to set this value.

showNonVolatileSharedMemoryAccess

public final boolean showNonVolatileSharedMemoryAccess

see AllInterleavingsBuilder.showNonVolatileSharedMemoryAccess for a description and how to set this value.

maximumRuns

public final int maximumRuns

see AllInterleavingsBuilder.maximumRuns(int) for a description and how to set this value.

maximumSynchronizationActionsPerThread

public final int maximumSynchronizationActionsPerThread

see AllInterleavingsBuilder.maximumSynchronizationActionsPerThread(int) for a description and how to set this value.

removeAtomicAnnotationFromClassArray

public final Class[] removeAtomicAnnotationFromClassArray

see AllInterleavingsBuilder.removeAtomicAnnotation(java.lang.Class) for a description and how to set this value.

Constructor Detail

AllInterleavings

public AllInterleavings(String name)

Creates a new AllInterleavings instance. To set non default values use AllInterleavingsBuilder

Parameters:

name - The name shown in the interleave report.

Method Detail

builder

public static AllInterleavingsBuilder builder(String name)

Create a new AllInterleavingsBuilder.

Parameters:

name - The name shown in the interleave report.

Returns:

A new AllInterleavingsBuilder

hasNext

public boolean hasNext()

Return true if there are still thread interleavings to be executed and select the next thread interleaving. Otherwise returns false.

Returns:

true if there are still thread interleavings to be executed otherwise false.

close

public void close()

closes this instance

Specified by:

close in interface AutoCloseable