Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ExclusiveResource.LockMode `LockMode` translates to the respective `ReadWriteLock` locks.

Field Summary

Modifier and Type	Field and Description
public static final 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.
pack-priv static final ExclusiveResource	GLOBAL_READ
pack-priv static final ExclusiveResource	GLOBAL_READ_WRITE
private int	hash
private final String	key
private final ExclusiveResource.LockMode	lockMode

Constructor Summary

Access	Constructor and Description
public	ExclusiveResource(String the identifier of the resource; never `null` or blank key, ExclusiveResource.LockMode the lock mode to use to synchronize access to the resource; never `null` lockMode) Create a new `ExclusiveResource`.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getKey() Get the key of this resource.
public ExclusiveResource.LockMode	getLockMode() Get the lock mode of this resource.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

GLOBAL_KEY	back to summary
public static final 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. Annotations @API status:STABLE since:1.10 Since 1.7

GLOBAL_KEY

back to summary

public static final 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.

Annotations

@API
status:STABLE
since:1.10

Since: 1.7

GLOBAL_READ	back to summary
pack-priv static final ExclusiveResource GLOBAL_READ

GLOBAL_READ_WRITE	back to summary
pack-priv static final ExclusiveResource GLOBAL_READ_WRITE

hash	back to summary
private int hash

key	back to summary
private final String key

lockMode	back to summary
private final ExclusiveResource.LockMode lockMode

Constructor Detail

ExclusiveResource back to summary

ExclusiveResource	back to summary
public ExclusiveResource(String key, ExclusiveResource.LockMode lockMode) Create a new `ExclusiveResource`. Parameters key:String the identifier of the resource; never `null` or blank lockMode:ExclusiveResource.LockMode the lock mode to use to synchronize access to the resource; never `null`

public ExclusiveResource(String key, ExclusiveResource.LockMode lockMode)

Create a new ExclusiveResource.

Parameters

key:String: the identifier of the resource; never null or blank
lockMode:ExclusiveResource.LockMode: the lock mode to use to synchronize access to the resource; never null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getKey	back to summary
public String getKey() Get the key of this resource.

getLockMode	back to summary
public ExclusiveResource.LockMode getLockMode() Get the lock mode of this resource.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

org.junit.platform.engine.support.hierarchical back to summary

public final Enum ExclusiveResource.LockMode

Class Inheritance

extends Enum<ExclusiveResource.LockMode>

java.lang.Object
java.lang.Enum
org.junit.platform.engine.support.hierarchical.ExclusiveResource.LockMode

LockMode translates to the respective ReadWriteLock locks.

Implementation Note

Enum order is important, since it can be used to sort locks, so the stronger mode has to be first.

Field Summary

Modifier and Type	Field and Description
public static final ExclusiveResource.LockMode	READ Require only read access to the resource.
public static final ExclusiveResource.LockMode	READ_WRITE Require read and write access to the resource.

Constructor Summary

Access	Constructor and Description
private	LockMode()

Method Summary

Modifier and Type	Method and Description
public static ExclusiveResource.LockMode	valueOf(String name)
public static ExclusiveResource.LockMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

READ back to summary

READ	back to summary
public static final ExclusiveResource.LockMode READ Require only read access to the resource. See Also `ReadWriteLock#readLock()`

public static final ExclusiveResource.LockMode READ

Require only read access to the resource.

See Also: ReadWriteLock#readLock()

READ_WRITE back to summary

READ_WRITE	back to summary
public static final ExclusiveResource.LockMode READ_WRITE Require read and write access to the resource. See Also `ReadWriteLock#writeLock()`

public static final ExclusiveResource.LockMode READ_WRITE

Require read and write access to the resource.

See Also: ReadWriteLock#writeLock()

Constructor Detail

LockMode	back to summary
private LockMode()

Method Detail

valueOf	back to summary
public static ExclusiveResource.LockMode valueOf(String name)

values	back to summary
public static ExclusiveResource.LockMode[] values()

public Class ExclusiveResource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ExclusiveResource.LockMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail