Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.cache.lock
Class LockMap

java.lang.Object
  extended byorg.jboss.cache.lock.LockMap
public class LockMap
extends java.lang.Object

Provide lock ownership mapping.

Field Summary
static int OWNER_ANY
           
static int OWNER_READ
           
static int OWNER_WRITE
           
 
Constructor Summary
LockMap()
           
 
Method Summary
 void addReader(java.lang.Object owner)
          Adding a reader owner.
 void addWriter(java.lang.Object owner)
          Adding a writer owner.
 LockMap (src) copy()
           
 boolean isOwner(java.lang.Object owner, int ownership)
          Check whether this owner has reader or writer ownership.
 java.lang.String printInfo()
          Debugging information.
 java.util.List readerOwners()
           
 void removeAll()
          Remove all ownership.
 boolean removeReader(java.lang.Object owner)
          Remove reader ownership.
 java.lang.Object removeWriter(java.lang.Object owner)
          Remove writer ownership.
 boolean upgrade(java.lang.Object owner)
          Upgrading current reader ownership to writer one.
 java.lang.Object writerOwner()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OWNER_ANY

public static final int OWNER_ANY
See Also:
Constant Field Values (src)

OWNER_READ

public static final int OWNER_READ
See Also:
Constant Field Values (src)

OWNER_WRITE

public static final int OWNER_WRITE
See Also:
Constant Field Values (src)
Constructor Detail

LockMap

public LockMap()
Method Detail

copy

public LockMap (src)  copy()

isOwner

public boolean isOwner(java.lang.Object owner,
                       int ownership)
Check whether this owner has reader or writer ownership.

Parameters:
owner -
ownership - Either OWNER_ANY, OWNER_READ, or OWNER_WRITE.
Returns:

addReader

public void addReader(java.lang.Object owner)
Adding a reader owner.

Parameters:
owner -

addWriter

public void addWriter(java.lang.Object owner)
Adding a writer owner.

Parameters:
owner -

upgrade

public boolean upgrade(java.lang.Object owner)
                throws OwnerNotExistedException (src)
Upgrading current reader ownership to writer one.

Parameters:
owner -
Returns:
True if successful.
Throws:
OwnerNotExistedException (src)

readerOwners

public java.util.List readerOwners()
Returns:
List of reader owner objects. Size 0 if not found.

writerOwner

public java.lang.Object writerOwner()
Returns:
Writer owner object. Null if none.

removeReader

public boolean removeReader(java.lang.Object owner)
Remove reader ownership.

Parameters:
owner -
Returns:
The owner object. Null if not found.

removeWriter

public java.lang.Object removeWriter(java.lang.Object owner)
Remove writer ownership.

Parameters:
owner -
Returns:
The owner object. Null if not found.

removeAll

public void removeAll()
Remove all ownership.

printInfo

public java.lang.String printInfo()
Debugging information.

Returns:
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD