org.apache.flink.runtime.util

Class AtomicEnum<T extends Enum<T>>

java.lang.Object

org.apache.flink.runtime.util.AtomicEnum<T>

public final class AtomicEnum<T extends Enum<T>>
extends Object

Auxiliary class which provides atomic operations on enumerations. Internally, the class uses an AtomicReference object to guarantee the atomicity.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
AtomicEnum(T initialValue) Constructs a new atomic enumeration object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compareAndSet(T expect, T update) Atomically set the value to the given updated value if the current value == the expected value.
T	get() Gets the current value.
T	getAndSet(T newValue) Sets the given value and returns the old value.
void	set(T newValue) Sets to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomicEnum

public AtomicEnum(T initialValue)

Constructs a new atomic enumeration object.

Parameters:

initialValue - the initial value of the enumeration

Method Detail

set

public void set(T newValue)

Sets to the given value.

Parameters:

newValue - the new value

get

public T get()

Gets the current value.

Returns:

the current value.

getAndSet

public T getAndSet(T newValue)

Sets the given value and returns the old value.

Parameters:

newValue - the new value

Returns:

the previous value

compareAndSet

public boolean compareAndSet(T expect,
                    T update)

Atomically set the value to the given updated value if the current value == the expected value.

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful, false otherwise