jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r521352 - /jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
Date Thu, 22 Mar 2007 17:18:03 GMT
Author: angela
Date: Thu Mar 22 10:18:01 2007
New Revision: 521352

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

Modified:
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java?view=diff&rev=521352&r1=521351&r2=521352
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
Thu Mar 22 10:18:01 2007
@@ -21,18 +21,43 @@
  */
 public interface LockInfo {
 
+    /**
+     * Returns the lock token for this lock if it is hold by the requesting
+     * session or <code>null</code> otherwise.
+     *
+     * @return lock token or <code>null</code>
+     * @see javax.jcr.lock.Lock#getLockToken();
+     */
     public String getLockToken();
 
+    /**
+     * Returns the user ID of the user who owns this lock.
+     *
+     * @return user ID of the user who owns this lock.
+     * @see javax.jcr.lock.Lock#getLockOwner();
+     */
     public String getOwner();
 
+    /**
+     * Returns true if the Lock is deep. False otherwise.
+     *
+     * @return true if the Lock is deep. False otherwise.
+     * @see javax.jcr.lock.Lock#isDeep();
+     */
     public boolean isDeep();
 
+    /**
+     * Returns true if the Lock is session scoped. False otherwise.
+     *
+     * @return true if the Lock is session scoped. False otherwise.
+     * @see javax.jcr.lock.Lock#isSessionScoped();
+     */
     public boolean isSessionScoped();
 
     /**
-     * Returns the <code>NodeID</code> of the lock-holding Node.
+     * Returns the <code>NodeId</code> of the lock-holding Node.
      *
-     * @return the <code>NodeID</code> of the lock-holding Node.
+     * @return the <code>NodeId</code> of the lock-holding Node.
      */
     public NodeId getNodeId();
 }



Mime
View raw message