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
2025-10-08 14:51:49 +00:00 · 2015-07-02 16:13:03 +00:00
parent 4c30e52dc3
commit 7dd2291753
784 changed files with 5454 additions and 5487 deletions
--- a/source/java/org/alfresco/repo/model/Repository.java
+++ b/source/java/org/alfresco/repo/model/Repository.java
@@ -75,7 +75,7 @@ public class Repository implements ApplicationContextAware
    /**
     * Sets the Company Home Store
     * 
-     * @param companyHomeStore
+     * @param companyHomeStore String
     */
    public void setCompanyHomeStore(String companyHomeStore)
    {
@@ -85,7 +85,7 @@ public class Repository implements ApplicationContextAware
    /**
     * Sets the Company Home Path
     * 
-     * @param companyHomePath
+     * @param companyHomePath String
     */
    public void setCompanyHomePath(String companyHomePath)
    {
@@ -95,7 +95,7 @@ public class Repository implements ApplicationContextAware
    /**
     * Sets the Shared Home Path
     * 
-     * @param sharedHomePath
+     * @param sharedHomePath String
     */
    public void setSharedHomePath(String sharedHomePath)
    {
--- a/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java
+++ b/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java
@@ -478,6 +478,16 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
    
    // note: similar to getChildAssocs(contextNodeRef, searchTypeQNames) but enables paging features, including max items, sorting etc (with permissions per-applied)

+    /**
+     *
+     * @param contextNodeRef
+     * @param pattern
+     * @param searchTypeQNames
+     * @param ignoreAspectQNames
+     * @param sortProps
+     * @param pagingRequest
+     * @return
+     */
    private CannedQueryResults<NodeRef> listImpl(NodeRef contextNodeRef, String pattern,  Set<QName> searchTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName, Boolean>> sortProps, PagingRequest pagingRequest)
    {
        Long start = (logger.isDebugEnabled() ? System.currentTimeMillis() : null);
@@ -848,9 +858,9 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
     * then all its chidren are excluded as well.
     * 
     * @param contextNodeRef the starting point.
-     * @param files return nodes of type files.
+     * @param files return nodes of type files.
     * @param folders return nodes of type folders.
-     * @param folderFilter filter controls which folders to search.  If null then all subfolders are searched.
+     * @param folderFilter filter controls which folders to search.  If null then all subfolders are searched.
     * @return list of node references
     */
   /* <p>
@@ -951,7 +961,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
    }

    /**
-     * @see #moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)
+     * @see #moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)
     */
    @Override
    public FileInfo move(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
@@ -960,7 +970,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
    }
    
    /**
-     * @see #moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)
+     * @see #moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)
     */
    @Override
    public FileInfo moveFrom(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
@@ -978,7 +988,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
    }

    /**
-     * @see #moveOrCopy(NodeRef, NodeRef, String, boolean)
+     * @see #moveOrCopy(NodeRef, NodeRef, NodeRef, String, boolean)
     */
    @Override
    public FileInfo copy(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) throws FileExistsException, FileNotFoundException
@@ -1647,7 +1657,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi
        }
        if (allVisible)
        {
-            hiddenAspect.showNode(nodeRef, true);
+            hiddenAspect.showNode(nodeRef, true);
        }
        else
        {
--- a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java
+++ b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java
@@ -227,7 +227,7 @@ public class HiddenAspect
     * 
     * If the node is already hidden will do nothing.
     * 
-     * @param nodeRef
+     * @param nodeRef NodeRef

     */
    public void hideNodeExplicit(NodeRef nodeRef)
@@ -245,7 +245,7 @@ public class HiddenAspect
     * Remove the explicit hiding of a node.  Following this call the node may or may not remain hidden based upon the other 
     * properties of the node.
     * 
-     * @param nodeRef
+     * @param nodeRef NodeRef
     */
    public void unhideExplicit(NodeRef nodeRef)
    {
@@ -571,8 +571,8 @@ public class HiddenAspect
    /**
     * getClientVisibilityMap
     * 
-     * @param client
-     * @param visibility
+     * @param client Client
+     * @param visibility Visibility
     * @return the client visibilityMask
     */
    public int getClientVisibilityMask(Client client, Visibility visibility)
@@ -583,7 +583,7 @@ public class HiddenAspect
    /**
     * Checks whether the node is on a hidden path
     *
-     * @param nodeRef
+     * @param nodeRef NodeRef
     * @return the matching filter, or null if no match
     */
    public HiddenFileInfo onHiddenPath(NodeRef nodeRef)
@@ -615,10 +615,9 @@ public class HiddenAspect
     * Hides the node by applying the hidden and not indexed aspects. The node will be hidden from all clients.
     * 
     * @param nodeRef nodeRef
-     * @param cascadeHiddenAspect
-     * @param cascadeIndexControlAspect
-     * @param clientControlled
-     * @return
+     * @param cascadeHiddenAspect boolean
+     * @param cascadeIndexControlAspect boolean
+     * @param clientControlled boolean
     */
    public void hideNode(NodeRef nodeRef, boolean cascadeHiddenAspect, boolean cascadeIndexControlAspect, boolean clientControlled)
    {
@@ -651,7 +650,10 @@ public class HiddenAspect
     * according to the visibility mask.
     * 
     * @param nodeRef the node to hide
-     * @param clientVisibilityMask
+     * @param clientVisibilityMask int
+     * @param cascadeHiddenAspect boolean
+     * @param cascadeIndexControlAspect boolean
+     * @param clientControlled boolean
     */
    public void hideNode(NodeRef nodeRef, int clientVisibilityMask, boolean cascadeHiddenAspect, boolean cascadeIndexControlAspect, boolean clientControlled)
    {
@@ -663,7 +665,7 @@ public class HiddenAspect
     * Searches for nodes in the given store that should be hidden (i.e. match the hidden pattern)
     * and hides them if they are not already hidden.
     * 
-     * @param storeRef
+     * @param storeRef StoreRef
     */
    public void checkHidden(StoreRef storeRef)
    {
@@ -685,10 +687,11 @@ public class HiddenAspect
    /**
     * Checks whether the file should be hidden and applies the hidden and not indexed aspects if so.
     * 
-     * @param fileInfo
+     * @param fileInfo FileInfo
     * @param both     if true, will check if the node should not be hidden and remove hidden and index control
     *                 aspects if they are present
-     * @return
+     * @param  checkChildren boolean
+     * @return boolean
     */
    public boolean checkHidden(FileInfo fileInfo, boolean both, boolean checkChildren)
    {
@@ -701,9 +704,11 @@ public class HiddenAspect
     * Hides the node by applying the hidden and not indexed aspects. The node will be hidden from clients
     * according to the visibility mask.
     * 
-     * @see getClientVisibilityMask()
-     * @param fileInfo, file to make hidden
-     * @param visibilityMask
+     * @param fileInfo file to make hidden
+     * @param visibilityMask int
+     * @param cascadeHiddenAspect boolean
+     * @param cascadeIndexControlAspect boolean
+     * @param clientControlled boolean
     */
    public void hideNode(FileInfoImpl fileInfo, int visibilityMask, boolean cascadeHiddenAspect, boolean cascadeIndexControlAspect, boolean clientControlled)
    {
@@ -790,10 +795,11 @@ public class HiddenAspect
     * <p>
     * Can optionally remove the hidden and index control aspects if the name of a node no longer matches the filter.
     * 
-     * @param nodeRef
+     * @param nodeRef NodeRef
     * @param both     if true, will check both if the node should not be hidden and remove hidden and index control
     * 				   aspects if they are present, and if the node should be hidden and add hidden and index control
     * 				   aspects if they are not present.
+     * @param checkChildren boolean
     * @return true if the node is hidden, irrespective of the clientVisibility property value.
     */
    public boolean checkHidden(NodeRef nodeRef, boolean both, boolean checkChildren)
@@ -883,8 +889,8 @@ public class HiddenAspect
    /**
     * Gets the visibility constraint for the given client on the given node.
     * 
-     * @param client
-     * @param nodeRef
+     * @param client Client
+     * @param nodeRef NodeRef
     * 
     * @return the visibility constraint for the given client and node
     */
--- a/source/java/org/alfresco/repo/model/ml/EmptyTranslationAspect.java
+++ b/source/java/org/alfresco/repo/model/ml/EmptyTranslationAspect.java
@@ -133,7 +133,7 @@ public class EmptyTranslationAspect implements
    }
    
    /**
-     * @return              Returns {@link EmptyTranslationAspectCopyBehaviourCallback}
+     * @return              Returns CopyBehaviourCallback
     */
    public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails)
    {