com.tomasteubner.common.sync

Class Gate

java.lang.Object

com.tomasteubner.common.sync.Gate

All Implemented Interfaces:

SyncInterface

public class Gate
extends Object
implements SyncInterface

A Gate is used to lock and unlock access to a resource. Any thread may call lock() or unlock() to lock or unlock the Gate. Whenever a thread calls enter it will be blocked until the Gate is unlocked by another thread.

Author:

Tomas Teubner

Constructor Summary

Constructors

Constructor and Description
Gate() Construct unlocked Gate.
Gate(boolean locked) Construct gate.

Method Summary

Modifier and Type	Method and Description
void	enter() Enter the Gate.
boolean	isLocked() Check if the Gate is locked.
void	lock() Lock the Gate.
String	toString()
boolean	tryLock() Try to lock the Gate.
void	unlock() Unlock the Gate.

Methods inherited from class java.lang.Object

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

Constructor Detail

Gate

public Gate(boolean locked)

Construct gate.

Parameters:

locked - true if the Gate should be initially locked

Gate

public Gate()

Construct unlocked Gate.

Method Detail

lock

public void lock()
          throws InterruptedException

Lock the Gate.

Specified by:

lock in interface SyncInterface

Throws:

InterruptedException

unlock

public void unlock()

Unlock the Gate.

Specified by:

unlock in interface SyncInterface

tryLock

public boolean tryLock()
                throws InterruptedException

Try to lock the Gate. Always succeeds.

Specified by:

tryLock in interface SyncInterface

Returns:

always true

Throws:

InterruptedException

isLocked

public boolean isLocked()

Check if the Gate is locked.

Returns:

true if the Gate is locked.

enter

public void enter()
           throws InterruptedException

Enter the Gate.

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class Object