Interface AtomicLong

  • All Known Implementing Classes:
    LocalAtomicLong, RemoteAtomicLong

    public interface AtomicLong
    A long value that may be updated atomically.

    An AtomicLong is used in applications such as atomically incremented sequence numbers, and cannot be used as a replacement for a Long.

    Since:
    21.12
    Author:
    Aleks Seovic 2020.12.03
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  AtomicLong.Serializer
      POF serializer implementation.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long accumulateAndGet​(long lUpdate, Remote.LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
      long accumulateAndGet​(long lUpdate, LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
      long addAndGet​(long lDelta)
      Atomically adds the given value to the current value.
      AsyncAtomicLong async()
      Return non-blocking API for this atomic value.
      byte byteValue()
      Returns the current value of this AtomicLong as a byte after a narrowing primitive conversion.
      long compareAndExchange​(long lExpectedValue, long lNewValue)
      Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
      boolean compareAndSet​(long lExpectedValue, long lNewValue)
      Atomically sets the value to newValue if the current value == expectedValue.
      long decrementAndGet()
      Atomically decrements the current value.
      double doubleValue()
      Returns the current value of this AtomicLong as a double after a widening primitive conversion.
      float floatValue()
      Returns the current value of this AtomicLong as a float after a widening primitive conversion.
      long get()
      Returns the current value.
      long getAndAccumulate​(long lUpdate, Remote.LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
      long getAndAccumulate​(long lUpdate, LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
      long getAndAdd​(long lDelta)
      Atomically adds the given value to the current value.
      long getAndDecrement()
      Atomically decrements the current value.
      long getAndIncrement()
      Atomically increments the current value.
      long getAndSet​(long lNewValue)
      Atomically sets the value to newValue and returns the old value.
      long getAndUpdate​(Remote.LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the previous value.
      long getAndUpdate​(LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the previous value.
      long incrementAndGet()
      Atomically increments the current value.
      int intValue()
      Returns the current value of this AtomicLong as an int after a narrowing primitive conversion.
      long longValue()
      Returns the current value of this AtomicLong as a long.
      void set​(long lNewValue)
      Sets the value to newValue.
      short shortValue()
      Returns the current value of this AtomicLong as a short after a narrowing primitive conversion.
      long updateAndGet​(Remote.LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the updated value.
      long updateAndGet​(LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the updated value.
    • Method Detail

      • async

        AsyncAtomicLong async()
        Return non-blocking API for this atomic value.
        Returns:
        non-blocking API for this atomic value
      • get

        long get()
        Returns the current value.
        Returns:
        the current value
      • set

        void set​(long lNewValue)
        Sets the value to newValue.
        Parameters:
        lNewValue - the new value
      • getAndSet

        long getAndSet​(long lNewValue)
        Atomically sets the value to newValue and returns the old value.
        Parameters:
        lNewValue - the new value
        Returns:
        the previous value
      • compareAndSet

        boolean compareAndSet​(long lExpectedValue,
                              long lNewValue)
        Atomically sets the value to newValue if the current value == expectedValue.
        Parameters:
        lExpectedValue - the expected value
        lNewValue - the new value
        Returns:
        true if successful. False return indicates that the actual value was not equal to the expected value.
      • getAndIncrement

        long getAndIncrement()
        Atomically increments the current value.

        Equivalent to getAndAdd(1).

        Returns:
        the previous value
      • getAndDecrement

        long getAndDecrement()
        Atomically decrements the current value.

        Equivalent to getAndAdd(-1).

        Returns:
        the previous value
      • getAndAdd

        long getAndAdd​(long lDelta)
        Atomically adds the given value to the current value.
        Parameters:
        lDelta - the value to add
        Returns:
        the previous value
      • incrementAndGet

        long incrementAndGet()
        Atomically increments the current value.

        Equivalent to addAndGet(1).

        Returns:
        the updated value
      • decrementAndGet

        long decrementAndGet()
        Atomically decrements the current value.

        Equivalent to addAndGet(-1).

        Returns:
        the updated value
      • addAndGet

        long addAndGet​(long lDelta)
        Atomically adds the given value to the current value.
        Parameters:
        lDelta - the value to add
        Returns:
        the updated value
      • getAndUpdate

        long getAndUpdate​(Remote.LongUnaryOperator updateFunction)
        Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value
      • getAndUpdate

        long getAndUpdate​(LongUnaryOperator updateFunction)
        Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value
      • updateAndGet

        long updateAndGet​(Remote.LongUnaryOperator updateFunction)
        Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value
      • updateAndGet

        long updateAndGet​(LongUnaryOperator updateFunction)
        Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value
      • getAndAccumulate

        long getAndAccumulate​(long lUpdate,
                              Remote.LongBinaryOperator accumulatorFunction)
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

        The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value
      • getAndAccumulate

        long getAndAccumulate​(long lUpdate,
                              LongBinaryOperator accumulatorFunction)
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

        The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value
      • accumulateAndGet

        long accumulateAndGet​(long lUpdate,
                              Remote.LongBinaryOperator accumulatorFunction)
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

        The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value
      • accumulateAndGet

        long accumulateAndGet​(long lUpdate,
                              LongBinaryOperator accumulatorFunction)
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

        The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value
      • compareAndExchange

        long compareAndExchange​(long lExpectedValue,
                                long lNewValue)
        Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
        Parameters:
        lExpectedValue - the expected value
        lNewValue - the new value
        Returns:
        the witness value, which will be the same as the expected value if successful
      • intValue

        int intValue()
        Returns the current value of this AtomicLong as an int after a narrowing primitive conversion.
        Returns:
        the numeric value represented by this object after conversion to type int
      • longValue

        long longValue()
        Returns the current value of this AtomicLong as a long.
        Returns:
        the numeric value represented by this object
      • floatValue

        float floatValue()
        Returns the current value of this AtomicLong as a float after a widening primitive conversion.
        Returns:
        the numeric value represented by this object after conversion to type float
      • doubleValue

        double doubleValue()
        Returns the current value of this AtomicLong as a double after a widening primitive conversion.
        Returns:
        the numeric value represented by this object after conversion to type double
      • byteValue

        byte byteValue()
        Returns the current value of this AtomicLong as a byte after a narrowing primitive conversion.
        Returns:
        the numeric value represented by this object after conversion to type byte
      • shortValue

        short shortValue()
        Returns the current value of this AtomicLong as a short after a narrowing primitive conversion.
        Returns:
        the numeric value represented by this object after conversion to type short