cz.cuni.amis.pogamut.multi.utils.timekey
Interface ITimeKeyManager

All Known Implementing Classes:

TimeKeyManager

public interface ITimeKeyManager

Method Summary

Set<Long>	getHeldKeys() Returns an immutable collection of currently held timeKeys.
String	getHeldKeysStr() Returns an immutable collection of currently held timeKeys as string.
boolean	isLocked(long time) True if the provided timeKey is explicitly locked (lock(key) was called).
boolean	isLocked(TimeKey key) True if the provided timeKey is explicitly locked (lock(key) was called).
void	lock(long time) Locks some "time" (or increment lock number if existing lock exists).
void	unlock(long key) Unlocks some "time".
void	unlockAll() Unlock all times.
void	unlockAll(long time) Completely unlocks one time (regardless number of locks held).

Method Detail

lock

void lock(long time)

Locks some "time" (or increment lock number if existing lock exists).

Parameters:

time -

isLocked

boolean isLocked(TimeKey key)

True if the provided timeKey is explicitly locked (lock(key) was called).

Parameters:

key -

Returns:

isLocked

boolean isLocked(long time)

True if the provided timeKey is explicitly locked (lock(key) was called).

Parameters:

time -

Returns:

unlock

void unlock(long key)
            throws TimeKeyNotLockedException

Unlocks some "time".

Parameters:

key -

Throws:

TimeKeyNotLockedException

unlockAll

void unlockAll(long time)
               throws TimeKeyNotLockedException

Completely unlocks one time (regardless number of locks held).

Parameters:

time -

Throws:

TimeKeyNotLockedException

unlockAll

void unlockAll()

Unlock all times.

getHeldKeys

Set<Long> getHeldKeys()

Returns an immutable collection of currently held timeKeys.

Returns:

getHeldKeysStr

String getHeldKeysStr()

Returns an immutable collection of currently held timeKeys as string.

Returns: