jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r752046 - in /jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock: AbstractLockInfo.java LockManager.java
Date Tue, 10 Mar 2009 10:37:42 GMT
Author: angela
Date: Tue Mar 10 10:37:42 2009
New Revision: 752046

URL: http://svn.apache.org/viewvc?rev=752046&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/AbstractLockInfo.java
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/LockManager.java

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/AbstractLockInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/AbstractLockInfo.java?rev=752046&r1=752045&r2=752046&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/AbstractLockInfo.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/AbstractLockInfo.java
Tue Mar 10 10:37:42 2009
@@ -124,7 +124,10 @@
     /**
      * Return the lock token as seen by the session passed as parameter. If
      * this session is currently holding the lock, it will get the lock token
-     * itself, otherwise a <code>null</code> string
+     * itself, otherwise a <code>null</code> string.
+     *
+     * @param session The session asking for the lock token.
+     * @return lock token.
      */
     public String getLockToken(Session session) {
         if (session.equals(lockHolder)) {
@@ -144,6 +147,8 @@
 
     /**
      * Return a flag indicating whether the lock information may still change.
+     *
+     * @return <code>true</code> if the lock is still alive.
      */
     public boolean mayChange() {
         return live;

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/LockManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/LockManager.java?rev=752046&r1=752045&r2=752046&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/LockManager.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/lock/LockManager.java
Tue Mar 10 10:37:42 2009
@@ -48,12 +48,12 @@
      * Lock a node. Checks whether the node is not locked and then
      * returns a lock object for this node.
      *
-     * @param node
+     * @param node Node to create the lock for.
      * @param isDeep whether the lock applies to this node only
      * @param isSessionScoped whether the lock is session scoped
-     * @param timoutHint
-     * @param ownerInfo
-     * @return
+     * @param timoutHint Desired lock timeout in seconds.
+     * @param ownerInfo Optional string acting as information about the owner.
+     * @return the lock.
      * @throws LockException if this node already is locked, or some descendant
      *         node is locked and <code>isDeep</code> is <code>true</code>
      * @see org.apache.jackrabbit.api.jsr283.lock.LockManager#lock(String, boolean, boolean,
long, String)
@@ -155,6 +155,7 @@
 
     /**
      * Invoked by a session to inform that a lock token has been added.
+     * 
      * @param session session that has a added lock token
      * @param lt added lock token
      * @throws LockException
@@ -164,6 +165,7 @@
 
     /**
      * Invoked by a session to inform that a lock token has been removed.
+     *
      * @param session session that has a removed lock token
      * @param lt removed lock token
      * @throws LockException



Mime
View raw message