com.almasb.fxgl.ai.utils

Interface NonBlockingSemaphore

All Known Implementing Classes:

SimpleNonBlockingSemaphore

public interface NonBlockingSemaphore

A counting semaphore that does not block the thread when the requested resource is not available. No actual resource objects are used; the semaphore just keeps a count of the number available and acts accordingly.

Author:

davebaol

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NonBlockingSemaphore.Factory Abstract factory for creating concrete instances of classes implementing NonBlockingSemaphore.

Method Summary

Modifier and Type	Method and Description
boolean	acquire() Acquires a resource if available.
boolean	acquire(int resources) Acquires the specified number of resources if they all are available.
boolean	release() Releases a resource returning it to this semaphore.
boolean	release(int resources) Releases the specified number of resources returning it to this semaphore.

Method Detail

acquire

boolean acquire()

Acquires a resource if available.

An invocation of this method yields exactly the same result as acquire(1)

Returns:

true if the resource has been acquired; false otherwise.

acquire

boolean acquire(int resources)

Acquires the specified number of resources if they all are available.

Returns:

true if all the requested resources have been acquired; false otherwise.

release

boolean release()

Releases a resource returning it to this semaphore.

An invocation of this method yields exactly the same result as release(1)

Returns:

true if the resource has been released; false otherwise.

release

boolean release(int resources)

Releases the specified number of resources returning it to this semaphore.

Returns:

true if all the requested resources have been released; false otherwise.