com.almasb.fxgl.ai.utils

Class SimpleNonBlockingSemaphore

java.lang.Object

com.almasb.fxgl.ai.utils.SimpleNonBlockingSemaphore

All Implemented Interfaces:

NonBlockingSemaphore

public class SimpleNonBlockingSemaphore
extends Object
implements NonBlockingSemaphore

A non-blocking semaphore that does not ensure the atomicity of its operations, meaning that it's not tread-safe.

Author:

davebaol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleNonBlockingSemaphore.Factory A concrete factory that can create instances of SimpleNonBlockingSemaphore.

Constructor Summary

Constructors

Constructor and Description
SimpleNonBlockingSemaphore(String name, int maxResources) Creates a SimpleNonBlockingSemaphore with the given name and number of resources.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleNonBlockingSemaphore

public SimpleNonBlockingSemaphore(String name,
                                  int maxResources)

Creates a SimpleNonBlockingSemaphore with the given name and number of resources.

Parameters:

name - the name of this semaphore

maxResources - the number of resources

Method Detail

acquire

public boolean acquire()

Description copied from interface: NonBlockingSemaphore

Acquires a resource if available.

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

Specified by:

acquire in interface NonBlockingSemaphore

Returns:

true if the resource has been acquired; false otherwise.

acquire

public boolean acquire(int resources)

Description copied from interface: NonBlockingSemaphore

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

Specified by:

acquire in interface NonBlockingSemaphore

Returns:

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

release

public boolean release()

Description copied from interface: NonBlockingSemaphore

Releases a resource returning it to this semaphore.

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

Specified by:

release in interface NonBlockingSemaphore

Returns:

true if the resource has been released; false otherwise.

release

public boolean release(int resources)

Description copied from interface: NonBlockingSemaphore

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

Specified by:

release in interface NonBlockingSemaphore

Returns:

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