Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


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

source/java/org/alfresco/repo/content/caching/ContentCacheImpl.java

@@ -36,13 +36,13 @@ import org.alfresco.service.cmr.repository.ContentWriter;
 import org.alfresco.util.GUID;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-
-/**
- * The one and only implementation of the ContentCache class. Binary content data itself
- * is stored on disk in the location specified by {@link #cacheRoot}.
- * <p>
- * The in-memory lookup table is provided by a SimpleCache implementation.
- * 
+
+/**
+ * The one and only implementation of the ContentCache class. Binary content data itself
+ * is stored on disk in the location specified by {@link #cacheRoot}.
+ * <p>
+ * The in-memory lookup table is provided by a SimpleCache implementation.
+ * 
  * @author Matt Ward
  */
 public class ContentCacheImpl implements ContentCache
@@ -63,7 +63,7 @@ public class ContentCacheImpl implements ContentCache
     /**
      * Allows caller to perform lookup using a {@link Key}.
      * 
-     * @param key
+     * @param key Key
      * @return true if the cache contains, false otherwise.
      */
     public boolean contains(Key key)
@@ -74,8 +74,8 @@ public class ContentCacheImpl implements ContentCache
     /**
      * Put an item in the lookup table.
      * 
-     * @param key
-     * @param value
+     * @param key Key
+     * @param value String
      */
     public void putIntoLookup(Key key, String value)
     {
@@ -86,7 +86,7 @@ public class ContentCacheImpl implements ContentCache
      * Get the path of a cache file for the given content URL - will return null if there is no entry
      * in the cache for the specified URL.
      * 
-     * @param contentUrl
+     * @param contentUrl String
      * @return cache file path
      */
     public String getCacheFilePath(String contentUrl)
@@ -97,8 +97,8 @@ public class ContentCacheImpl implements ContentCache
     /**
      * Get a content URL from the cache - keyed by File.
      * 
-     * @param file
-     * @return
+     * @param file File
+     * @return String
      */
     public String getContentUrl(File file)
     {
@@ -152,12 +152,12 @@ public class ContentCacheImpl implements ContentCache
         memoryStore.put(Key.forCacheFile(cacheFile), contentUrl);
     }
     
-    /**
-     * Create a File object and makes any intermediate directories in the path.
-     * 
-     * @return File
-     */
-    private File createCacheFile()
+    /**
+     * Create a File object and makes any intermediate directories in the path.
+     * 
+     * @return File
+     */
+    private File createCacheFile()
     {
         File file = new File(cacheRoot, createNewTempCacheFilePath());
         File parentDir = file.getParentFile();
@@ -303,7 +303,7 @@ public class ContentCacheImpl implements ContentCache
     /**
      * Specify the directory where cache files will be written.
      * 
-     * @param cacheRoot
+     * @param cacheRoot File
      */
     public void setCacheRoot(File cacheRoot)
     {
@@ -331,7 +331,7 @@ public class ContentCacheImpl implements ContentCache
 
     /**
      * Ask the ContentCacheImpl to visit all the content files in the cache.
-     * @param handler
+     * @param handler FileHandler
      */
     public void processFiles(FileHandler handler)
     {
@@ -342,8 +342,8 @@ public class ContentCacheImpl implements ContentCache
      * Recurse into a directory handling cache files (*.bin) with the supplied
      * {@link FileHandler}.
      * 
-     * @param dir
-     * @param handler
+     * @param dir File
+     * @param handler FileHandler
      */
     private void handleDir(File dir, FileHandler handler)
     {
@@ -377,8 +377,8 @@ public class ContentCacheImpl implements ContentCache
      * <p>
      * The returned array contains the (numerically sorted) directories first followed by the (unsorted) plain files.
      * 
-     * @param dir
-     * @return
+     * @param dir File
+     * @return File[]
      */
     private File[] sortFiles(File dir)
     {