added in API level 1

ConditionVariable

public class ConditionVariable
extends Object

java.lang.Object
   ↳ android.os.ConditionVariable


Class that implements the condition variable locking paradigm.

This differs from the built-in java.lang.Object wait() and notify() in that this class contains the condition to wait on itself. That means open(), close() and block() are sticky. If open() is called before block(), block() will not block, and instead return immediately.

This class uses itself as the object to wait on, so if you wait() or notify() on a ConditionVariable, the results are undefined.

Summary

Public constructors

ConditionVariable()

Create the ConditionVariable in the default closed state.

ConditionVariable(boolean state)

Create the ConditionVariable with the given state.

Public methods

void block()

Block the current thread until the condition is opened.

boolean block(long timeout)

Block the current thread until the condition is opened or until timeout milliseconds have passed.

void close()

Reset the condition to the closed state.

void open()

Open the condition, and release all threads that are blocked.

Inherited methods

Public constructors

ConditionVariable

added in API level 1
ConditionVariable ()

Create the ConditionVariable in the default closed state.

ConditionVariable

added in API level 1
ConditionVariable (boolean state)

Create the ConditionVariable with the given state.

Pass true for opened and false for closed.

Parameters
state boolean

Public methods

block

added in API level 1
void block ()

Block the current thread until the condition is opened.

If the condition is already opened, return immediately.

block

added in API level 1
boolean block (long timeout)

Block the current thread until the condition is opened or until timeout milliseconds have passed.

If the condition is already opened, return immediately.

Parameters
timeout long: the maximum time to wait in milliseconds.

Returns
boolean true if the condition was opened, false if the call returns because of the timeout.

close

added in API level 1
void close ()

Reset the condition to the closed state.

Any threads that call block() will block until someone calls open.

open

added in API level 1
void open ()

Open the condition, and release all threads that are blocked.

Any threads that later approach block() will not block unless close() is called.