stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8302360: Atomic*.compareAndExchange Javadoc unclear

Browse Source 
Reviewed-by: martin, dholmes
This commit is contained in:
Viktor Klang 2023-03-10 00:31:04 +00:00 committed by Martin Buchholz
parent 8b740b4609
commit d06308c54a
8 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/java.base/share/classes/java/lang/invoke/VarHandle.java
View File

@ -806,7 +806,7 @@ public abstract sealed class VarHandle implements Constable
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return {@code true} if successful, otherwise {@code false} if the
* witness value was not the same as the {@code expectedValue}.
* <em>witness value</em> was not the same as the {@code expectedValue}.
* @throws UnsupportedOperationException if the access mode is unsupported
* for this VarHandle.
* @throws WrongMethodTypeException if the access mode type does not
@ -839,7 +839,7 @@ public abstract sealed class VarHandle implements Constable
* @param args the signature-polymorphic parameter list of the form
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return the signature-polymorphic result that is the witness value, which
* @return the signature-polymorphic result that is the <em>witness value</em>, which
* will be the same as the {@code expectedValue} if successful
* , statically represented using {@code Object}.
* @throws UnsupportedOperationException if the access mode is unsupported
@ -874,7 +874,7 @@ public abstract sealed class VarHandle implements Constable
* @param args the signature-polymorphic parameter list of the form
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return the signature-polymorphic result that is the witness value, which
* @return the signature-polymorphic result that is the <em>witness value</em>, which
* will be the same as the {@code expectedValue} if successful
* , statically represented using {@code Object}.
* @throws UnsupportedOperationException if the access mode is unsupported
@ -909,7 +909,7 @@ public abstract sealed class VarHandle implements Constable
* @param args the signature-polymorphic parameter list of the form
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return the signature-polymorphic result that is the witness value, which
* @return the signature-polymorphic result that is the <em>witness value</em>, which
* will be the same as the {@code expectedValue} if successful
* , statically represented using {@code Object}.
* @throws UnsupportedOperationException if the access mode is unsupported
@ -936,7 +936,7 @@ public abstract sealed class VarHandle implements Constable
* {@link #get}.
*
* <p>This operation may fail spuriously (typically, due to memory
* contention) even if the witness value does match the expected value.
* contention) even if the <em>witness value</em> does match the expected value.
*
* <p>The method signature is of the form {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)boolean}.
*
@ -949,7 +949,7 @@ public abstract sealed class VarHandle implements Constable
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return {@code true} if successful, otherwise {@code false} if the
* witness value was not the same as the {@code expectedValue} or if this
* <em>witness value</em> was not the same as the {@code expectedValue} or if this
* operation spuriously failed.
* @throws UnsupportedOperationException if the access mode is unsupported
* for this VarHandle.
@ -973,7 +973,7 @@ public abstract sealed class VarHandle implements Constable
* {@link #getVolatile}.
*
* <p>This operation may fail spuriously (typically, due to memory
* contention) even if the witness value does match the expected value.
* contention) even if the <em>witness value</em> does match the expected value.
*
* <p>The method signature is of the form {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)boolean}.
*
@ -986,7 +986,7 @@ public abstract sealed class VarHandle implements Constable
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return {@code true} if successful, otherwise {@code false} if the
* witness value was not the same as the {@code expectedValue} or if this
* <em>witness value</em> was not the same as the {@code expectedValue} or if this
* operation spuriously failed.
* @throws UnsupportedOperationException if the access mode is unsupported
* for this VarHandle.
@ -1010,7 +1010,7 @@ public abstract sealed class VarHandle implements Constable
* {@link #getAcquire}.
*
* <p>This operation may fail spuriously (typically, due to memory
* contention) even if the witness value does match the expected value.
* contention) even if the <em>witness value</em> does match the expected value.
*
* <p>The method signature is of the form {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)boolean}.
*
@ -1024,7 +1024,7 @@ public abstract sealed class VarHandle implements Constable
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return {@code true} if successful, otherwise {@code false} if the
* witness value was not the same as the {@code expectedValue} or if this
* <em>witness value</em> was not the same as the {@code expectedValue} or if this
* operation spuriously failed.
* @throws UnsupportedOperationException if the access mode is unsupported
* for this VarHandle.
@ -1048,7 +1048,7 @@ public abstract sealed class VarHandle implements Constable
* {@link #get}.
*
* <p>This operation may fail spuriously (typically, due to memory
* contention) even if the witness value does match the expected value.
* contention) even if the <em>witness value</em> does match the expected value.
*
* <p>The method signature is of the form {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)boolean}.
*
@ -1062,7 +1062,7 @@ public abstract sealed class VarHandle implements Constable
* {@code (CT1 ct1, ..., CTn ctn, T expectedValue, T newValue)}
* , statically represented using varargs.
* @return {@code true} if successful, otherwise {@code false} if the
* witness value was not the same as the {@code expectedValue} or if this
* <em>witness value</em> was not the same as the {@code expectedValue} or if this
* operation spuriously failed.
* @throws UnsupportedOperationException if the access mode is unsupported
* for this VarHandle.

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicBoolean.java
View File

@ -260,7 +260,7 @@ public class AtomicBoolean implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -278,7 +278,7 @@ public class AtomicBoolean implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -296,7 +296,7 @@ public class AtomicBoolean implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicInteger.java
View File

@ -465,7 +465,7 @@ public class AtomicInteger extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -481,7 +481,7 @@ public class AtomicInteger extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -497,7 +497,7 @@ public class AtomicInteger extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicIntegerArray.java
View File

@ -470,7 +470,7 @@ public class AtomicIntegerArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -488,7 +488,7 @@ public class AtomicIntegerArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -506,7 +506,7 @@ public class AtomicIntegerArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicLong.java
View File

@ -478,7 +478,7 @@ public class AtomicLong extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -494,7 +494,7 @@ public class AtomicLong extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -510,7 +510,7 @@ public class AtomicLong extends Number implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicLongArray.java
View File

@ -470,7 +470,7 @@ public class AtomicLongArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -488,7 +488,7 @@ public class AtomicLongArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -506,7 +506,7 @@ public class AtomicLongArray implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicReference.java
View File

@ -353,7 +353,7 @@ public class AtomicReference<V> implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -369,7 +369,7 @@ public class AtomicReference<V> implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -385,7 +385,7 @@ public class AtomicReference<V> implements java.io.Serializable {
*
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/

6
src/java.base/share/classes/java/util/concurrent/atomic/AtomicReferenceArray.java
View File

@ -434,7 +434,7 @@ public class AtomicReferenceArray<E> implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -452,7 +452,7 @@ public class AtomicReferenceArray<E> implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/
@ -470,7 +470,7 @@ public class AtomicReferenceArray<E> implements java.io.Serializable {
* @param i the index
* @param expectedValue the expected value
* @param newValue the new value
* @return the witness value, which will be the same as the
* @return the <em>witness value</em>, which will be the same as the
* expected value if successful
* @since 9
*/