com.tomasteubner.common.sync

Class Mutex

java.lang.Object

com.tomasteubner.common.sync.Mutex

All Implemented Interfaces:

SyncInterface

public class Mutex
extends Object
implements SyncInterface

A Mutex can be used to assert mutual exclusive access to a resource. It acts as a kind of synchronized boolean switch.

Version:

1.0

Author:

Tomas Teubner

Constructor Summary

Constructors

Constructor and Description
Mutex() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	lock() Lock the Mutex.
String	toString()
boolean	tryLock() Try to lock the Mutex.
void	unlock() Unlock the Mutex.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mutex

public Mutex()

Default constructor.

Method Detail

lock

public void lock()
          throws InterruptedException

Lock the Mutex.

Specified by:

lock in interface SyncInterface

Throws:

InterruptedException

tryLock

public boolean tryLock()

Try to lock the Mutex.

Specified by:

tryLock in interface SyncInterface

Returns:

true if Mutex could be locked

unlock

public void unlock()

Unlock the Mutex.

Specified by:

unlock in interface SyncInterface

toString

public String toString()

Overrides:

toString in class Object