AtomicAny

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def :=(value: T): Unit

   

   Alias for set().

   Alias for set(). Updates the current value.

   value

   will be the new value returned by get()

   Definition Classes

   AtomicAny → Atomic

4. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

5. def apply(): T

   
   returns

   the current value persisted by this Atomic, an alias for get()

   Definition Classes

   Atomic

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def compareAndSet(expect: T, update: T): Boolean

   

   Does a compare-and-set operation on the current value.

   Does a compare-and-set operation on the current value. For more info, checkout the related Compare-and-swap Wikipedia page.

   It's an atomic, worry free operation.

   expect

   is the value you expect to be persisted when the operation happens

   update

   will be the new value, should the check for expect succeeds

   returns

   either true in case the operation succeeded or false otherwise

   Definition Classes

   AtomicAny → Atomic

9. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def get: T

    
    returns

    the current value persisted by this Atomic

    Definition Classes

    AtomicAny → Atomic

13. def getAndSet(update: T): T

    

    Sets the persisted value to update and returns the old value that was in place.

    Sets the persisted value to update and returns the old value that was in place. It's an atomic, worry free operation.

    Definition Classes

    AtomicAny → Atomic

14. def getAndTransform(cb: (T) ⇒ T): T

    

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

    returns

    the old value, just prior to when the successful update happened

    Definition Classes

    AtomicAny → Atomic

    Annotations

    @tailrec()

15. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. def lazySet(update: T): Unit

    

    Eventually sets to the given value.

    Eventually sets to the given value. Has weaker visibility guarantees than the normal set().

    Definition Classes

    AtomicAny → Atomic

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. def set(update: T): Unit

    

    Updates the current value.

    Updates the current value.

    update

    will be the new value returned by get()

    Definition Classes

    AtomicAny → Atomic

23. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

24. def toString(): String

    

    Definition Classes

    AnyRef → Any

25. def transform(cb: (T) ⇒ T): Unit

    

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

    Definition Classes

    AtomicAny → Atomic

    Annotations

    @tailrec()

26. def transformAndExtract[U](cb: (T) ⇒ (U, T)): U

    

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by your callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns a tuple that specifies the update + what should this method return when the operation succeeds.

    returns

    whatever was specified by your callback, once the operation succeeds

    Definition Classes

    AtomicAny → Atomic

    Annotations

    @tailrec()

27. def transformAndGet(cb: (T) ⇒ T): T

    

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

    returns

    whatever the update is, after the operation succeeds

    Definition Classes

    AtomicAny → Atomic

    Annotations

    @tailrec()

28. def update(value: T): Unit

    

    Alias for set().

    Alias for set(). Updates the current value.

    value

    will be the new value returned by get()

    Definition Classes

    AtomicAny → Atomic

29. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

30. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. def waitForCompareAndSet(expect: T, update: T, waitAtMost: FiniteDuration): Unit

    

    Waits until the compareAndSet operation succeeds, e.g...

    Waits until the compareAndSet operation succeeds, e.g... 1. until the old value == expected and the operation succeeds, or 2. until the current thread is interrupted, or 3. the specified timeout is due

    So this can throw an exception on timeout, useful for when you want to insure that you don't block the current thread ad infinitum

    waitAtMost

    specifies the timeout, after which this method throws a TimeoutException

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @throws( classOf[InterruptedException] ) @throws( classOf[TimeoutException] )

33. def waitForCompareAndSet(expect: T, update: T, maxRetries: Int): Boolean

    

    Waits until the compareAndSet operation succeeds, e.g...

    Waits until the compareAndSet operation succeeds, e.g...

    1. until the old value == expected and the operation succeeds, or 2. until the current thread is interrupted 3. until the the spin lock retried for a maximum of maxRetries

    expect

    the expected current value

    update

    the value to replace the current value

    maxRetries

    the maximum number of times to retry in case of failure

    returns

    true if the operation succeeded or false in case it failed after it retried for maxRetries times

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @tailrec() @throws( classOf[InterruptedException] )

34. def waitForCompareAndSet(expect: T, update: T): Unit

    

    Waits until the compareAndSet operation succeeds, e.g...

    Waits until the compareAndSet operation succeeds, e.g... 1. until the old value == expected and the operation succeeds, or 2. until the current thread is interrupted

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @tailrec() @throws( classOf[InterruptedException] )

35. def waitForCondition(waitAtMost: FiniteDuration, p: (T) ⇒ Boolean): Unit

    

    Waits until the specified callback, that receives the current value, returns true.

    Waits until the specified callback, that receives the current value, returns true. Throws a TimeoutException in case the specified waitAtMost timeout is due.

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @throws( classOf[InterruptedException] ) @throws( classOf[TimeoutException] )

36. def waitForCondition(p: (T) ⇒ Boolean): Unit

    

    Waits until the specified callback, that receives the current value, returns true.

    Waits until the specified callback, that receives the current value, returns true.

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @tailrec() @throws( classOf[InterruptedException] )

37. def waitForValue(expect: T, waitAtMost: FiniteDuration): Unit

    

    Waits until the specified expect value == the value stored by this Atomic reference or until the current thread gets interrupted.

    Waits until the specified expect value == the value stored by this Atomic reference or until the current thread gets interrupted.

    This can throw an exception on timeout, useful for when you want to insure that you don't block the current thread ad infinitum

    waitAtMost

    specifies the timeout, after which this method throws a TimeoutException

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @throws( classOf[InterruptedException] ) @throws( classOf[TimeoutException] )

38. def waitForValue(expect: T): Unit

    

    Waits until the specified expect value == the value stored by this Atomic reference or until the current thread gets interrupted.

    Waits until the specified expect value == the value stored by this Atomic reference or until the current thread gets interrupted.

    Definition Classes

    AtomicAny → BlockableAtomic

    Annotations

    @tailrec() @throws( classOf[InterruptedException] )