AtomicFloat

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def +=(v: Float): Unit

   

   Definition Classes

   AtomicFloat → AtomicNumber

4. def -=(v: Float): Unit

   

   Definition Classes

   AtomicFloat → AtomicNumber

5. def :=(value: Float): Unit

   

   Alias for set().

   Alias for set(). Updates the current value.

   value

   will be the new value returned by get()

   Definition Classes

   AtomicFloat → Atomic

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

   

   Definition Classes

   AnyRef → Any

7. def add(v: Float): Unit

   

   Definition Classes

   AtomicFloat → AtomicNumber

   Annotations

   @tailrec()

8. def addAndGet(v: Float): Float

   

   Definition Classes

   AtomicFloat → AtomicNumber

   Annotations

   @tailrec()

9. def apply(): Float

   
   returns

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

   Definition Classes

   Atomic

10. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. def compareAndSet(expect: Float, update: Float): 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

    AtomicFloat → Atomic

13. def countDownToZero(v: Float = 1.0f): Float

    

    Decrements this number until it reaches zero.

    Decrements this number until it reaches zero.

    returns

    a number representing how much it was able to subtract, which is a value between zero and v

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

14. def decrement(v: Int = 1): Unit

    

    Definition Classes

    AtomicFloat → AtomicNumber

15. def decrementAndGet(v: Int = 1): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

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

    

    Definition Classes

    AnyRef

17. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

19. def get: Float

    
    returns

    the current value persisted by this Atomic

    Definition Classes

    AtomicFloat → Atomic

20. def getAndAdd(v: Float): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

21. def getAndDecrement(v: Int = 1): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

22. def getAndIncrement(v: Int = 1): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

23. def getAndSet(update: Float): Float

    

    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

    AtomicFloat → Atomic

24. def getAndSubtract(v: Float): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

25. def getAndTransform(cb: (Float) ⇒ Float): Float

    

    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

    AtomicFloat → Atomic

    Annotations

    @tailrec()

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

    

    Definition Classes

    AnyRef → Any

27. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

28. def increment(v: Int = 1): Unit

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

29. def incrementAndGet(v: Int = 1): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

30. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

31. def lazySet(update: Float): Unit

    

    Eventually sets to the given value.

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

    Definition Classes

    AtomicFloat → Atomic

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

    

    Definition Classes

    AnyRef

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

35. def set(update: Float): Unit

    

    Updates the current value.

    Updates the current value.

    update

    will be the new value returned by get()

    Definition Classes

    AtomicFloat → Atomic

36. def subtract(v: Float): Unit

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

37. def subtractAndGet(v: Float): Float

    

    Definition Classes

    AtomicFloat → AtomicNumber

    Annotations

    @tailrec()

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

    

    Definition Classes

    AnyRef

39. def toString(): String

    

    Definition Classes

    AnyRef → Any

40. def transform(cb: (Float) ⇒ Float): 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

    AtomicFloat → Atomic

    Annotations

    @tailrec()

41. def transformAndExtract[U](cb: (Float) ⇒ (U, Float)): 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

    AtomicFloat → Atomic

    Annotations

    @tailrec()

42. def transformAndGet(cb: (Float) ⇒ Float): Float

    

    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

    AtomicFloat → Atomic

    Annotations

    @tailrec()

43. def update(value: Float): Unit

    

    Alias for set().

    Alias for set(). Updates the current value.

    value

    will be the new value returned by get()

    Definition Classes

    AtomicFloat → Atomic

44. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

47. def waitForCompareAndSet(expect: Float, update: Float, 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

    AtomicFloat → BlockableAtomic

    Annotations

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

48. def waitForCompareAndSet(expect: Float, update: Float, 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

    AtomicFloat → BlockableAtomic

    Annotations

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

49. def waitForCompareAndSet(expect: Float, update: Float): 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

    AtomicFloat → BlockableAtomic

    Annotations

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

50. def waitForCondition(waitAtMost: FiniteDuration, p: (Float) ⇒ 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

    AtomicFloat → BlockableAtomic

    Annotations

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

51. def waitForCondition(p: (Float) ⇒ 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

    AtomicFloat → BlockableAtomic

    Annotations

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

52. def waitForValue(expect: Float, 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

    AtomicFloat → BlockableAtomic

    Annotations

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

53. def waitForValue(expect: Float): 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

    AtomicFloat → BlockableAtomic

    Annotations

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