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/CacheFileProps.java

@@ -44,13 +44,13 @@ public class CacheFileProps
     private final File cacheFile;
     private final File propsFile;
     
-    /**
-     * Construct a CacheFileProps specifying which cache file the properties belong to.
-     * 
-     * @param cacheFile - cache file
-     */
-    public CacheFileProps(File cacheFile)
-    {
+    /**
+     * Construct a CacheFileProps specifying which cache file the properties belong to.
+     * 
+     * @param cacheFile - cache file
+     */
+    public CacheFileProps(File cacheFile)
+    {
         this.cacheFile = cacheFile;
         this.propsFile = fileForCacheFile();
     }
@@ -148,7 +148,7 @@ public class CacheFileProps
     /**
      * Set the value of the contentUrl property.
      * 
-     * @param url
+     * @param url String
      */
     public void setContentUrl(String url)
     {
@@ -168,7 +168,7 @@ public class CacheFileProps
     /**
      * Set the value of the deleteWatchCount property.
      * 
-     * @param watchCount
+     * @param watchCount Integer
      */
     public void setDeleteWatchCount(Integer watchCount)
     {

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

@@ -45,8 +45,7 @@ import org.springframework.context.ApplicationEventPublisherAware;
  * CachingContentStore should only be used to wrap content stores that are significantly
  * slower that FileContentStore - otherwise performance may actually degrade from its use.
  * <p>
- * It is important that cacheOnInbound is set to true for exceptionally slow backing stores,
- * e.g. {@link org.alfresco.enterprise.repo.content.xam.XAMContentStore}
+ * It is important that cacheOnInbound is set to true for exceptionally slow backing stores.
  * 
  * @author Matt Ward
  */
@@ -358,8 +357,8 @@ public class CachingContentStore implements ContentStore, ApplicationEventPublis
      * Get a ReentrantReadWriteLock for a given URL. The lock is from a pool rather than
      * per URL, so some contention is expected.
      *  
-     * @param url
-     * @return
+     * @param url String
+     * @return ReentrantReadWriteLock
      */
     public ReentrantReadWriteLock readWriteLock(String url)
     {
@@ -421,7 +420,7 @@ public class CachingContentStore implements ContentStore, ApplicationEventPublis
     /**
      * Sets the QuotaManagerStrategy that will be used.
      * 
-     * @param quota
+     * @param quota QuotaManagerStrategy
      */
     @Required
     public void setQuota(QuotaManagerStrategy quota)

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

@@ -42,8 +42,8 @@ public abstract class CachingContentStoreEvent extends ApplicationEvent
     /**
      * Is the event an instance of the specified type (or subclass)?
      * 
-     * @param type
-     * @return
+     * @param type {@code Class<?>}
+     * @return boolean
      */
     public boolean isType(Class<?> type)
     {

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

@@ -47,7 +47,7 @@ public interface ContentCache
      * into the cache, it does not mean that the disk item is guaranteed to be there. The temp file
      * clean-up process, for example, may have removed it.
      * <p>
-     * @param contentUrl
+     * @param contentUrl String
      * @return true if the URL exists in the in-memory cache. It <em>may</em> therefore be cached on disk.
      */
     boolean contains(String contentUrl);
@@ -55,7 +55,7 @@ public interface ContentCache
     /**
      * Retrieve a ContentReader for the cached content specified by URL.
      * 
-     * @param contentUrl
+     * @param contentUrl String
      * @return ContentReader
      * @throws org.alfresco.repo.content.caching.CacheMissException
      *         If the cache does not contain the specified content.
@@ -68,8 +68,8 @@ public interface ContentCache
      * 
      * Empty content will NOT be cached - in which case false is returned.
      * 
-     * @param contentUrl
-     * @param reader
+     * @param contentUrl String
+     * @param reader ContentReader
      * @return true if the content was cached, false otherwise.
      */
     boolean put(String contentUrl, ContentReader reader);
@@ -79,7 +79,7 @@ public interface ContentCache
      * the actual cached content (file) - this should be left to the clean-up process or can
      * be deleted with {@link #deleteFile(String)}.
      * 
-     * @param contentUrl
+     * @param contentUrl String
      */
     void remove(String contentUrl);
 
@@ -87,16 +87,16 @@ public interface ContentCache
      * Deletes the cached content file for the specified URL. To remove the item from the
      * lookup table also, use {@link #remove(String)} after calling this method.
      * 
-     * @param url
+     * @param url String
      */
     void deleteFile(String url);
 
     /**
-     * Retrieve a ContentWriter to write content to a cache file. Upon closing the stream
-     * a listener will add the new content file to the in-memory lookup table.
-     * 
-     * @param url url
-     * @return ContentWriter
-     */
-    ContentWriter getWriter(String url);
+     * Retrieve a ContentWriter to write content to a cache file. Upon closing the stream
+     * a listener will add the new content file to the in-memory lookup table.
+     * 
+     * @param url url
+     * @return ContentWriter
+     */
+    ContentWriter getWriter(String url);
 }

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)
     {

source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleaner.java

@@ -265,8 +265,8 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica
      * 0 would result in immediate deletion the first time the cleaner sees it as a candidate
      * for deletion (not recommended).
      * 
-     * @param file
-     * @param props
+     * @param file File
+     * @param props CacheFileProps
      * @return true if the content file was deleted, false otherwise.
      */
     private boolean markOrDelete(File file, CacheFileProps props)
@@ -349,7 +349,7 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica
     /**
      * Sets the minimum age of a cache file before it will be considered for deletion.
      * @see #oldEnoughForCleanup(File)
-     * @param minFileAgeMillis
+     * @param minFileAgeMillis long
      */
     public void setMinFileAgeMillis(long minFileAgeMillis)
     {
@@ -361,7 +361,7 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica
      * Sets the maxDeleteWatchCount value.
      * 
      * @see #markOrDelete(File, CacheFileProps)
-     * @param maxDeleteWatchCount
+     * @param maxDeleteWatchCount Integer
      */
     public void setMaxDeleteWatchCount(Integer maxDeleteWatchCount)
     {

source/java/org/alfresco/repo/content/caching/quota/StandardQuotaStrategy.java

@@ -250,7 +250,7 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker
     /**
      * Run a non-aggressive clean up job in a new thread.
      * 
-     * @param reason
+     * @param reason String
      */
     private void signalCleanerStart(final String reason)
     {
@@ -260,7 +260,7 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker
     /**
      * Run an aggressive clean up job in a new thread.
      * 
-     * @param reason
+     * @param reason String
      */
     private void signalAggressiveCleanerStart(final String reason)
     {
@@ -272,8 +272,8 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker
      * Will an increase in disk usage of <code>contentSize</code> bytes result in the specified
      * <code>threshold</code> (percentage of maximum allowed usage) being reached or exceeded?
      * 
-     * @param threshold
-     * @param contentSize
+     * @param threshold int
+     * @param contentSize long
      * @return true if additional content will reach <code>threshold</code>.
      */
     private boolean usageWillReach(int threshold, long contentSize)