Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/filesys/locking/FileLock.java

@@ -0,0 +1,187 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.filesys.locking;
+
+/**
+ * File Lock Class
+ * <p>
+ * Contains the details of a single file lock.
+ */
+public class FileLock
+{
+
+    // Constants
+
+    public static final long LockWholeFile = 0xFFFFFFFFFFFFFFFFL;
+
+    // Start lock offset and length
+
+    private long m_offset;
+    private long m_length;
+
+    // Owner process id
+
+    private int m_pid;
+
+    /**
+     * Class constructor
+     * 
+     * @param offset long
+     * @param len long
+     * @param pid int
+     */
+    public FileLock(long offset, long len, int pid)
+    {
+        setOffset(offset);
+        setLength(len);
+        setProcessId(pid);
+    }
+
+    /**
+     * Get the starting lock offset
+     * 
+     * @return long Starting lock offset.
+     */
+    public final long getOffset()
+    {
+        return m_offset;
+    }
+
+    /**
+     * Set the starting lock offset.
+     * 
+     * @param long Starting lock offset
+     */
+    public final void setOffset(long offset)
+    {
+        m_offset = offset;
+    }
+
+    /**
+     * Get the locked section length
+     * 
+     * @return long Locked section length
+     */
+    public final long getLength()
+    {
+        return m_length;
+    }
+
+    /**
+     * Set the locked section length
+     * 
+     * @param long Locked section length
+     */
+    public final void setLength(long len)
+    {
+        if (len < 0)
+            m_length = LockWholeFile;
+        else
+            m_length = len;
+    }
+
+    /**
+     * Get the owner process id for the lock
+     * 
+     * @return int
+     */
+    public final int getProcessId()
+    {
+        return m_pid;
+    }
+
+    /**
+     * Deterine if the lock is locking the whole file
+     * 
+     * @return boolean
+     */
+    public final boolean isWholeFile()
+    {
+        return m_length == LockWholeFile ? true : false;
+    }
+
+    /**
+     * Set the process id of the owner of this lock
+     * 
+     * @param pid int
+     */
+    public final void setProcessId(int pid)
+    {
+        m_pid = pid;
+    }
+
+    /**
+     * Check if the specified locks byte range overlaps this locks byte range.
+     * 
+     * @param lock FileLock
+     */
+    public final boolean hasOverlap(FileLock lock)
+    {
+        return hasOverlap(lock.getOffset(), lock.getLength());
+    }
+
+    /**
+     * Check if the specified locks byte range overlaps this locks byte range.
+     * 
+     * @param offset long
+     * @param len long
+     */
+    public final boolean hasOverlap(long offset, long len)
+    {
+
+        // Check if the lock is for the whole file
+
+        if (isWholeFile())
+            return true;
+
+        // Check if the locks overlap
+
+        long endOff = getOffset() + getLength();
+
+        if (getOffset() < offset && endOff < offset)
+            return false;
+
+        endOff = offset + len;
+
+        if (getOffset() > endOff)
+            return false;
+
+        // Locks overlap
+
+        return true;
+    }
+
+    /**
+     * Return the lock details as a string
+     * 
+     * @return String
+     */
+    public String toString()
+    {
+        StringBuffer str = new StringBuffer();
+
+        str.append("[PID=");
+        str.append(getProcessId());
+        str.append(",Offset=");
+        str.append(getOffset());
+        str.append(",Len=");
+        str.append(getLength());
+        str.append("]");
+
+        return str.toString();
+    }
+}