Module org.junit.jupiter.api

Package org.junit.jupiter.api.parallel

Class ResourceLocksProvider.Lock

java.lang.Object

org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock

Enclosing interface:

ResourceLocksProvider

public static final class ResourceLocksProvider.Lock
extends Object

Lock represents a shared resource.

Each resource is identified by a key. In addition, the access mode allows one to specify whether a test class or test method requires READ_WRITE or READ access to the resource.

Since:

5.12

See Also:

• Isolated
• Resources
• ResourceAccessMode
• ResourceLock
• ResourceLocksProvider

API Note:

getKey() and getAccessMode() have the same semantics as ResourceLock.value() and ResourceLock.mode() respectively.

Constructor Summary

Constructors

Constructor	Description
Lock(String key)	Create a new Lock with ResourceAccessMode.READ_WRITE.
Lock(String key, ResourceAccessMode accessMode)	Create a new Lock.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ResourceAccessMode	getAccessMode()	Get the access mode for this lock.
String	getKey()	Get the key for this lock.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Lock

public Lock(String key)

Create a new Lock with ResourceAccessMode.READ_WRITE.

Parameters:

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

See Also:

• ResourceLock.value()

Lock

public Lock(String key,
 ResourceAccessMode accessMode)

Create a new Lock.

Parameters:

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

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

See Also:

• ResourceLock.value()
• ResourceLock.mode()

Method Details

getKey

public String getKey()

Get the key for this lock.

See Also:

• ResourceLock.value()

getAccessMode

public ResourceAccessMode getAccessMode()

Get the access mode for this lock.

See Also:

• ResourceLock.mode()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object