com.j_spaces.kernel.locks

Interface IEvictableLockObject

All Superinterfaces:

ILockObject

All Known Implementing Classes:

EvictableLockObject

public interface IEvictableLockObject
extends ILockObject

TODO add Javadoc

Since:

6.6 the interface for a lock object that represents an evictable subject

Version:

1.0

Author:

Yechiel Fefer

Method Summary

Modifier and Type	Method and Description
boolean	decrementNumOfUsersAndIndicateEmpty() decrement the number of users using (i.e locking + waiting + finished & not released yet) of the lock object
int	getNumOfUsers() get the number of users using (i.e locking + waiting + finished & not released yet) of the lock object
int	getNumOfUsersAndEmpty() atomicly get & reset the number of users of the lock object
String	getUID() get the uid for the object to lock
boolean	incrementNumOfUsersIfNotEmpty() increment the number of users using (i.e locking + waiting + finished & not released yet) of the lock object, if the lock object is not empty (zero users)
boolean	isEvictionPermissionIndicator() true if this object is an eviction indicator.

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject

isLockSubject

Method Detail

isEvictionPermissionIndicator

boolean isEvictionPermissionIndicator()

true if this object is an eviction indicator. regular locks will wait till eviction performed, eviction will not take place if the object is locked

Returns:

true if it is

getNumOfUsers

int getNumOfUsers()

get the number of users using (i.e locking + waiting + finished & not released yet) of the lock object

Returns:

the num of users

incrementNumOfUsersIfNotEmpty

boolean incrementNumOfUsersIfNotEmpty()

increment the number of users using (i.e locking + waiting + finished & not released yet) of the lock object, if the lock object is not empty (zero users)

Returns:

true if # of users incremented, false if empty

decrementNumOfUsersAndIndicateEmpty

boolean decrementNumOfUsersAndIndicateEmpty()

decrement the number of users using (i.e locking + waiting + finished & not released yet) of the lock object

Returns:

true if lock object is empty (i.e. zero users reached)

getNumOfUsersAndEmpty

int getNumOfUsersAndEmpty()

atomicly get & reset the number of users of the lock object

Returns:

the num of users

getUID

String getUID()

get the uid for the object to lock

Returns:

the uid