org.junit.platform.engine.support.hierarchical

Class ExclusiveResource

java.lang.Object

org.junit.platform.engine.support.hierarchical.ExclusiveResource

@API(status=STABLE,
     since="1.10")
public class ExclusiveResource
extends java.lang.Object

An exclusive resource identified by a key with a lock mode that is used to synchronize access to shared resources when executing nodes in parallel.

Since:

1.3

See Also:

Node.getExecutionMode()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExclusiveResource.LockMode LockMode translates to the respective ReadWriteLock locks.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBAL_KEY Key of the global resource lock that all direct children of the engine descriptor acquire in read mode by default: "org.junit.platform.engine.support.hierarchical.ExclusiveResource.GLOBAL_KEY"
(package private) static ExclusiveResource	GLOBAL_READ
(package private) static ExclusiveResource	GLOBAL_READ_WRITE
private int	hash
private java.lang.String	key
private ExclusiveResource.LockMode	lockMode

Constructor Summary

Constructors

Constructor and Description
ExclusiveResource(java.lang.String key, ExclusiveResource.LockMode lockMode) Create a new ExclusiveResource.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getKey() Get the key of this resource.
ExclusiveResource.LockMode	getLockMode() Get the lock mode of this resource.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GLOBAL_KEY

@API(status=STABLE,
     since="1.10")
public static final java.lang.String GLOBAL_KEY

Key of the global resource lock that all direct children of the engine descriptor acquire in read mode by default: "org.junit.platform.engine.support.hierarchical.ExclusiveResource.GLOBAL_KEY"

If any node requires an exclusive resource with the same key in read-write mode, the lock will be coarsened to be acquired by the node's ancestor that is a direct child of the engine descriptor and all of the ancestor's descendants will be forced to run in the same thread.

Since:

1.7

See Also:

Constant Field Values

GLOBAL_READ

static final ExclusiveResource GLOBAL_READ

GLOBAL_READ_WRITE

static final ExclusiveResource GLOBAL_READ_WRITE

key

private final java.lang.String key

lockMode

private final ExclusiveResource.LockMode lockMode

hash

private int hash

Constructor Detail

ExclusiveResource

public ExclusiveResource(java.lang.String key,
                         ExclusiveResource.LockMode lockMode)

Create a new ExclusiveResource.

Parameters:

key - the identifier of the resource; never null or blank

lockMode - the lock mode to use to synchronize access to the resource; never null

Method Detail

getKey

public java.lang.String getKey()

Get the key of this resource.

getLockMode

public ExclusiveResource.LockMode getLockMode()

Get the lock mode of this resource.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object