diff --git a/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java b/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java
index 96c846433e..5ef525aaf9 100644
--- a/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java
+++ b/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java
@@ -32,7 +32,7 @@ public class AliasableAspectCopyBehaviourCallback extends DefaultCopyBehaviourCa
static final CopyBehaviourCallback INSTANCE = new AliasableAspectCopyBehaviourCallback();
/**
- * Disallows copying of the {@link EmailServerModel#ASPECT_ALIASABLE aspect.
+ * Disallows copying of the {@link EmailServerModel#ASPECT_ALIASABLE} aspect.
*/
@Override
public boolean getMustCopy(QName classQName, CopyDetails copyDetails)
diff --git a/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java b/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java
index d5e7c3efe9..80d35d2787 100644
--- a/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java
+++ b/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java
@@ -95,13 +95,12 @@ public class FolderEmailMessageHandler extends AbstractEmailMessageHandler
}
/**
- * Add content to Alfresco repository
- *
- * @param spaceNodeRef Addressed node
- * @param message Mail message
- * @throws IOException Exception can be thrown while saving a content into Alfresco repository.
- * @throws MessagingException Exception can be thrown while parsing e-mail message.
- */
+ * Add content to Alfresco repository
+ *
+ * @param spaceNodeRef Addressed node
+ * @param message Mail message
+ * @throws IOException Exception can be thrown while saving a content into Alfresco repository.
+ */
public void addAlfrescoContent(NodeRef spaceNodeRef, EmailMessage message) throws IOException
{
// Set default values for email fields
@@ -197,7 +196,7 @@ public class FolderEmailMessageHandler extends AbstractEmailMessageHandler
/**
* Set the behaviour to be done on detecting a new message with the same subject.
- * @param overwriteDuplicates
+ * @param overwriteDuplicates boolean
*/
public void setOverwriteDuplicates(boolean overwriteDuplicates)
{
diff --git a/source/java/org/alfresco/encryption/ReEncryptor.java b/source/java/org/alfresco/encryption/ReEncryptor.java
index 68c1e2ae53..feb39c99c0 100644
--- a/source/java/org/alfresco/encryption/ReEncryptor.java
+++ b/source/java/org/alfresco/encryption/ReEncryptor.java
@@ -160,8 +160,6 @@ public class ReEncryptor implements ApplicationContextAware
/**
* Attempts to get the lock. If it fails, the current transaction is marked for rollback.
- *
- * @return Returns the lock token
*/
private void refreshLock(String lockToken, long time)
{
diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java
index c709d0ad07..af19e5eb8f 100644
--- a/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java
+++ b/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java
@@ -377,13 +377,13 @@ public abstract class AlfrescoContext extends DiskDeviceContext
}
- /**
- * Set the debug flags, also requires the logger to be enabled for debug output
- *
- * @param flagsStr
- */
- public final void setDebug(String flagsStr)
- {
+ /**
+ * Set the debug flags, also requires the logger to be enabled for debug output
+ *
+ * @param flagsStr String
+ */
+ public final void setDebug(String flagsStr)
+ {
int filesysDbg = 0;
if (flagsStr != null)
@@ -452,22 +452,22 @@ public abstract class AlfrescoContext extends DiskDeviceContext
super.startFilesystem(share);
}
- /**
- * Return the lock manager, if enabled
- *
- * @return LockManager
- */
LockManager lockManager;
-
- public void setLockManager(LockManager lockManager)
+
+ public void setLockManager(LockManager lockManager)
{
this.lockManager = lockManager;
}
-
+
+ /**
+ * Return the lock manager, if enabled
+ *
+ * @return LockManager
+ */
public LockManager getLockManager() {
return lockManager;
}
-
+
OpLockManager opLockManager;
/**
diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java
index cb087f2bfc..fb229fb79c 100644
--- a/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java
+++ b/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java
@@ -90,7 +90,7 @@ public abstract class AlfrescoDiskDriver implements IOCtlInterface, ExtendedDisk
/**
* Set the service registry
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
*/
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoNetworkFile.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoNetworkFile.java
index d943d0cda4..5d0740bc74 100644
--- a/source/java/org/alfresco/filesys/alfresco/AlfrescoNetworkFile.java
+++ b/source/java/org/alfresco/filesys/alfresco/AlfrescoNetworkFile.java
@@ -66,7 +66,7 @@ public abstract class AlfrescoNetworkFile extends NetworkFile implements Network
/**
* Tell JLAN it needs to call disk.closeFile rather than short cutting.
- * @return
+ * @return boolean
*/
public boolean allowsOpenCloseViaNetworkFile() {
return false;
diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoTxDiskDriver.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoTxDiskDriver.java
index da89036c6e..188ced22d5 100644
--- a/source/java/org/alfresco/filesys/alfresco/AlfrescoTxDiskDriver.java
+++ b/source/java/org/alfresco/filesys/alfresco/AlfrescoTxDiskDriver.java
@@ -1,19 +1,19 @@
/*
- * Copyright (C) 2005-2010 Alfresco Software Limited.
- *
- * This file is part of Alfresco
- *
- * Alfresco is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Alfresco is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see . */
package org.alfresco.filesys.alfresco;
@@ -86,7 +86,7 @@ public abstract class AlfrescoTxDiskDriver extends AlfrescoDiskDriver implements
* @param callback
* callback for the retryable operation
* @return the result of the operation
- * @throws Exception
+ * @throws IOException
*/
public T doInWriteTransaction(SrvSession sess, final CallableIO callback)
throws IOException
@@ -330,7 +330,7 @@ public abstract class AlfrescoTxDiskDriver extends AlfrescoDiskDriver implements
private static final long serialVersionUID = 1L;
/**
- * @param cause
+ * @param cause Throwable
*/
public PropagatingException(Throwable cause)
{
diff --git a/source/java/org/alfresco/filesys/alfresco/DesktopAction.java b/source/java/org/alfresco/filesys/alfresco/DesktopAction.java
index 7e1ea733f3..127642e4d3 100644
--- a/source/java/org/alfresco/filesys/alfresco/DesktopAction.java
+++ b/source/java/org/alfresco/filesys/alfresco/DesktopAction.java
@@ -487,7 +487,7 @@ public abstract class DesktopAction {
*
* @param params DesktopParams
* @return DesktopResponse
- * @exception
+ * @exception DesktopActionException
*/
public abstract DesktopResponse runAction(DesktopParams params)
throws DesktopActionException;
diff --git a/source/java/org/alfresco/filesys/alfresco/IOControlHandler.java b/source/java/org/alfresco/filesys/alfresco/IOControlHandler.java
index 17f306cb51..175e88ecbc 100644
--- a/source/java/org/alfresco/filesys/alfresco/IOControlHandler.java
+++ b/source/java/org/alfresco/filesys/alfresco/IOControlHandler.java
@@ -37,16 +37,16 @@ public interface IOControlHandler
/**
* ProcessIOControl
*
- * @param sess
- * @param tree
- * @param ctrlCode
- * @param fid
- * @param dataBuf
- * @param isFSCtrl
- * @param filter
- * @param contentDriver
- * @param contentContext
- * @return
+ * @param sess SrvSession
+ * @param tree TreeConnection
+ * @param ctrlCode int
+ * @param fid int
+ * @param dataBuf DataBuffer
+ * @param isFSCtrl boolean
+ * @param filter int
+ * @param contentDriver Object
+ * @param contentContext ContentContext
+ * @return DataBuffer
*/
public org.alfresco.jlan.util.DataBuffer processIOControl(SrvSession sess, TreeConnection tree, int ctrlCode, int fid, DataBuffer dataBuf,
boolean isFSCtrl, int filter, Object contentDriver, ContentContext contentContext)
diff --git a/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java b/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java
index 9dc534a61c..5068523993 100644
--- a/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java
+++ b/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java
@@ -35,7 +35,7 @@ public interface RepositoryDiskInterface
/**
* Copy the content from one node to another.
*
- * @param rootNode
+ * @param rootNode NodeRef
* @param fromPath - the source node
* @param toPath - the target node
* @throws FileNotFoundException
@@ -46,10 +46,10 @@ public interface RepositoryDiskInterface
/**
* CreateFile.
*
- * @param rootNode
+ * @param rootNode NodeRef
* @param Path - path
* @param allocationSize size to allocate for new file
- * @param isHidden
+ * @param isHidden boolean
* @throws FileNotFoundException
*/
public NetworkFile createFile(NodeRef rootNode, String Path, long allocationSize, boolean isHidden) throws IOException;
@@ -59,12 +59,12 @@ public interface RepositoryDiskInterface
*
* Either restores the file or creates a new one.
*
- * @param sess
- * @param tree
- * @param rootNode
+ * @param sess SrvSession
+ * @param tree TreeConnection
+ * @param rootNode NodeRef
* @param path - path
* @param allocationSize size to allocate for new file
- * @param originalNodeRef
+ * @param originalNodeRef NodeRef
* @throws FileNotFoundException
*/
public NetworkFile restoreFile(SrvSession sess,
@@ -79,10 +79,10 @@ public interface RepositoryDiskInterface
*
* @param session // temp until refactor
* @param tree // temp until refactor
- * @param rootNode
- * @param path
- * @param mode
- * @param truncate
+ * @param rootNode NodeRef
+ * @param path String
+ * @param mode OpenFileMode
+ * @param truncate boolean
* @return NetworkFile
*/
public NetworkFile openFile(SrvSession session, TreeConnection tree, NodeRef rootNode, String path, OpenFileMode mode, boolean truncate) throws IOException;
@@ -90,8 +90,8 @@ public interface RepositoryDiskInterface
/**
* CloseFile.
*
- * @param tree
- * @param rootNode
+ * @param tree TreeConnection
+ * @param rootNode NodeRef
* @param Path - path
* @param file - file
* @throws FileNotFoundException
@@ -102,10 +102,10 @@ public interface RepositoryDiskInterface
/**
* Delete file
- * @param session
- * @param tree
- * @param rootNode
- * @param path
+ * @param session SrvSession
+ * @param tree TreeConnection
+ * @param rootNode NodeRef
+ * @param path String
* @return NodeRef of file deleted or null if no file deleted
* @throws IOException
*/
@@ -113,16 +113,16 @@ public interface RepositoryDiskInterface
/**
*
- * @param session
- * @param tree
- * @param file
+ * @param session SrvSession
+ * @param tree TreeConnection
+ * @param file NetworkFile
*/
public void reduceQuota(SrvSession session, TreeConnection tree, NetworkFile file);
/**
*
- * @param rootNode
- * @param path
+ * @param rootNode NodeRef
+ * @param path String
*/
public void deleteEmptyFile(NodeRef rootNode, String path);
@@ -132,7 +132,7 @@ public interface RepositoryDiskInterface
* @param rootNode root node
* @param oldName java.lang.String
* @param newName java.lang.String
- * @param soft
+ * @param soft boolean
* @param moveAsSystem move as system
* @exception java.io.IOException The exception description.
*/
diff --git a/source/java/org/alfresco/filesys/alfresco/ShuffleCache.java b/source/java/org/alfresco/filesys/alfresco/ShuffleCache.java
index 7d7a7fd46d..682db064ce 100644
--- a/source/java/org/alfresco/filesys/alfresco/ShuffleCache.java
+++ b/source/java/org/alfresco/filesys/alfresco/ShuffleCache.java
@@ -16,8 +16,6 @@ public interface ShuffleCache
/**
* Add a new temporary file to the "shuffle cache". Content is not persisted
* in the alfresco repo until either a rename occurs or after a time delay.
- *
- * @return content writer?
*/
public void createTemporaryFile(String path);
@@ -42,8 +40,8 @@ public interface ShuffleCache
/**
* Does the specified directory contain a shuffled temporary file
- * @param dir
- * @return
+ * @param dir String
+ * @return boolean
*/
boolean isShuffleDirectory(String dir);
@@ -54,8 +52,8 @@ public interface ShuffleCache
/**
* Has the path been "soft created"
- * @param path
- * @return
+ * @param path String
+ * @return boolean
*/
boolean isCreated(String path);
}
diff --git a/source/java/org/alfresco/filesys/config/FTPConfigBean.java b/source/java/org/alfresco/filesys/config/FTPConfigBean.java
index 3c7fa85d78..eaee952169 100644
--- a/source/java/org/alfresco/filesys/config/FTPConfigBean.java
+++ b/source/java/org/alfresco/filesys/config/FTPConfigBean.java
@@ -157,7 +157,7 @@ public class FTPConfigBean
/**
* Gets the sesion timeout
- * @return
+ * @return Integer
*/
public Integer getSessionTimeout()
{
diff --git a/source/java/org/alfresco/filesys/config/ServerConfigurationBean.java b/source/java/org/alfresco/filesys/config/ServerConfigurationBean.java
index 92b31e1b40..3a321e58f7 100644
--- a/source/java/org/alfresco/filesys/config/ServerConfigurationBean.java
+++ b/source/java/org/alfresco/filesys/config/ServerConfigurationBean.java
@@ -1906,8 +1906,8 @@ public class ServerConfigurationBean extends AbstractServerConfigurationBean imp
* the disk interface is a {@link BufferedContentDiskDriver} and its disk
* interface is a ContentDiskDriver2 (wrapped by several other DiskInterface objects).
*
- * @param diskInterface
- * @return
+ * @param diskInterface ExtendedDiskInterface
+ * @return boolean
*/
private boolean isContentDiskDriver2(ExtendedDiskInterface diskInterface)
{
@@ -2258,7 +2258,8 @@ public class ServerConfigurationBean extends AbstractServerConfigurationBean imp
*
* TODO - what about desktop actions etc?
*
- * @param diskCtx
+ * @param uniqueName String
+ * @param diskCtx AlfrescoContext
*/
public void initialiseRuntimeContext(String uniqueName, AlfrescoContext diskCtx)
{
diff --git a/source/java/org/alfresco/filesys/repo/CifsHelper.java b/source/java/org/alfresco/filesys/repo/CifsHelper.java
index 3ccd593f43..c48677f880 100644
--- a/source/java/org/alfresco/filesys/repo/CifsHelper.java
+++ b/source/java/org/alfresco/filesys/repo/CifsHelper.java
@@ -165,12 +165,12 @@ public class CifsHelper
public void setReadOnlyFlagOnFolders(boolean setReadOnlyFlagOnFolders)
{
this.isReadOnlyFlagOnFolders = setReadOnlyFlagOnFolders;
- }
-
- /**
- * @param nodeRef
- * @return Returns true if the node is a subtype of {@link ContentModel#TYPE_FOLDER folder}
- * @throws AlfrescoRuntimeException if the type is neither related to a folder or content
+ }
+
+ /**
+ * @param nodeRef
+ * @return Returns true if the node is a subtype of {@link ContentModel#TYPE_FOLDER folder}
+ * @throws AlfrescoRuntimeException if the type is neither related to a folder or content
*/
public boolean isDirectory(NodeRef nodeRef)
{
@@ -208,7 +208,7 @@ public class CifsHelper
* Perform a set of commands as a unit of transactional work.
*
* @return Return the result of the unit of work
- * @throws Throwable This can be anything and will guarantee either a retry or a rollback
+ * @throws IOException
*/
public ContentFileInfo execute() throws IOException
{
@@ -244,7 +244,7 @@ public class CifsHelper
* Perform a set of commands as a unit of transactional work.
*
* @return Return the result of the unit of work
- * @throws Throwable This can be anything and will guarantee either a retry or a rollback
+ * @throws IOException
*/
public ContentFileInfo execute() throws IOException
{
@@ -481,13 +481,13 @@ public class CifsHelper
*
* If the directory path doesn't exist, then all the parent directories will be created.
* If the file path is null, then the file will not be created
- *
- * @param rootNodeRef the root node of the path
- * @param path the path to a node
- * @param typeQName type of fole
- * @return Returns a newly created file or folder node
- * @throws FileExistsException if the file or folder already exists
- */
+ *
+ * @param rootNodeRef the root node of the path
+ * @param path the path to a node
+ * @param typeQName type of fole
+ * @return Returns a newly created file or folder node
+ * @throws FileExistsException if the file or folder already exists
+ */
public NodeRef createNode(NodeRef rootNodeRef, String path, QName typeQName) throws FileExistsException
{
// split the path up into its constituents
@@ -623,13 +623,13 @@ public class CifsHelper
* Examples of the path are:
*
*
\New Folder\New Text Document.txt
- *
\New Folder\Sub Folder
- *
- *
- * @param pathRootNodeRef the node from which to start the path search
- * @param path the search path to either a folder or file
- * @return Returns references to all matching nodes
- */
+ *
\New Folder\Sub Folder
+ *
+ *
+ * @param pathRootNodeRef the node from which to start the path search
+ * @param path the search path to either a folder or file
+ * @return Returns references to all matching nodes
+ */
public List getNodeRefs(NodeRef pathRootNodeRef, String path)
{
// tokenize the path and push into a stack in reverse order so that
@@ -708,16 +708,16 @@ public class CifsHelper
return nodeRef;
}
- /**
- * Relink the content data from a new node to an existing node to preserve the version history.
- *
- * @param tempNodeRef temp nodeRef
- * @param nodeToMoveRef NodeRef
- * @param newParentNodeRef NodeRef
- * @param newName new name
- */
- public void relinkNode(NodeRef tempNodeRef, NodeRef nodeToMoveRef, NodeRef newParentNodeRef, String newName)
- throws FileNotFoundException, FileExistsException
+ /**
+ * Relink the content data from a new node to an existing node to preserve the version history.
+ *
+ * @param tempNodeRef temp nodeRef
+ * @param nodeToMoveRef NodeRef
+ * @param newParentNodeRef NodeRef
+ * @param newName new name
+ */
+ public void relinkNode(NodeRef tempNodeRef, NodeRef nodeToMoveRef, NodeRef newParentNodeRef, String newName)
+ throws FileNotFoundException, FileExistsException
{
// Get the properties for the old and new nodes
org.alfresco.service.cmr.model.FileInfo tempFileInfo = fileFolderService.getFileInfo(tempNodeRef);
@@ -837,7 +837,7 @@ public class CifsHelper
* Perform a set of commands as a unit of transactional work.
*
* @return Return the result of the unit of work
- * @throws Throwable This can be anything and will guarantee either a retry or a rollback
+ * @throws IOException
*/
public String execute() throws IOException
{
@@ -853,7 +853,6 @@ public class CifsHelper
*
* @param node NodeRef
* @return String
- * @throws FileNotFoundException
*/
public String getFileNameImpl(NodeRef node)
{
diff --git a/source/java/org/alfresco/filesys/repo/CommandExecutorImpl.java b/source/java/org/alfresco/filesys/repo/CommandExecutorImpl.java
index 8c23756931..06bc9a90a2 100644
--- a/source/java/org/alfresco/filesys/repo/CommandExecutorImpl.java
+++ b/source/java/org/alfresco/filesys/repo/CommandExecutorImpl.java
@@ -81,7 +81,7 @@ public class CommandExecutorImpl implements CommandExecutor
* Perform a set of commands as a unit of transactional work.
*
* @return Return the result of the unit of work
- * @throws Throwable This can be anything and will guarantee either a retry or a rollback
+ * @throws IOException
*/
public Object execute() throws IOException
{
@@ -159,11 +159,11 @@ public class CommandExecutorImpl implements CommandExecutor
}
/**
- * @param sess
- * @param tree
- * @param command
- * @param result
- * @return
+ * @param sess SrvSession
+ * @param tree TreeConnection
+ * @param command Command
+ * @param result Object
+ * @return Object
* @throws IOException
*/
private Object executeInternal(SrvSession sess, TreeConnection tree, Command command, Object result) throws IOException
@@ -377,7 +377,7 @@ public class CommandExecutorImpl implements CommandExecutor
private static final long serialVersionUID = 1L;
/**
- * @param cause
+ * @param cause Throwable
*/
public PropagatingException(Throwable cause)
{
diff --git a/source/java/org/alfresco/filesys/repo/ContentIOControlHandler.java b/source/java/org/alfresco/filesys/repo/ContentIOControlHandler.java
index 00ec6081be..8c9bbe74fd 100644
--- a/source/java/org/alfresco/filesys/repo/ContentIOControlHandler.java
+++ b/source/java/org/alfresco/filesys/repo/ContentIOControlHandler.java
@@ -91,11 +91,6 @@ public class ContentIOControlHandler implements IOControlHandler
PropertyCheck.mandatory(this, "transactionService", getTransactionService());
}
- /**
- * Return the node service
- *
- * @return NodeService
- */
public final void setNodeService( NodeService nodeService)
{
this.nodeService = nodeService;
diff --git a/source/java/org/alfresco/filesys/repo/FilesystemTransactionAdvice.java b/source/java/org/alfresco/filesys/repo/FilesystemTransactionAdvice.java
index ca934eab72..d680a805e4 100644
--- a/source/java/org/alfresco/filesys/repo/FilesystemTransactionAdvice.java
+++ b/source/java/org/alfresco/filesys/repo/FilesystemTransactionAdvice.java
@@ -1,19 +1,19 @@
/*
- * Copyright (C) 2005-2010 Alfresco Software Limited.
- *
- * This file is part of Alfresco
- *
- * Alfresco is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Alfresco is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see .
*/
package org.alfresco.filesys.repo;
@@ -37,8 +37,8 @@ import org.aopalliance.intercept.MethodInvocation;
* In particular must avoid wrapping JLAN's checked exceptions with an AlfrescoRuntimeException
* (so must throw IOException etc)
*
- * @See DiskInterface
- * @See IOControlHandler
+ * @see org.alfresco.jlan.server.filesys.DiskInterface
+ * @see org.alfresco.filesys.alfresco.IOControlHandler
*
*/
public class FilesystemTransactionAdvice implements MethodInterceptor
diff --git a/source/java/org/alfresco/filesys/repo/NodeMonitor.java b/source/java/org/alfresco/filesys/repo/NodeMonitor.java
index 66fc166b1d..c2ffc96255 100644
--- a/source/java/org/alfresco/filesys/repo/NodeMonitor.java
+++ b/source/java/org/alfresco/filesys/repo/NodeMonitor.java
@@ -424,7 +424,7 @@ public class NodeMonitor extends TransactionListenerAdapter
*
* @param parentNodeRef the old parent of the node
* @param nodeName the old name of the childs
- * @return
+ * @return String
*/
private String buildRelativePathString(NodeRef parentNodeRef, String nodeName) {
Path nodePath = m_nodeService.getPath(parentNodeRef);
diff --git a/source/java/org/alfresco/filesys/repo/NonTransactionalRuleContentDiskDriver.java b/source/java/org/alfresco/filesys/repo/NonTransactionalRuleContentDiskDriver.java
index 30886957a9..186eba83e9 100644
--- a/source/java/org/alfresco/filesys/repo/NonTransactionalRuleContentDiskDriver.java
+++ b/source/java/org/alfresco/filesys/repo/NonTransactionalRuleContentDiskDriver.java
@@ -625,7 +625,7 @@ public class NonTransactionalRuleContentDiskDriver implements ExtendedDiskInterf
/**
* Get the driver state from the session.
- * @param sess
+ * @param sess SrvSession
* @return the driver state.
*/
private DriverState getDriverState(SrvSession sess)
@@ -651,9 +651,9 @@ public class NonTransactionalRuleContentDiskDriver implements ExtendedDiskInterf
/**
* Get the evaluator context from the state and the folder.
- * @param driverState
- * @param folder
- * @return
+ * @param driverState DriverState
+ * @param folder String
+ * @return EvaluatorContext
*/
private EvaluatorContext getEvaluatorContext(DriverState driverState, String folder)
{
@@ -675,9 +675,9 @@ public class NonTransactionalRuleContentDiskDriver implements ExtendedDiskInterf
/**
* Release the evaluator context if there are no active scenarios.
- * @param driverState
- * @param ctx
- * @param folder
+ * @param driverState DriverState
+ * @param ctx EvaluatorContext
+ * @param folder String
*/
private void releaseEvaluatorContextIfEmpty(DriverState driverState, EvaluatorContext ctx, String folder)
{
diff --git a/source/java/org/alfresco/filesys/repo/TempNetworkFile.java b/source/java/org/alfresco/filesys/repo/TempNetworkFile.java
index 4744f51714..4a89784879 100644
--- a/source/java/org/alfresco/filesys/repo/TempNetworkFile.java
+++ b/source/java/org/alfresco/filesys/repo/TempNetworkFile.java
@@ -40,9 +40,9 @@ public class TempNetworkFile extends JavaNetworkFile
/**
* A new temporary network file with some existing content.
- * @param file
- * @param netPath
- * @param existingContent
+ * @param file File
+ * @param netPath String
+ * @param existingContent Reader
*/
public TempNetworkFile(File file, String netPath, Reader existingContent)
{
@@ -149,7 +149,7 @@ public class TempNetworkFile extends JavaNetworkFile
/**
* Tell JLAN it needs to call disk.closeFile rather than short cutting.
- * @return
+ * @return boolean
*/
public boolean allowsOpenCloseViaNetworkFile() {
return false;
diff --git a/source/java/org/alfresco/filesys/repo/rules/ScenarioCreateShuffleInstance.java b/source/java/org/alfresco/filesys/repo/rules/ScenarioCreateShuffleInstance.java
index 7f2553b7c5..583d4e4d73 100644
--- a/source/java/org/alfresco/filesys/repo/rules/ScenarioCreateShuffleInstance.java
+++ b/source/java/org/alfresco/filesys/repo/rules/ScenarioCreateShuffleInstance.java
@@ -83,7 +83,7 @@ public class ScenarioCreateShuffleInstance implements ScenarioInstance
/**
* Evaluate the next operation
- * @param operation
+ * @param operation Operation
*/
public Command evaluate(Operation operation)
{
diff --git a/source/java/org/alfresco/filesys/repo/rules/ScenarioDeleteRestoreInstance.java b/source/java/org/alfresco/filesys/repo/rules/ScenarioDeleteRestoreInstance.java
index 32dc2e35b7..80eaec2087 100644
--- a/source/java/org/alfresco/filesys/repo/rules/ScenarioDeleteRestoreInstance.java
+++ b/source/java/org/alfresco/filesys/repo/rules/ScenarioDeleteRestoreInstance.java
@@ -85,7 +85,7 @@ public class ScenarioDeleteRestoreInstance implements ScenarioInstance
/**
* Evaluate the next operation
- * @param operation
+ * @param operation Operation
*/
public Command evaluate(Operation operation)
{
diff --git a/source/java/org/alfresco/filesys/repo/rules/ScenarioInstance.java b/source/java/org/alfresco/filesys/repo/rules/ScenarioInstance.java
index 2a422d11fb..1142ecc948 100644
--- a/source/java/org/alfresco/filesys/repo/rules/ScenarioInstance.java
+++ b/source/java/org/alfresco/filesys/repo/rules/ScenarioInstance.java
@@ -36,21 +36,21 @@ public interface ScenarioInstance
/**
* Get the Ranking
- * @return
+ * @return Ranking
*/
public Ranking getRanking();
/**
* evaluate the scenario against the current operation
*
- * @param operation
+ * @param operation Operation
*/
public Command evaluate(Operation operation);
/**
* Is the scenario complete?
*
- * @return
+ * @return boolean
*/
public boolean isComplete();
diff --git a/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameDeleteMoveInstance.java b/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameDeleteMoveInstance.java
index e7d0dfbcfe..506e337eef 100644
--- a/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameDeleteMoveInstance.java
+++ b/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameDeleteMoveInstance.java
@@ -91,7 +91,7 @@ public class ScenarioRenameDeleteMoveInstance implements ScenarioInstance
/**
* Evaluate the next operation
*
- * @param operation
+ * @param operation Operation
*/
public Command evaluate(Operation operation)
{
diff --git a/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameShuffleInstance.java b/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameShuffleInstance.java
index 0158465322..cae7fb7257 100644
--- a/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameShuffleInstance.java
+++ b/source/java/org/alfresco/filesys/repo/rules/ScenarioRenameShuffleInstance.java
@@ -72,7 +72,7 @@ class ScenarioRenameShuffleInstance implements ScenarioInstance
/**
* Evaluate the next operation
- * @param operation
+ * @param operation Operation
*/
public Command evaluate(Operation operation)
{
diff --git a/source/java/org/alfresco/opencmis/CMISConnector.java b/source/java/org/alfresco/opencmis/CMISConnector.java
index d768af1984..6d0f2d4d96 100644
--- a/source/java/org/alfresco/opencmis/CMISConnector.java
+++ b/source/java/org/alfresco/opencmis/CMISConnector.java
@@ -952,7 +952,8 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen
/**
* Asynchronously generates thumbnails for the given node.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
+ * @param thumbnailNames Set
*/
public void createThumbnails(NodeRef nodeRef, Set thumbnailNames)
{
@@ -1007,7 +1008,7 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen
/**
* Extracts metadata for the node.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
public void extractMetadata(NodeRef nodeRef)
{
@@ -1775,12 +1776,12 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen
/**
* Notifies listeners that a read has taken place.
*
- * @param nodeRef
- * @param name
- * @param mimeType
- * @param contentSize
- * @param encoding
- * @param range
+ * @param nodeRef NodeRef
+ * @param name String
+ * @param mimeType String
+ * @param contentSize long
+ * @param encoding String
+ * @param range String
*/
protected void publishReadEvent(final NodeRef nodeRef, final String name, final String mimeType, final long contentSize, final String encoding, final String range)
{
@@ -2828,8 +2829,8 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen
/**
* Converts Acl to map and ignore the indirect ACEs
*
- * @param acl
- * @return
+ * @param acl Acl
+ * @return Map
*/
private Map> convertAclToMap(Acl acl)
{
@@ -2875,9 +2876,9 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen
/**
* Filter acl to ignore inherited ACEs
*
- * @param nodeRef
- * @param acl
- * @return
+ * @param nodeRef NodeRef
+ * @param acl Acl
+ * @return Acl
*/
protected Acl excludeInheritedAces(NodeRef nodeRef, Acl acl)
{
diff --git a/source/java/org/alfresco/opencmis/dictionary/CMISAllowedActionEnum.java b/source/java/org/alfresco/opencmis/dictionary/CMISAllowedActionEnum.java
index 1b457d4ff4..de5e70f210 100644
--- a/source/java/org/alfresco/opencmis/dictionary/CMISAllowedActionEnum.java
+++ b/source/java/org/alfresco/opencmis/dictionary/CMISAllowedActionEnum.java
@@ -84,7 +84,8 @@ public enum CMISAllowedActionEnum
/**
* Construct
*
- * @param label
+ * @param label String
+ * @param keysAndPermissions String ...
*/
CMISAllowedActionEnum(String label, String ... keysAndPermissions)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/AbstractActionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/AbstractActionEvaluator.java
index 3ead69ffe4..8446639a86 100644
--- a/source/java/org/alfresco/opencmis/mapping/AbstractActionEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/AbstractActionEvaluator.java
@@ -36,8 +36,8 @@ public abstract class AbstractActionEvaluator implements CMISActionEvaluator
/**
* Construct
*
- * @param serviceRegistry
- * @param action
+ * @param serviceRegistry ServiceRegistry
+ * @param action Action
*/
protected AbstractActionEvaluator(ServiceRegistry serviceRegistry, Action action)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/AbstractProperty.java b/source/java/org/alfresco/opencmis/mapping/AbstractProperty.java
index fdf22b4d90..a553f3ce0a 100644
--- a/source/java/org/alfresco/opencmis/mapping/AbstractProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/AbstractProperty.java
@@ -48,8 +48,9 @@ public abstract class AbstractProperty implements CMISPropertyAccessor
/**
* Construct
*
- * @param serviceRegistry
- * @param propertyName
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
+ * @param propertyName String
*/
protected AbstractProperty(ServiceRegistry serviceRegistry, CMISConnector connector, String propertyName)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/AllowedChildObjectTypeIdsProperty.java b/source/java/org/alfresco/opencmis/mapping/AllowedChildObjectTypeIdsProperty.java
index 6996813391..ac1738490a 100644
--- a/source/java/org/alfresco/opencmis/mapping/AllowedChildObjectTypeIdsProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/AllowedChildObjectTypeIdsProperty.java
@@ -40,8 +40,10 @@ public class AllowedChildObjectTypeIdsProperty extends AbstractProperty
/**
* Construct
- *
- * @param serviceRegistry
+ *
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
+ * @param cmisMapping CMISMapping
*/
public AllowedChildObjectTypeIdsProperty(ServiceRegistry serviceRegistry, CMISConnector connector,
CMISMapping cmisMapping)
diff --git a/source/java/org/alfresco/opencmis/mapping/BaseTypeIdProperty.java b/source/java/org/alfresco/opencmis/mapping/BaseTypeIdProperty.java
index 79f588eaa1..30b3b0e729 100644
--- a/source/java/org/alfresco/opencmis/mapping/BaseTypeIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/BaseTypeIdProperty.java
@@ -36,7 +36,8 @@ public class BaseTypeIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public BaseTypeIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/CanDeleteDocumentEvaluator.java b/source/java/org/alfresco/opencmis/mapping/CanDeleteDocumentEvaluator.java
index 78abec70c6..d3061f37ff 100644
--- a/source/java/org/alfresco/opencmis/mapping/CanDeleteDocumentEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/CanDeleteDocumentEvaluator.java
@@ -13,7 +13,7 @@ public class CanDeleteDocumentEvaluator extends AbstractActionEvaluator
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
*/
protected CanDeleteDocumentEvaluator(ServiceRegistry serviceRegistry)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/CheckinCommentProperty.java b/source/java/org/alfresco/opencmis/mapping/CheckinCommentProperty.java
index 240ecd6b6b..fe1c586e29 100644
--- a/source/java/org/alfresco/opencmis/mapping/CheckinCommentProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/CheckinCommentProperty.java
@@ -35,7 +35,8 @@ public class CheckinCommentProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public CheckinCommentProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ContentStreamIdProperty.java b/source/java/org/alfresco/opencmis/mapping/ContentStreamIdProperty.java
index a3ee778371..a8a6dc55e0 100644
--- a/source/java/org/alfresco/opencmis/mapping/ContentStreamIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ContentStreamIdProperty.java
@@ -36,7 +36,8 @@ public class ContentStreamIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ContentStreamIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ContentStreamLengthProperty.java b/source/java/org/alfresco/opencmis/mapping/ContentStreamLengthProperty.java
index 70c4f9630f..1c4a43d5ae 100644
--- a/source/java/org/alfresco/opencmis/mapping/ContentStreamLengthProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ContentStreamLengthProperty.java
@@ -38,7 +38,8 @@ public class ContentStreamLengthProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ContentStreamLengthProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ContentStreamMimetypeProperty.java b/source/java/org/alfresco/opencmis/mapping/ContentStreamMimetypeProperty.java
index 1d916ab88c..504977122a 100644
--- a/source/java/org/alfresco/opencmis/mapping/ContentStreamMimetypeProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ContentStreamMimetypeProperty.java
@@ -41,7 +41,8 @@ public class ContentStreamMimetypeProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ContentStreamMimetypeProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/CreationDateProperty.java b/source/java/org/alfresco/opencmis/mapping/CreationDateProperty.java
index 79bf1a2e9f..042471256b 100644
--- a/source/java/org/alfresco/opencmis/mapping/CreationDateProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/CreationDateProperty.java
@@ -35,7 +35,8 @@ public class CreationDateProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public CreationDateProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/CurrentVersionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/CurrentVersionEvaluator.java
index e89ab2c10a..0dbe548ee2 100644
--- a/source/java/org/alfresco/opencmis/mapping/CurrentVersionEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/CurrentVersionEvaluator.java
@@ -31,8 +31,11 @@ public class CurrentVersionEvaluator extends AbstractActionEvaluator
/**
* Construct
- *
- * @param serviceRegistry
+ *
+ * @param serviceRegistry ServiceRegistry
+ * @param action Action
+ * @param currentVersionValue boolean
+ * @param nonCurrentVersionValue boolean
*/
protected CurrentVersionEvaluator(ServiceRegistry serviceRegistry, Action action, boolean currentVersionValue,
boolean nonCurrentVersionValue)
diff --git a/source/java/org/alfresco/opencmis/mapping/DescriptionProperty.java b/source/java/org/alfresco/opencmis/mapping/DescriptionProperty.java
index 8a635ae701..4449562d80 100644
--- a/source/java/org/alfresco/opencmis/mapping/DescriptionProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/DescriptionProperty.java
@@ -37,8 +37,8 @@ public class DescriptionProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
- * @param connector
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public DescriptionProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/FixedValueActionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/FixedValueActionEvaluator.java
index b2338d4d3e..a172cc0cc0 100644
--- a/source/java/org/alfresco/opencmis/mapping/FixedValueActionEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/FixedValueActionEvaluator.java
@@ -35,8 +35,9 @@ public class FixedValueActionEvaluator extends AbstractActionEvaluator
/**
* Construct
*
- * @param serviceRegistry
- * @param action
+ * @param serviceRegistry ServiceRegistry
+ * @param action Action
+ * @param allowed boolean
*/
protected FixedValueActionEvaluator(ServiceRegistry serviceRegistry, Action action, boolean allowed)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/FixedValueProperty.java b/source/java/org/alfresco/opencmis/mapping/FixedValueProperty.java
index cb43a2f4c7..bbef870841 100644
--- a/source/java/org/alfresco/opencmis/mapping/FixedValueProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/FixedValueProperty.java
@@ -36,9 +36,10 @@ public class FixedValueProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
- * @param propertyName
- * @param value
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
+ * @param propertyName String
+ * @param value Serializable
*/
public FixedValueProperty(ServiceRegistry serviceRegistry, CMISConnector connector, String propertyName,
Serializable value)
diff --git a/source/java/org/alfresco/opencmis/mapping/IsLatestMajorVersionProperty.java b/source/java/org/alfresco/opencmis/mapping/IsLatestMajorVersionProperty.java
index 80c303ceb1..b8c038928b 100644
--- a/source/java/org/alfresco/opencmis/mapping/IsLatestMajorVersionProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/IsLatestMajorVersionProperty.java
@@ -35,7 +35,8 @@ public class IsLatestMajorVersionProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public IsLatestMajorVersionProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/IsMajorVersionProperty.java b/source/java/org/alfresco/opencmis/mapping/IsMajorVersionProperty.java
index 9521bb264f..e6e11fdff2 100644
--- a/source/java/org/alfresco/opencmis/mapping/IsMajorVersionProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/IsMajorVersionProperty.java
@@ -35,7 +35,8 @@ public class IsMajorVersionProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public IsMajorVersionProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ModificationDateProperty.java b/source/java/org/alfresco/opencmis/mapping/ModificationDateProperty.java
index 3df8cb00a8..daae51a5bd 100644
--- a/source/java/org/alfresco/opencmis/mapping/ModificationDateProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ModificationDateProperty.java
@@ -35,7 +35,8 @@ public class ModificationDateProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ModificationDateProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/NameProperty.java b/source/java/org/alfresco/opencmis/mapping/NameProperty.java
index 696ad573cd..57813d3096 100644
--- a/source/java/org/alfresco/opencmis/mapping/NameProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/NameProperty.java
@@ -37,7 +37,7 @@ public class NameProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
*/
public NameProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/NodeRefProperty.java b/source/java/org/alfresco/opencmis/mapping/NodeRefProperty.java
index 219b5d555f..c7ee342511 100644
--- a/source/java/org/alfresco/opencmis/mapping/NodeRefProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/NodeRefProperty.java
@@ -34,7 +34,7 @@ public class NodeRefProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
*/
public NodeRefProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ObjectIdProperty.java b/source/java/org/alfresco/opencmis/mapping/ObjectIdProperty.java
index 4e91808c5d..9983cb1eef 100644
--- a/source/java/org/alfresco/opencmis/mapping/ObjectIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ObjectIdProperty.java
@@ -35,7 +35,8 @@ public class ObjectIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ObjectIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ObjectTypeIdProperty.java b/source/java/org/alfresco/opencmis/mapping/ObjectTypeIdProperty.java
index b853180c04..f9283e9995 100644
--- a/source/java/org/alfresco/opencmis/mapping/ObjectTypeIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ObjectTypeIdProperty.java
@@ -36,8 +36,10 @@ public class ObjectTypeIdProperty extends AbstractProperty
{
/**
* Construct
- *
- * @param serviceRegistry
+ *
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
+ * @param dictionaryService CMISDictionaryService
*/
public ObjectTypeIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector,
CMISDictionaryService dictionaryService)
diff --git a/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java
index d00716e31b..62f5f15437 100644
--- a/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java
@@ -34,7 +34,7 @@ public class ParentActionEvaluator extends AbstractActionEvaluator
/**
* Construct
*
- * @param evaluator
+ * @param evaluator AbstractActionEvaluator
*/
protected ParentActionEvaluator(AbstractActionEvaluator evaluator)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/ParentProperty.java b/source/java/org/alfresco/opencmis/mapping/ParentProperty.java
index bc45599dff..f67b3817e7 100644
--- a/source/java/org/alfresco/opencmis/mapping/ParentProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/ParentProperty.java
@@ -37,7 +37,8 @@ public class ParentProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public ParentProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/PathProperty.java b/source/java/org/alfresco/opencmis/mapping/PathProperty.java
index 87261627f7..11b523f303 100644
--- a/source/java/org/alfresco/opencmis/mapping/PathProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/PathProperty.java
@@ -35,7 +35,8 @@ public class PathProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public PathProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/PermissionActionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/PermissionActionEvaluator.java
index a0cde4ff46..f623eccfde 100644
--- a/source/java/org/alfresco/opencmis/mapping/PermissionActionEvaluator.java
+++ b/source/java/org/alfresco/opencmis/mapping/PermissionActionEvaluator.java
@@ -37,8 +37,9 @@ public class PermissionActionEvaluator extends AbstractActionEvaluator
/**
* Construct
*
- * @param serviceRegistry
- * @param permission
+ * @param serviceRegistry ServiceRegistry
+ * @param action Action
+ * @param permission String...
*/
protected PermissionActionEvaluator(ServiceRegistry serviceRegistry, Action action, String... permission)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java b/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java
index c6b1c847db..0cdbbf3fdc 100644
--- a/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java
+++ b/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java
@@ -59,37 +59,37 @@ public class RuntimePropertyAccessorMapping implements PropertyAccessorMapping,
private CMISDictionaryService cmisDictionaryService;
private Map propertyAccessors = new HashMap();
- private Map> actionEvaluators = new HashMap>();
-
- /**
- * @param serviceRegistry
- */
- public void setServiceRegistry(ServiceRegistry serviceRegistry)
- {
+ private Map> actionEvaluators = new HashMap>();
+
+ /**
+ * @param serviceRegistry ServiceRegistry
+ */
+ public void setServiceRegistry(ServiceRegistry serviceRegistry)
+ {
this.serviceRegistry = serviceRegistry;
- }
-
- /**
- * @param cmisConnector
- */
- public void setCmisConnector(CMISConnector cmisConnector)
- {
+ }
+
+ /**
+ * @param cmisConnector CMISConnector
+ */
+ public void setCmisConnector(CMISConnector cmisConnector)
+ {
this.cmisConnector = cmisConnector;
- }
-
- /**
- * @param cmisMapping
- */
- public void setCmisMapping(CMISMapping cmisMapping)
- {
+ }
+
+ /**
+ * @param cmisMapping CMISMapping
+ */
+ public void setCmisMapping(CMISMapping cmisMapping)
+ {
this.cmisMapping = cmisMapping;
- }
-
- /**
- * @param cmisDictionaryService
- */
- public void setCmisDictionaryService(CMISDictionaryService cmisDictionaryService)
- {
+ }
+
+ /**
+ * @param cmisDictionaryService CMISDictionaryService
+ */
+ public void setCmisDictionaryService(CMISDictionaryService cmisDictionaryService)
+ {
this.cmisDictionaryService = cmisDictionaryService;
}
@@ -330,7 +330,7 @@ public class RuntimePropertyAccessorMapping implements PropertyAccessorMapping,
/**
* Register pre-defined Property Accessor
*
- * @param propertyAccessor
+ * @param propertyAccessor AbstractProperty
*/
private void registerPropertyAccessor(AbstractProperty propertyAccessor)
{
@@ -340,7 +340,7 @@ public class RuntimePropertyAccessorMapping implements PropertyAccessorMapping,
/**
* Gets the Action Evaluators applicable for the given CMIS Scope
*
- * @param scope
+ * @param scope BaseTypeId
*/
public Map getActionEvaluators(BaseTypeId scope)
{
@@ -355,8 +355,8 @@ public class RuntimePropertyAccessorMapping implements PropertyAccessorMapping,
/**
* Register an Action Evaluator
*
- * @param scope
- * @param evaluator
+ * @param scope BaseTypeId
+ * @param evaluator CMISActionEvaluator
*/
private void registerEvaluator(BaseTypeId scope, CMISActionEvaluator evaluator)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/SourceIdProperty.java b/source/java/org/alfresco/opencmis/mapping/SourceIdProperty.java
index 77fccd453a..1e054918f7 100644
--- a/source/java/org/alfresco/opencmis/mapping/SourceIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/SourceIdProperty.java
@@ -35,7 +35,8 @@ public class SourceIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public SourceIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/TargetIdProperty.java b/source/java/org/alfresco/opencmis/mapping/TargetIdProperty.java
index 16a266210d..b52aebe5e5 100644
--- a/source/java/org/alfresco/opencmis/mapping/TargetIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/TargetIdProperty.java
@@ -36,7 +36,8 @@ public class TargetIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public TargetIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/VersionLabelProperty.java b/source/java/org/alfresco/opencmis/mapping/VersionLabelProperty.java
index 7f79cc0e14..86e2e5eb3e 100644
--- a/source/java/org/alfresco/opencmis/mapping/VersionLabelProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/VersionLabelProperty.java
@@ -33,7 +33,8 @@ public class VersionLabelProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public VersionLabelProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutByProperty.java b/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutByProperty.java
index 2025016e58..7ae254ff11 100644
--- a/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutByProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutByProperty.java
@@ -36,7 +36,8 @@ public class VersionSeriesCheckedOutByProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public VersionSeriesCheckedOutByProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutIdProperty.java b/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutIdProperty.java
index 9b115a9006..8f17b8bd72 100644
--- a/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutIdProperty.java
+++ b/source/java/org/alfresco/opencmis/mapping/VersionSeriesCheckedOutIdProperty.java
@@ -35,7 +35,8 @@ public class VersionSeriesCheckedOutIdProperty extends AbstractProperty
/**
* Construct
*
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
+ * @param connector CMISConnector
*/
public VersionSeriesCheckedOutIdProperty(ServiceRegistry serviceRegistry, CMISConnector connector)
{
diff --git a/source/java/org/alfresco/opencmis/search/CMISResultSet.java b/source/java/org/alfresco/opencmis/search/CMISResultSet.java
index c61803efc6..1dba29a776 100644
--- a/source/java/org/alfresco/opencmis/search/CMISResultSet.java
+++ b/source/java/org/alfresco/opencmis/search/CMISResultSet.java
@@ -299,7 +299,7 @@ public class CMISResultSet implements ResultSetSPI
* Create an iterator over the result set. Follows stadard ListIterator
* conventions
*
- * @param resultSet
+ * @param resultSet CMISResultSet
*/
public CMISResultSetRowIterator(CMISResultSet resultSet)
{
diff --git a/source/java/org/alfresco/repo/action/AbstractAsynchronousActionFilter.java b/source/java/org/alfresco/repo/action/AbstractAsynchronousActionFilter.java
index c0d706d78c..8d1a32d704 100644
--- a/source/java/org/alfresco/repo/action/AbstractAsynchronousActionFilter.java
+++ b/source/java/org/alfresco/repo/action/AbstractAsynchronousActionFilter.java
@@ -1,19 +1,19 @@
/*
- * Copyright (C) 2005-2010 Alfresco Software Limited.
- *
- * This file is part of Alfresco
- *
- * Alfresco is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Alfresco is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see .
*/
package org.alfresco.repo.action;
@@ -41,7 +41,7 @@ public abstract class AbstractAsynchronousActionFilter implements Comparator
*/
public ActionConditionImpl(
String id,
diff --git a/source/java/org/alfresco/repo/action/ActionServiceImpl.java b/source/java/org/alfresco/repo/action/ActionServiceImpl.java
index f18450d49a..ed7fe31fdc 100644
--- a/source/java/org/alfresco/repo/action/ActionServiceImpl.java
+++ b/source/java/org/alfresco/repo/action/ActionServiceImpl.java
@@ -214,13 +214,13 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
this.monitor = monitor;
}
- /**
- * Set the asynchronous action execution queues
- *
- * @param asynchronousActionExecutionQueues the asynchronous action execution
- * queues
- * @deprecated Rather than inject a Map, it is
- * preferable to inject individual {@link AsynchronousActionExecutionQueue} instances
+ /**
+ * Set the asynchronous action execution queues
+ *
+ * @param asynchronousActionExecutionQueues the asynchronous action execution
+ * queues
+ * @deprecated Rather than inject a Map, it is
+ * preferable to inject individual {@link AsynchronousActionExecutionQueue} instances
* during bean initialisation in a spring init-method.
*/
public void setAsynchronousActionExecutionQueues(
@@ -231,8 +231,8 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
/**
* This method registers an {@link AsynchronousActionExecutionQueue} with the {@link ActionService}.
- * @param key
- * @param asyncExecQueue
+ * @param key String
+ * @param asyncExecQueue AsynchronousActionExecutionQueue
* @since Thor Phase 2 Sprint 2
*/
public void registerAsynchronousActionExecutionQueue(String key, AsynchronousActionExecutionQueue asyncExecQueue)
@@ -398,13 +398,13 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
ActionCondition condition = createActionCondition(name);
condition.setParameterValues(params);
return condition;
- }
-
- /**
- * @see org.alfresco.service.cmr.action.ActionService#createAction(String)
- */
- public Action createAction(String name)
- {
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.action.ActionService#createAction(String)
+ */
+ public Action createAction(String name)
+ {
return new ActionImpl(null, GUID.generate(), name, null);
}
@@ -1234,8 +1234,8 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
/**
* Save the condition properties
*
- * @param conditionNodeRef
- * @param condition
+ * @param conditionNodeRef NodeRef
+ * @param condition ActionCondition
*/
private void saveConditionProperties(NodeRef conditionNodeRef, ActionCondition condition)
{
@@ -1660,12 +1660,12 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
actionTrackingService.recordActionPending(action, actionedUponNodeRef);
}
}
- }
- }
-
- @SuppressWarnings("unchecked")
- private List getPostTransactionPendingActions()
- {
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private List getPostTransactionPendingActions()
+ {
return (List) AlfrescoTransactionSupport.getResource(POST_TRANSACTION_PENDING_ACTIONS);
}
@@ -1775,13 +1775,13 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
return false;
}
}
- }
-
- /**
- * @return Returns {@link CopyBehaviourCallback}
- */
- public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails)
- {
+ }
+
+ /**
+ * @return Returns {@link CopyBehaviourCallback}
+ */
+ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails)
+ {
return ActionParameterTypeCopyBehaviourCallback.INSTANCE;
}
diff --git a/source/java/org/alfresco/repo/action/ActionsAspect.java b/source/java/org/alfresco/repo/action/ActionsAspect.java
index 03806874ee..8060d8a614 100644
--- a/source/java/org/alfresco/repo/action/ActionsAspect.java
+++ b/source/java/org/alfresco/repo/action/ActionsAspect.java
@@ -114,8 +114,8 @@ public class ActionsAspect implements CopyServicePolicies.OnCopyNodePolicy, Copy
/**
* On add aspect policy behaviour
*
- * @param nodeRef
- * @param aspectTypeQName
+ * @param nodeRef NodeRef
+ * @param aspectTypeQName QName
*/
public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName)
{
@@ -135,7 +135,7 @@ public class ActionsAspect implements CopyServicePolicies.OnCopyNodePolicy, Copy
}
/**
- * @return Returns {@link ActionsAspectCopyBehaviourCallback}
+ * @return Returns {@code ActionsAspectCopyBehaviourCallback}
*/
public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails)
{
diff --git a/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueue.java b/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueue.java
index f004be9817..302fb8137d 100644
--- a/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueue.java
+++ b/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueue.java
@@ -31,10 +31,11 @@ import org.alfresco.service.cmr.repository.NodeRef;
public interface AsynchronousActionExecutionQueue
{
/**
- *
- * @param actionedUponNodeRef
- * @param action
- * @param checkConditions
+ * @param actionService RuntimeActionService
+ * @param action Action
+ * @param actionedUponNodeRef NodeRef
+ * @param checkConditions boolean
+ * @param actionChain Set
*/
void executeAction(
RuntimeActionService actionService,
diff --git a/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueueImpl.java b/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueueImpl.java
index 30e6c50edc..805c1266e1 100644
--- a/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueueImpl.java
+++ b/source/java/org/alfresco/repo/action/AsynchronousActionExecutionQueueImpl.java
@@ -195,9 +195,6 @@ public class AsynchronousActionExecutionQueueImpl implements AsynchronousActionE
executeAction(actionService, action, actionedUponNodeRef, checkConditions, actionChain, null);
}
- /**
- * {@inheritDoc}
- */
@SuppressWarnings("unchecked")
public void executeAction(RuntimeActionService actionService, Action action, NodeRef actionedUponNodeRef,
boolean checkConditions, Set actionChain, NodeRef actionExecutionHistoryNodeRef)
diff --git a/source/java/org/alfresco/repo/action/CompositeActionImpl.java b/source/java/org/alfresco/repo/action/CompositeActionImpl.java
index 7ce561b807..5e0b8df072 100644
--- a/source/java/org/alfresco/repo/action/CompositeActionImpl.java
+++ b/source/java/org/alfresco/repo/action/CompositeActionImpl.java
@@ -52,7 +52,7 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param action
+ * @param action Action
* @see org.alfresco.service.cmr.action.ActionList#addAction(org.alfresco.service.cmr.action.Action)
*/
public void addAction(Action action)
@@ -61,8 +61,8 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param index
- * @param action
+ * @param index int
+ * @param action Action
* @see org.alfresco.service.cmr.action.ActionList#addAction(int,
* org.alfresco.service.cmr.action.Action)
*/
@@ -72,8 +72,8 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param index
- * @return
+ * @param index int
+ * @return Action
* @see org.alfresco.service.cmr.action.ActionList#getAction(int)
*/
public Action getAction(int index)
@@ -82,7 +82,7 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @return
+ * @return List
* @see org.alfresco.service.cmr.action.ActionList#getActions()
*/
public List getActions()
@@ -91,7 +91,7 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @return
+ * @return boolean
* @see org.alfresco.service.cmr.action.ActionList#hasActions()
*/
public boolean hasActions()
@@ -100,8 +100,8 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param action
- * @return
+ * @param action Action
+ * @return int
* @see org.alfresco.service.cmr.action.ActionList#indexOfAction(org.alfresco.service.cmr.action.Action)
*/
public int indexOfAction(Action action)
@@ -110,7 +110,7 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param action
+ * @param action Action
* @see org.alfresco.service.cmr.action.ActionList#removeAction(org.alfresco.service.cmr.action.Action)
*/
public void removeAction(Action action)
@@ -127,8 +127,8 @@ public class CompositeActionImpl extends ActionImpl implements CompositeAction
}
/**
- * @param index
- * @param action
+ * @param index int
+ * @param action Action
* @see org.alfresco.service.cmr.action.ActionList#setAction(int,
* org.alfresco.service.cmr.action.Action)
*/
diff --git a/source/java/org/alfresco/repo/action/ParameterDefinitionImpl.java b/source/java/org/alfresco/repo/action/ParameterDefinitionImpl.java
index 24adbf3ef1..ed47b99577 100644
--- a/source/java/org/alfresco/repo/action/ParameterDefinitionImpl.java
+++ b/source/java/org/alfresco/repo/action/ParameterDefinitionImpl.java
@@ -108,12 +108,12 @@ public class ParameterDefinitionImpl implements ParameterDefinition, Serializabl
/**
* Constructor
*
- * @param name
- * @param type
- * @param isMandatory
- * @param displayLabel
- * @param isMultiValued
- * @param parameterConstraintName
+ * @param name String
+ * @param type QName
+ * @param isMandatory boolean
+ * @param displayLabel String
+ * @param isMultiValued boolean
+ * @param parameterConstraintName String
*/
public ParameterDefinitionImpl(
String name,
diff --git a/source/java/org/alfresco/repo/action/ParameterizedItemAbstractBase.java b/source/java/org/alfresco/repo/action/ParameterizedItemAbstractBase.java
index 9bc29e13e4..46af4d49f8 100644
--- a/source/java/org/alfresco/repo/action/ParameterizedItemAbstractBase.java
+++ b/source/java/org/alfresco/repo/action/ParameterizedItemAbstractBase.java
@@ -91,13 +91,13 @@ public abstract class ParameterizedItemAbstractBase extends CommonResourceAbstra
*/
protected abstract void addParameterDefinitions(List paramList);
- /**
- * Sets the action service
- *
- * @param runtimeActionService the action service
- */
- public void setRuntimeActionService(RuntimeActionService runtimeActionService)
- {
+ /**
+ * Sets the action service
+ *
+ * @param runtimeActionService the action service
+ */
+ public void setRuntimeActionService(RuntimeActionService runtimeActionService)
+ {
this.runtimeActionService = runtimeActionService;
}
@@ -124,7 +124,7 @@ public abstract class ParameterizedItemAbstractBase extends CommonResourceAbstra
/**
* Setter for Spring injection of adhocPropertiesAllowed property
*
- * @param allowed
+ * @param allowed boolean
*/
public void setAdhocPropertiesAllowed(boolean allowed)
{
diff --git a/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java b/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java
index c6cafcfb9f..412cac75f9 100644
--- a/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java
+++ b/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java
@@ -67,7 +67,7 @@ public abstract class BaseParameterConstraint implements ParameterConstraint,
/**
* Determines whether the allowable values should be cached, default is true.
*
- * @param cache
+ * @param cache boolean
*/
public void setCacheAllowableValues(boolean cache)
{
@@ -113,14 +113,14 @@ public abstract class BaseParameterConstraint implements ParameterConstraint,
/**
* Gets the list of allowable values, calculating them every time it is called.
*
- * @return Map map of allowable values
+ * @return map of allowable values
*/
protected abstract Map getAllowableValuesImpl();
/**
* Get the I18N display label for a particular key
*
- * @param key
+ * @param key String
* @return String I18N value
*/
protected String getI18NLabel(String key)
@@ -135,21 +135,21 @@ public abstract class BaseParameterConstraint implements ParameterConstraint,
result = i18n;
}
return result;
- }
-
- /**
- * @see org.alfresco.service.cmr.action.ParameterConstraint#getValueDisplayLabel(String)
- */
- public String getValueDisplayLabel(String value)
- {
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.action.ParameterConstraint#getValueDisplayLabel(String)
+ */
+ public String getValueDisplayLabel(String value)
+ {
return getAllowableValues().get(value);
- }
-
- /**
- * @see org.alfresco.service.cmr.action.ParameterConstraint#isValidValue(String)
- */
- public boolean isValidValue(String value)
- {
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.action.ParameterConstraint#isValidValue(String)
+ */
+ public boolean isValidValue(String value)
+ {
return getAllowableValues().containsKey(value);
}
}
diff --git a/source/java/org/alfresco/repo/action/constraint/EnumParameterConstraint.java b/source/java/org/alfresco/repo/action/constraint/EnumParameterConstraint.java
index 5e35791621..d32c1a3460 100644
--- a/source/java/org/alfresco/repo/action/constraint/EnumParameterConstraint.java
+++ b/source/java/org/alfresco/repo/action/constraint/EnumParameterConstraint.java
@@ -73,7 +73,7 @@ public class EnumParameterConstraint extends BaseParameterConstraint
/**
* Get the enum class
*
- * @return
+ * @return Class
*/
private Class> getEnumClass()
{
diff --git a/source/java/org/alfresco/repo/action/constraint/MimetypeParameterConstraint.java b/source/java/org/alfresco/repo/action/constraint/MimetypeParameterConstraint.java
index fdfce4daac..ea1cc61b30 100644
--- a/source/java/org/alfresco/repo/action/constraint/MimetypeParameterConstraint.java
+++ b/source/java/org/alfresco/repo/action/constraint/MimetypeParameterConstraint.java
@@ -39,7 +39,7 @@ public class MimetypeParameterConstraint extends BaseParameterConstraint
/**
* Sets the mimetype map
*
- * @param mimetypeMap
+ * @param mimetypeMap MimetypeMap
*/
public void setMimetypeMap(MimetypeMap mimetypeMap)
{
diff --git a/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java b/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java
index 47049d2b9b..6e69f9b1d5 100644
--- a/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java
+++ b/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java
@@ -50,10 +50,10 @@ import org.apache.commons.logging.LogFactory;
/**
* Extract metadata from any added content.
*
- * Currently, the default {@linkplain MetadataExtracter.OverwritePolicy overwrite policy}
+ * Currently, the default {@linkplain org.alfresco.repo.content.metadata.MetadataExtracter.OverwritePolicy overwrite policy}
* for each extracter is used. (TODO: Add overwrite policy as a parameter.)
*
- * @see MetadataExtracter.OverwritePolicy
+ * @see org.alfresco.repo.content.metadata.MetadataExtracter.OverwritePolicy
*
* @author Jesper Steen Møller
*/
diff --git a/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java b/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java
index cac91371a4..1da9c8204b 100644
--- a/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java
+++ b/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java
@@ -100,7 +100,7 @@ public class ExporterActionExecuter extends ActionExecuterAbstractBase
/**
* Sets the MimetypeService to use
*
- * @param mimetypeService
+ * @param mimetypeService MimetypeService
*/
public void setMimetypeService(MimetypeService mimetypeService)
{
@@ -125,13 +125,13 @@ public class ExporterActionExecuter extends ActionExecuterAbstractBase
public void setContentService(ContentService contentService)
{
this.contentService = contentService;
- }
-
- /**
- * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef)
- */
- public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef)
- {
+ }
+
+ /**
+ * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef)
+ */
+ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef)
+ {
File zipFile = null;
try
{
diff --git a/source/java/org/alfresco/repo/action/executer/LoggingAwareExecuter.java b/source/java/org/alfresco/repo/action/executer/LoggingAwareExecuter.java
index 08b0297748..91433f10e7 100644
--- a/source/java/org/alfresco/repo/action/executer/LoggingAwareExecuter.java
+++ b/source/java/org/alfresco/repo/action/executer/LoggingAwareExecuter.java
@@ -8,7 +8,6 @@ public interface LoggingAwareExecuter
* Optional logging of errors callback for the action executer
* for the cases when the error might be ignored
* or shown in a different manner for the action
- * @param action the action
* @param logger the logger
* @param t the exception thrown
* @param message the proposed message that will be logged
diff --git a/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java b/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java
index 6b16e088ee..2476b50786 100644
--- a/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java
+++ b/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java
@@ -1105,8 +1105,8 @@ public class MailActionExecuter extends ActionExecuterAbstractBase
/**
*
- * @param ruleAction
- * @return
+ * @param ruleAction Action
+ * @return Pair
*/
private Pair getFrom(Action ruleAction)
{
@@ -1467,8 +1467,8 @@ public class MailActionExecuter extends ActionExecuterAbstractBase
/**
* Return true if address has valid format
- * @param address
- * @return
+ * @param address String
+ * @return boolean
*/
private boolean validateAddress(String address)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/AbstractScheduledAction.java b/source/java/org/alfresco/repo/action/scheduled/AbstractScheduledAction.java
index eaa6262049..b83af965bf 100644
--- a/source/java/org/alfresco/repo/action/scheduled/AbstractScheduledAction.java
+++ b/source/java/org/alfresco/repo/action/scheduled/AbstractScheduledAction.java
@@ -79,7 +79,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Generate a mode from a string.
*
- * @param transactionModeString
+ * @param transactionModeString String
* @return - the transaction mode.
*/
public static TransactionMode getTransactionMode(String transactionModeString)
@@ -125,7 +125,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Parse a string to a compensating action mode - used in reading the config.
*
- * @param compensatingActionModeString
+ * @param compensatingActionModeString String
* @return - the compensating action mode.
*/
public static CompensatingActionMode getCompensatingActionMode(String compensatingActionModeString)
@@ -204,7 +204,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set the user in whose name to run the action.
*
- * @param runAsUser
+ * @param runAsUser String
*/
public void setRunAsUser(String runAsUser)
{
@@ -223,7 +223,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set the action service - IOC.
*
- * @param actionService
+ * @param actionService ActionService
*/
public void setActionService(ActionService actionService)
{
@@ -243,7 +243,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set the behaviour for compensating actiions.
*
- * @param compensatingActionModeString
+ * @param compensatingActionModeString String
*/
public void setCompensatingActionMode(String compensatingActionModeString)
{
@@ -253,7 +253,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set transactional behaviour.
*
- * @param transactionModeString
+ * @param transactionModeString String
*/
public void setTransactionMode(String transactionModeString)
{
@@ -273,7 +273,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set the transactions service - IOC.
*
- * @param transactionService
+ * @param transactionService TransactionService
*/
public void setTransactionService(TransactionService transactionService)
{
@@ -282,7 +282,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Set the template action that is used to generate the real action for each node.
- * @param templateActionDefinition
+ * @param templateActionDefinition TemplateActionDefinition
*/
public void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition)
{
@@ -312,7 +312,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Register with teh scheduler.
*
- * @param scheduler
+ * @param scheduler Scheduler
* @throws SchedulerException
*/
public void register(Scheduler scheduler) throws SchedulerException
@@ -345,7 +345,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Generate the actual action for the given node from the action template.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return - the action to execute.
*/
public abstract Action getAction(NodeRef nodeRef);
@@ -379,7 +379,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Execute the job
*
- * @param ctx
+ * @param ctx JobExecutionContext
* @throws JobExecutionException
*
*/
@@ -447,7 +447,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Apply the action to all nodes in one overall transaction
*
- * @param nodes
+ * @param nodes List
*/
public void runTransactionalActions(final List nodes)
{
@@ -511,9 +511,9 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
*
* These are always in their own transaction. We try to run all compensating actions.
*
- * @param runCompensatingActions
- * @param rethrow
- * @param t
+ * @param runCompensatingActions boolean
+ * @param rethrow boolean
+ * @param t Throwable
*/
private void doCompensation(boolean runCompensatingActions, boolean rethrow, Throwable t)
{
@@ -545,7 +545,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Run a single transaction in its own tx
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
public void runTransactionalAction(final NodeRef nodeRef)
{
@@ -596,7 +596,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Manage running a compensating action and chaining all its compensating actions until done
*
- * @param pair
+ * @param pair Pair
*/
public void runTransactionalCompensatingAction(final Pair pair)
{
@@ -676,7 +676,7 @@ public abstract class AbstractScheduledAction implements ScheduledActionDefiniti
/**
* Support method to translate exceptions to runtime exceptions.
*
- * @param t
+ * @param t Throwable
* @return - the exception as a wrapped RuntimeException.
*/
private static Object throwRuntimeException(Throwable t)
diff --git a/source/java/org/alfresco/repo/action/scheduled/AbstractTemplateActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/AbstractTemplateActionDefinition.java
index 08dfb143c4..03c9beabae 100644
--- a/source/java/org/alfresco/repo/action/scheduled/AbstractTemplateActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/AbstractTemplateActionDefinition.java
@@ -64,7 +64,7 @@ public abstract class AbstractTemplateActionDefinition implements TemplateAction
/**
* Set the action service - IOC.
*
- * @param actionService
+ * @param actionService ActionService
*/
public void setActionService(ActionService actionService)
{
@@ -83,8 +83,8 @@ public abstract class AbstractTemplateActionDefinition implements TemplateAction
/**
* Set the template service - IOC.
- *
- * @param templateService
+ *
+ * @param templateService TemplateService
*/
public void setTemplateService(TemplateService templateService)
{
@@ -94,7 +94,7 @@ public abstract class AbstractTemplateActionDefinition implements TemplateAction
/**
* Set the template to define the compensating action.
*
- * @param compensatingTemplateActionDefinition
+ * @param compensatingTemplateActionDefinition TemplateActionDefinition
*/
public void setCompensatingTemplateCompositeActionDefinition(
TemplateActionDefinition compensatingTemplateActionDefinition)
diff --git a/source/java/org/alfresco/repo/action/scheduled/CompensatingActionException.java b/source/java/org/alfresco/repo/action/scheduled/CompensatingActionException.java
index d5edae1b60..187862a054 100644
--- a/source/java/org/alfresco/repo/action/scheduled/CompensatingActionException.java
+++ b/source/java/org/alfresco/repo/action/scheduled/CompensatingActionException.java
@@ -44,7 +44,7 @@ public class CompensatingActionException extends AlfrescoRuntimeException
/**
- * @param msgId
+ * @param msgId String
*/
public CompensatingActionException(String msgId)
{
@@ -53,9 +53,9 @@ public class CompensatingActionException extends AlfrescoRuntimeException
/**
*
- * @param msgId
- * @param cause
- * @param compensatingActions
+ * @param msgId String
+ * @param cause Throwable
+ * @param compensatingActions List>
*/
public CompensatingActionException(String msgId, Throwable cause, List> compensatingActions)
{
@@ -75,8 +75,8 @@ public class CompensatingActionException extends AlfrescoRuntimeException
/**
*
- * @param msgId
- * @param msgParams
+ * @param msgId String
+ * @param msgParams Object[]
*/
public CompensatingActionException(String msgId, Object[] msgParams)
{
@@ -85,8 +85,8 @@ public class CompensatingActionException extends AlfrescoRuntimeException
/**
*
- * @param msgId
- * @param cause
+ * @param msgId String
+ * @param cause Throwable
*/
public CompensatingActionException(String msgId, Throwable cause)
{
@@ -95,9 +95,9 @@ public class CompensatingActionException extends AlfrescoRuntimeException
/**
*
- * @param msgId
- * @param msgParams
- * @param cause
+ * @param msgId String
+ * @param msgParams Object[]
+ * @param cause Throwable
*/
public CompensatingActionException(String msgId, Object[] msgParams, Throwable cause)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/CompositeTemplateActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/CompositeTemplateActionDefinition.java
index f71133b23d..c025c7dd39 100644
--- a/source/java/org/alfresco/repo/action/scheduled/CompositeTemplateActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/CompositeTemplateActionDefinition.java
@@ -49,7 +49,7 @@ public class CompositeTemplateActionDefinition extends AbstractTemplateActionDef
/**
* Set the action templates - IOC.
*
- * @param templateActionDefinitions
+ * @param templateActionDefinitions List
*/
public void setTemplateActionDefinitions(List templateActionDefinitions)
{
@@ -69,7 +69,7 @@ public class CompositeTemplateActionDefinition extends AbstractTemplateActionDef
/**
* Build the composite action in the context of the given node.
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return - the contextualised action.
*
*/
diff --git a/source/java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinition.java
index 03a9dc10f2..59d7a5ff73 100644
--- a/source/java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinition.java
@@ -127,7 +127,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the search service.
*
- * @param searchService
+ * @param searchService SearchService
*/
public void setSearchService(SearchService searchService)
{
@@ -147,7 +147,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the template service.
*
- * @param templateService
+ * @param templateService TemplateService
*/
public void setTemplateService(TemplateService templateService)
{
@@ -165,7 +165,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the scheduler.
- * @param scheduler
+ * @param scheduler Scheduler
*/
public void setScheduler(Scheduler scheduler)
{
@@ -183,7 +183,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the template action model factory.
- * @param templateActionModelFactory
+ * @param templateActionModelFactory TemplateActionModelFactory
*/
public void setTemplateActionModelFactory(TemplateActionModelFactory templateActionModelFactory)
{
@@ -281,7 +281,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the query language
- * @param queryLanguage
+ * @param queryLanguage String
*/
public void setQueryLanguage(String queryLanguage)
{
@@ -319,7 +319,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the template for the query.
*
- * @param queryTemplate
+ * @param queryTemplate String
*/
public void setQueryTemplate(String queryTemplate)
{
@@ -337,7 +337,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the cron expression - see the wiki for examples.
- * @param cronExpression
+ * @param cronExpression String
*/
public void setCronExpression(String cronExpression)
{
@@ -356,7 +356,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the job name.
- * @param jobName
+ * @param jobName String
*/
public void setJobName(String jobName)
{
@@ -375,7 +375,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the job group.
- * @param jobGroup
+ * @param jobGroup String
*/
public void setJobGroup(String jobGroup)
{
@@ -393,7 +393,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the trigger name.
- * @param triggerName
+ * @param triggerName String
*/
public void setTriggerName(String triggerName)
{
@@ -411,7 +411,7 @@ public class CronScheduledQueryBasedTemplateActionDefinition extends AbstractSch
/**
* Set the trigger group.
- * @param triggerGroup
+ * @param triggerGroup String
*/
public void setTriggerGroup(String triggerGroup)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/FreeMarkerWithLuceneExtensionsModelFactory.java b/source/java/org/alfresco/repo/action/scheduled/FreeMarkerWithLuceneExtensionsModelFactory.java
index 29fa5f41d0..eb861f02f2 100644
--- a/source/java/org/alfresco/repo/action/scheduled/FreeMarkerWithLuceneExtensionsModelFactory.java
+++ b/source/java/org/alfresco/repo/action/scheduled/FreeMarkerWithLuceneExtensionsModelFactory.java
@@ -64,7 +64,7 @@ public class FreeMarkerWithLuceneExtensionsModelFactory implements TemplateActio
/**
* Set the service registry
- * @param serviceRegistry
+ * @param serviceRegistry ServiceRegistry
*/
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/InvalidCronExpression.java b/source/java/org/alfresco/repo/action/scheduled/InvalidCronExpression.java
index 274097b1df..068f6178c2 100644
--- a/source/java/org/alfresco/repo/action/scheduled/InvalidCronExpression.java
+++ b/source/java/org/alfresco/repo/action/scheduled/InvalidCronExpression.java
@@ -35,7 +35,7 @@ public class InvalidCronExpression extends ScheduledActionException
/**
* Invalid cron expression
*
- * @param msgId
+ * @param msgId String
*/
public InvalidCronExpression(String msgId)
{
@@ -45,8 +45,8 @@ public class InvalidCronExpression extends ScheduledActionException
/**
* Invalid cron expression
*
- * @param msgId
- * @param msgParams
+ * @param msgId String
+ * @param msgParams Object[]
*/
public InvalidCronExpression(String msgId, Object[] msgParams)
{
@@ -56,8 +56,8 @@ public class InvalidCronExpression extends ScheduledActionException
/**
* Invalid cron expression
*
- * @param msgId
- * @param cause
+ * @param msgId String
+ * @param cause Throwable
*/
public InvalidCronExpression(String msgId, Throwable cause)
{
@@ -66,9 +66,9 @@ public class InvalidCronExpression extends ScheduledActionException
/**
* Invalid cron expression
- * @param msgId
- * @param msgParams
- * @param cause
+ * @param msgId String
+ * @param msgParams Object[]
+ * @param cause Throwable
*/
public InvalidCronExpression(String msgId, Object[] msgParams, Throwable cause)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java
index b3c10c9052..fe21ebb5e4 100644
--- a/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java
@@ -36,7 +36,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Set the template action definition that is used to build the Action to execute.
*
- * @param templateActionDefinition
+ * @param templateActionDefinition TemplateActionDefinition
*/
public void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition);
@@ -50,7 +50,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Register with a scheduler. This should be called in the implementation afterPropertiesSet() method of InitializingBean
*
- * @param scheduler
+ * @param scheduler Scheduler
* @throws SchedulerException
*/
public void register(Scheduler scheduler) throws SchedulerException;
@@ -58,7 +58,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Set the name of the job - used for job admin
*
- * @param jobName
+ * @param jobName String
*/
public void setJobName(String jobName);
@@ -72,7 +72,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Set the job group - used for job admin
*
- * @param jobGroup
+ * @param jobGroup String
*/
public void setJobGroup(String jobGroup);
@@ -85,7 +85,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Set the trigger name - used for job admin
*
- * @param triggerName
+ * @param triggerName String
*/
public void setTriggerName(String triggerName);
@@ -98,7 +98,7 @@ public interface ScheduledActionDefinition extends InitializingBean
/**
* Set the trigger group - used for job admin
*
- * @param triggerGroup
+ * @param triggerGroup String
*/
public void setTriggerGroup(String triggerGroup);
diff --git a/source/java/org/alfresco/repo/action/scheduled/ScheduledActionException.java b/source/java/org/alfresco/repo/action/scheduled/ScheduledActionException.java
index e1a523a348..d23c4fedc6 100644
--- a/source/java/org/alfresco/repo/action/scheduled/ScheduledActionException.java
+++ b/source/java/org/alfresco/repo/action/scheduled/ScheduledActionException.java
@@ -36,7 +36,7 @@ public class ScheduledActionException extends AlfrescoRuntimeException
/**
* Exception generated from scheduled actions
*
- * @param msgId
+ * @param msgId String
*/
public ScheduledActionException(String msgId)
{
@@ -46,8 +46,8 @@ public class ScheduledActionException extends AlfrescoRuntimeException
/**
* Exception generated from scheduled actions
*
- * @param msgId
- * @param msgParams
+ * @param msgId String
+ * @param msgParams Object[]
*/
public ScheduledActionException(String msgId, Object[] msgParams)
{
@@ -57,8 +57,8 @@ public class ScheduledActionException extends AlfrescoRuntimeException
/**
* Exception generated from scheduled actions
*
- * @param msgId
- * @param cause
+ * @param msgId String
+ * @param cause Throwable
*/
public ScheduledActionException(String msgId, Throwable cause)
{
@@ -68,9 +68,9 @@ public class ScheduledActionException extends AlfrescoRuntimeException
/**
* Exception generated from scheduled actions
*
- * @param msgId
- * @param msgParams
- * @param cause
+ * @param msgId String
+ * @param msgParams Object[]
+ * @param cause Throwable
*/
public ScheduledActionException(String msgId, Object[] msgParams, Throwable cause)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/SimpleTemplateActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/SimpleTemplateActionDefinition.java
index daa3bf8f88..52082d06d6 100644
--- a/source/java/org/alfresco/repo/action/scheduled/SimpleTemplateActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/SimpleTemplateActionDefinition.java
@@ -93,7 +93,7 @@ public class SimpleTemplateActionDefinition extends AbstractTemplateActionDefini
/**
* Set the template model factory IOC.
*
- * @param templateActionModelFactory
+ * @param templateActionModelFactory TemplateActionModelFactory
*/
public void setTemplateActionModelFactory(TemplateActionModelFactory templateActionModelFactory)
{
@@ -113,7 +113,7 @@ public class SimpleTemplateActionDefinition extends AbstractTemplateActionDefini
/**
* Set the dictionary service - IOC.
*
- * @param dictionaryService
+ * @param dictionaryService DictionaryService
*/
public void setDictionaryService(DictionaryService dictionaryService)
{
@@ -123,7 +123,7 @@ public class SimpleTemplateActionDefinition extends AbstractTemplateActionDefini
/**
* Set the name of the action.
*
- * @param actionName
+ * @param actionName String
*/
public void setActionName(String actionName)
{
@@ -144,7 +144,7 @@ public class SimpleTemplateActionDefinition extends AbstractTemplateActionDefini
* Set the map of parameters used by the template.
* These are processed via the template service to produce the actual poarameters.
*
- * @param parameterTemplates
+ * @param parameterTemplates Map
*/
public void setParameterTemplates(Map parameterTemplates)
{
diff --git a/source/java/org/alfresco/repo/action/scheduled/TemplateActionDefinition.java b/source/java/org/alfresco/repo/action/scheduled/TemplateActionDefinition.java
index 640dfd1e18..5bd6d50f88 100644
--- a/source/java/org/alfresco/repo/action/scheduled/TemplateActionDefinition.java
+++ b/source/java/org/alfresco/repo/action/scheduled/TemplateActionDefinition.java
@@ -32,7 +32,7 @@ public interface TemplateActionDefinition
/**
* Generate an action definition for the action defined by this template.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return - the action.
*/
public Action getAction(NodeRef nodeRef);
diff --git a/source/java/org/alfresco/repo/action/scheduled/TemplateActionModelFactory.java b/source/java/org/alfresco/repo/action/scheduled/TemplateActionModelFactory.java
index f6cddfbd6b..0106166e98 100644
--- a/source/java/org/alfresco/repo/action/scheduled/TemplateActionModelFactory.java
+++ b/source/java/org/alfresco/repo/action/scheduled/TemplateActionModelFactory.java
@@ -47,7 +47,7 @@ public interface TemplateActionModelFactory
/**
* Build a model with a default node context.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return - the model (with nodeRef as its context).
*/
public Map getModel(NodeRef nodeRef);
diff --git a/source/java/org/alfresco/repo/activities/ActivityServiceImpl.java b/source/java/org/alfresco/repo/activities/ActivityServiceImpl.java
index ace6cd6af4..65835cd407 100644
--- a/source/java/org/alfresco/repo/activities/ActivityServiceImpl.java
+++ b/source/java/org/alfresco/repo/activities/ActivityServiceImpl.java
@@ -304,9 +304,9 @@ public class ActivityServiceImpl implements ActivityService, InitializingBean
* the user is taken from the activity summary rather than from the poster (e.g. when a user role is changed).
* A cache should be passed in from which to retrieve previously fetched {@link NodeRef}s for efficiency.
*
- * @param activityFeed
- * @param userIdToAvatarNodeRefCache
- * @return
+ * @param activityFeed ActivityFeedEntity
+ * @param userIdToAvatarNodeRefCache Map
+ * @return NodeRef
*/
protected NodeRef getUserAvatarNodeRef(ActivityFeedEntity activityFeed, Map userIdToAvatarNodeRefCache)
{
diff --git a/source/java/org/alfresco/repo/admin/IndexConfigurationCheckerImpl.java b/source/java/org/alfresco/repo/admin/IndexConfigurationCheckerImpl.java
index 5eeb18c40b..d397594ae1 100644
--- a/source/java/org/alfresco/repo/admin/IndexConfigurationCheckerImpl.java
+++ b/source/java/org/alfresco/repo/admin/IndexConfigurationCheckerImpl.java
@@ -52,7 +52,7 @@ public class IndexConfigurationCheckerImpl implements IndexConfigurationChecker
/**
* Set the index recovert mode
- * @param indexRecoveryMode
+ * @param indexRecoveryMode RecoveryMode
*/
public void setIndexRecoveryMode(RecoveryMode indexRecoveryMode)
{
@@ -63,7 +63,7 @@ public class IndexConfigurationCheckerImpl implements IndexConfigurationChecker
/**
* Set the node service
- * @param nodeService
+ * @param nodeService NodeService
*/
public void setNodeService(NodeService nodeService)
{
@@ -73,7 +73,7 @@ public class IndexConfigurationCheckerImpl implements IndexConfigurationChecker
/**
* Set the search service
- * @param searchService
+ * @param searchService SearchService
*/
public void setSearchService(SearchService searchService)
{
diff --git a/source/java/org/alfresco/repo/admin/patch/AbstractPatch.java b/source/java/org/alfresco/repo/admin/patch/AbstractPatch.java
index 337c08e809..a3a1aa1093 100644
--- a/source/java/org/alfresco/repo/admin/patch/AbstractPatch.java
+++ b/source/java/org/alfresco/repo/admin/patch/AbstractPatch.java
@@ -681,8 +681,8 @@ public abstract class AbstractPatch implements Patch, ApplicationEventPublisher
/**
* Support to report patch completion and estimated completion time.
*
- * @param estimatedTotal
- * @param currentInteration
+ * @param estimatedTotal long
+ * @param currentInteration long
*/
protected void reportProgress(long estimatedTotal, long currentInteration)
{
@@ -735,16 +735,13 @@ public abstract class AbstractPatch implements Patch, ApplicationEventPublisher
/**
* Should the patch be deferred? And not run at bootstrap.
- * @param deferred
+ * @param deferred boolean
*/
public void setDeferred(boolean deferred)
{
this.deferred = deferred;
}
- /**
- * {@inheritDoc}
- */
public boolean isDeferred()
{
return this.deferred;
diff --git a/source/java/org/alfresco/repo/admin/patch/OptionalPatchApplicationCheckBootstrapBean.java b/source/java/org/alfresco/repo/admin/patch/OptionalPatchApplicationCheckBootstrapBean.java
index e88f3d5e17..a54a35d05e 100644
--- a/source/java/org/alfresco/repo/admin/patch/OptionalPatchApplicationCheckBootstrapBean.java
+++ b/source/java/org/alfresco/repo/admin/patch/OptionalPatchApplicationCheckBootstrapBean.java
@@ -104,7 +104,7 @@ public class OptionalPatchApplicationCheckBootstrapBean extends AbstractLifecycl
/**
* Was the patch applied - or was it not applied
*
- * @return
+ * @return boolean
*/
public boolean getPatchApplied()
{
diff --git a/source/java/org/alfresco/repo/admin/patch/Patch.java b/source/java/org/alfresco/repo/admin/patch/Patch.java
index 5c62b49035..20df5f5a4a 100644
--- a/source/java/org/alfresco/repo/admin/patch/Patch.java
+++ b/source/java/org/alfresco/repo/admin/patch/Patch.java
@@ -111,7 +111,7 @@ public interface Patch
/**
* Is this patch just ignored - never considered for application
- * @return
+ * @return boolean
*/
public boolean isIgnored();
diff --git a/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java b/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java
index 6046650762..c5f41deb34 100644
--- a/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java
+++ b/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java
@@ -257,13 +257,11 @@ public class PatchServiceImpl implements PatchService
}
/**
- * Reentrant method that ensures that a patch and all its dependencies get applied.
- * The process terminates on the first failure.
- *
- * @param patch all the executed patch data. If there was a failure, then this
- * is the list of successful executions only.
- * @param patch the patch (containing dependencies) to apply
- * @param appliedPatchesById already applied patches keyed by their ID
+ * Reentrant method that ensures that a patch and all its dependencies get applied.
+ * The process terminates on the first failure.
+ *
+ * @param patch the patch (containing dependencies) to apply
+ * @param appliedPatchesById already applied patches keyed by their ID
* @return Returns true if the patch and all its dependencies were successfully applied.
*/
private boolean applyPatchAndDependencies(final Patch patch, Map appliedPatchesById)
@@ -471,8 +469,6 @@ public class PatchServiceImpl implements PatchService
/**
* Perform some setup before applying the patch e.g. check whether the patch needs to be applied.
- *
- * @return true: continue, false: do not apply patch
*/
private void setup()
{
diff --git a/source/java/org/alfresco/repo/admin/patch/impl/GenericEMailTemplateUpdatePatch.java b/source/java/org/alfresco/repo/admin/patch/impl/GenericEMailTemplateUpdatePatch.java
index df1e593137..a74eb57991 100644
--- a/source/java/org/alfresco/repo/admin/patch/impl/GenericEMailTemplateUpdatePatch.java
+++ b/source/java/org/alfresco/repo/admin/patch/impl/GenericEMailTemplateUpdatePatch.java
@@ -66,7 +66,7 @@ public abstract class GenericEMailTemplateUpdatePatch extends AbstractPatch
}
/**
- * @param createSiblingIfMissing
+ * @param createSiblingIfMissing boolean
*/
public void setCreateSiblingIfMissing(boolean createSiblingIfMissing)
{
@@ -74,7 +74,7 @@ public abstract class GenericEMailTemplateUpdatePatch extends AbstractPatch
}
/**
- * @param updateBaseFile
+ * @param updateBaseFile boolean
*/
public void setUpdateBaseFile(boolean updateBaseFile)
{
diff --git a/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java b/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java
index d48a198cf1..154996b7e5 100644
--- a/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java
+++ b/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java
@@ -61,7 +61,7 @@ public class GenericWorkflowPatch extends AbstractPatch implements ApplicationCo
/**
* Sets the Workflow Definitions
*
- * @param workflowDefinitions
+ * @param workflowDefinitions List
*/
public void setWorkflowDefinitions(List workflowDefinitions)
{
diff --git a/source/java/org/alfresco/repo/audit/AuditComponent.java b/source/java/org/alfresco/repo/audit/AuditComponent.java
index cd7152b6df..37c8d1ecd7 100644
--- a/source/java/org/alfresco/repo/audit/AuditComponent.java
+++ b/source/java/org/alfresco/repo/audit/AuditComponent.java
@@ -54,7 +54,7 @@ public interface AuditComponent
public void setAuditEnabled(boolean enable);
/**
- * @param userAuditFilter
+ * @param userAuditFilter UserAuditFilter
*
* @since 4.2
*/
@@ -134,7 +134,7 @@ public interface AuditComponent
/**
* Enable auditing (if it is not already enabled) for all paths that contain the given path.
- * The path is the path as originally logged (see {@link #audit(String, String, Map)}) and
+ * The path is the path as originally logged and
* not the path that the generated data may contain - although this would be similarly
* enabled.
*
@@ -150,7 +150,7 @@ public interface AuditComponent
/**
* Disable auditing (if it is not already disabled) for all paths that contain the given path.
- * The path is the path as originally logged (see {@link #audit(String, String, Map)}) and
+ * The path is the path as originally logged and
* not the path that the generated data may contain - although this would be similarly
* disabled.
*
diff --git a/source/java/org/alfresco/repo/audit/AuditComponentImpl.java b/source/java/org/alfresco/repo/audit/AuditComponentImpl.java
index c087784ec8..ccc9c82fdb 100644
--- a/source/java/org/alfresco/repo/audit/AuditComponentImpl.java
+++ b/source/java/org/alfresco/repo/audit/AuditComponentImpl.java
@@ -695,7 +695,6 @@ public class AuditComponentImpl implements AuditComponent
}
/**
- * {@inheritDoc}
* @since 3.2
*/
public Map recordAuditValuesImpl(Map mappedValues)
diff --git a/source/java/org/alfresco/repo/audit/AuditException.java b/source/java/org/alfresco/repo/audit/AuditException.java
index b7deb513c6..f73487c173 100644
--- a/source/java/org/alfresco/repo/audit/AuditException.java
+++ b/source/java/org/alfresco/repo/audit/AuditException.java
@@ -36,7 +36,7 @@ public class AuditException extends AlfrescoRuntimeException
/**
* Simple message
*
- * @param msgId
+ * @param msgId String
*/
public AuditException(String msgId)
{
@@ -46,8 +46,8 @@ public class AuditException extends AlfrescoRuntimeException
/**
* I18n message
*
- * @param msgId
- * @param msgParams
+ * @param msgId String
+ * @param msgParams Object[]
*/
public AuditException(String msgId, Object[] msgParams)
{
@@ -57,8 +57,8 @@ public class AuditException extends AlfrescoRuntimeException
/**
* Simple message ad nested exception
*
- * @param msgId
- * @param cause
+ * @param msgId String
+ * @param cause Throwable
*/
public AuditException(String msgId, Throwable cause)
{
@@ -68,9 +68,9 @@ public class AuditException extends AlfrescoRuntimeException
/**
* I18n message and exception.
*
- * @param msgId
- * @param msgParams
- * @param cause
+ * @param msgId String
+ * @param msgParams Object[]
+ * @param cause Throwable
*/
public AuditException(String msgId, Object[] msgParams, Throwable cause)
{
diff --git a/source/java/org/alfresco/repo/audit/PropertyAuditFilter.java b/source/java/org/alfresco/repo/audit/PropertyAuditFilter.java
index b4a90f14f1..51c79a54b1 100644
--- a/source/java/org/alfresco/repo/audit/PropertyAuditFilter.java
+++ b/source/java/org/alfresco/repo/audit/PropertyAuditFilter.java
@@ -86,7 +86,7 @@ import org.apache.commons.logging.LogFactory;
* too may be escaped with a {@code '\'}.
*
* A property value may be a reference to another property, which saves having
- * multiple copies. This is indicated by a {@code '$' as the first character of the
+ * multiple copies. This is indicated by a {@code '$'} as the first character of the
* property value. If the first character of an expression needs to be a
* {@code '$'} it too may be escaped with a {@code '\'}. For example:
*
@@ -135,10 +135,9 @@ public class PropertyAuditFilter implements AuditFilter
}
/**
- * @inheritDoc
- * @param @inheritDoc
- * @param @inheritDoc
- * @return @inheritDoc
+ * @param rootPath String
+ * @param auditMap Map
+ * @return boolean
*/
@Override
public boolean accept(String rootPath, Map auditMap)
diff --git a/source/java/org/alfresco/repo/audit/generator/AbstractDataGenerator.java b/source/java/org/alfresco/repo/audit/generator/AbstractDataGenerator.java
index 49a9490649..d268d516e2 100644
--- a/source/java/org/alfresco/repo/audit/generator/AbstractDataGenerator.java
+++ b/source/java/org/alfresco/repo/audit/generator/AbstractDataGenerator.java
@@ -52,7 +52,7 @@ public abstract class AbstractDataGenerator implements DataGenerator, Initializi
/**
* Set the registry with which to register
- * @param registry
+ * @param registry NamedObjectRegistry
*/
public void setRegistry(NamedObjectRegistry registry)
{
diff --git a/source/java/org/alfresco/repo/blog/BlogIntegrationImplementation.java b/source/java/org/alfresco/repo/blog/BlogIntegrationImplementation.java
index 05f023d59e..bb8922946b 100644
--- a/source/java/org/alfresco/repo/blog/BlogIntegrationImplementation.java
+++ b/source/java/org/alfresco/repo/blog/BlogIntegrationImplementation.java
@@ -55,30 +55,30 @@ public interface BlogIntegrationImplementation
/**
* Update an exisiting blog post
*
- * @param blogDetails
- * @param postId
- * @param title
- * @param body
- * @param publish
- * @return
+ * @param blogDetails BlogDetails
+ * @param postId String
+ * @param title String
+ * @param body String
+ * @param publish boolean
+ * @return boolean
*/
boolean updatePost(BlogDetails blogDetails, String postId, String title, String body, boolean publish);
/**
* Get the details of an existing blog post
*
- * @param blogDetails
- * @param postId
- * @return
+ * @param blogDetails BlogDetails
+ * @param postId String
+ * @return Map
*/
Map getPost(BlogDetails blogDetails, String postId);
/**
* Delete an existing blog post
*
- * @param blogDetails
- * @param postId
- * @return
+ * @param blogDetails BlogDetails
+ * @param postId String
+ * @return boolean
*/
boolean deletePost(BlogDetails blogDetails, String postId);
}
diff --git a/source/java/org/alfresco/repo/blog/BlogIntegrationRuntimeException.java b/source/java/org/alfresco/repo/blog/BlogIntegrationRuntimeException.java
index c1e048d4ed..3dc75c12b4 100644
--- a/source/java/org/alfresco/repo/blog/BlogIntegrationRuntimeException.java
+++ b/source/java/org/alfresco/repo/blog/BlogIntegrationRuntimeException.java
@@ -32,7 +32,7 @@ public class BlogIntegrationRuntimeException extends AlfrescoRuntimeException
/**
* Constructor
*
- * @param msgId
+ * @param msgId String
*/
public BlogIntegrationRuntimeException(String msgId)
{
@@ -42,8 +42,8 @@ public class BlogIntegrationRuntimeException extends AlfrescoRuntimeException
/**
* Constructor
*
- * @param msgId
- * @param msgParams
+ * @param msgId String
+ * @param msgParams Object[]
*/
public BlogIntegrationRuntimeException(String msgId, Object[] msgParams)
{
@@ -53,8 +53,8 @@ public class BlogIntegrationRuntimeException extends AlfrescoRuntimeException
/**
* Constructor
*
- * @param msgId
- * @param cause
+ * @param msgId String
+ * @param cause Throwable
*/
public BlogIntegrationRuntimeException(String msgId, Throwable cause)
{
@@ -64,9 +64,9 @@ public class BlogIntegrationRuntimeException extends AlfrescoRuntimeException
/**
* Constructor
*
- * @param msgId
- * @param msgParams
- * @param cause
+ * @param msgId String
+ * @param msgParams Object[]
+ * @param cause Throwable
*/
public BlogIntegrationRuntimeException(String msgId, Object[] msgParams, Throwable cause)
{
diff --git a/source/java/org/alfresco/repo/blog/BlogIntegrationService.java b/source/java/org/alfresco/repo/blog/BlogIntegrationService.java
index 7063ddf8c3..55614ddddd 100644
--- a/source/java/org/alfresco/repo/blog/BlogIntegrationService.java
+++ b/source/java/org/alfresco/repo/blog/BlogIntegrationService.java
@@ -67,24 +67,24 @@ public interface BlogIntegrationService
/**
* Posts the content of a node to the blog specified
*
- * @param blogDetails
- * @param nodeRef
- * @param contentProperty
- * @param publish
+ * @param blogDetails BlogDetails
+ * @param nodeRef NodeRef
+ * @param contentProperty QName
+ * @param publish boolean
*/
void newPost(BlogDetails blogDetails, NodeRef nodeRef, QName contentProperty, boolean publish);
/**
*
- * @param nodeRef
- * @param contentProperty
- * @param publish
+ * @param nodeRef NodeRef
+ * @param contentProperty QName
+ * @param publish boolean
*/
void updatePost(NodeRef nodeRef, QName contentProperty, boolean publish);
/**
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
void deletePost(NodeRef nodeRef);
}
diff --git a/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java b/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java
index 363a546c1a..c5fcb5aa4f 100644
--- a/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java
+++ b/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java
@@ -157,7 +157,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI
}
/**
- * @see org.alfresco.repo.blog.BlogIntegrationService#newPost(org.alfresco.module.blogIntegration.BlogDetails, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, boolean)
+ * @see org.alfresco.repo.blog.BlogIntegrationService#newPost(BlogDetails, NodeRef, QName, boolean)
*/
public void newPost(BlogDetails blogDetails, NodeRef nodeRef, QName contentProperty, boolean publish)
{
diff --git a/source/java/org/alfresco/repo/blog/BlogPostInfoImpl.java b/source/java/org/alfresco/repo/blog/BlogPostInfoImpl.java
index e458e429d4..512f81c4b1 100644
--- a/source/java/org/alfresco/repo/blog/BlogPostInfoImpl.java
+++ b/source/java/org/alfresco/repo/blog/BlogPostInfoImpl.java
@@ -59,7 +59,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
/**
* Gets the {@link ContentModel#PROP_NAME cm:name} of the blog post.
- * @return
+ * @return String
*/
@Override
public String getSystemName()
diff --git a/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java b/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java
index 5f94f407f3..348caa70ef 100644
--- a/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java
+++ b/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java
@@ -146,8 +146,8 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg
/**
* Helper method to get the XML RPC client
*
- * @param url
- * @return
+ * @param url String
+ * @return XmlRpcClient
*/
private XmlRpcClient getClient(String url)
{
@@ -172,10 +172,10 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg
/**
* Executes an XML RPC method
*
- * @param url
- * @param method
- * @param params
- * @return
+ * @param url String
+ * @param method String
+ * @param params List
*
- * @param dialectClass
- * @param resourceUrl
- * @return
+ * @param dialectClass Class
+ * @param resourceUrl String
+ * @return String
*/
private String resolveDialectUrl(Class dialectClass, String resourceUrl)
{
diff --git a/source/java/org/alfresco/repo/domain/usage/UsageDAO.java b/source/java/org/alfresco/repo/domain/usage/UsageDAO.java
index ce390f6a69..aa9f6ddd45 100644
--- a/source/java/org/alfresco/repo/domain/usage/UsageDAO.java
+++ b/source/java/org/alfresco/repo/domain/usage/UsageDAO.java
@@ -56,16 +56,16 @@ public interface UsageDAO
/**
* Delete usage deltas for given nodeRef
*
- * @param nodeRef
- * @return
+ * @param nodeRef NodeRef
+ * @return int
*/
public int deleteDeltas(NodeRef nodeRef);
/**
* Delete usage deltas for given node entity id
*
- * @param nodeId
- * @return
+ * @param nodeId long
+ * @return int
*/
public int deleteDeltas(long nodeId);
@@ -74,7 +74,6 @@ public interface UsageDAO
*
* @param storeRef the store to search in
* @param resultsCallback the callback to use while iterating over the content sizes (one row per user)
- * @return Returns the values for the given owner, creator and content size (summed)
*/
public void getUserContentSizesForStore(
StoreRef storeRef,
@@ -85,7 +84,6 @@ public interface UsageDAO
*
* @param storeRef the store to search in
* @param resultsCallback the callback to use while iterating over the people
- * @return Returns the values for username and person node uuid (excluding System)
*/
public void getUsersWithoutUsage(
StoreRef storeRef,
@@ -96,7 +94,6 @@ public interface UsageDAO
*
* @param storeRef the store to search in
* @param resultsCallback the callback to use while iterating over the people
- * @return Returns the values for the username and person node uuid (excluding System)
*/
public void getUsersWithUsage(
StoreRef storeRef,
diff --git a/source/java/org/alfresco/repo/download/ActionServiceHelper.java b/source/java/org/alfresco/repo/download/ActionServiceHelper.java
index 42e896845c..fd8a169281 100644
--- a/source/java/org/alfresco/repo/download/ActionServiceHelper.java
+++ b/source/java/org/alfresco/repo/download/ActionServiceHelper.java
@@ -34,7 +34,7 @@ public interface ActionServiceHelper
/**
* Implementations should trigger the CreateDownloadArchiveAction on the provided downloadNode
*
- * @param downloadNode
+ * @param downloadNode NodeRef
*/
void executeAction(NodeRef downloadNode);
diff --git a/source/java/org/alfresco/repo/download/ContentServiceHelper.java b/source/java/org/alfresco/repo/download/ContentServiceHelper.java
index 237bfce4d9..0f5bef2852 100644
--- a/source/java/org/alfresco/repo/download/ContentServiceHelper.java
+++ b/source/java/org/alfresco/repo/download/ContentServiceHelper.java
@@ -38,8 +38,8 @@ public interface ContentServiceHelper
/**
* Implementations should update the content of downlaodNode with contents of archiveFile.
*
- * @param downloadNode
- * @param archiveFile
+ * @param downloadNode NodeRef
+ * @param archiveFile File
* @throws ContentIOException
* @throws FileNotFoundException
* @throws IOException
diff --git a/source/java/org/alfresco/repo/download/CreateDownloadArchiveAction.java b/source/java/org/alfresco/repo/download/CreateDownloadArchiveAction.java
index e8d7b8e968..779c0819e9 100644
--- a/source/java/org/alfresco/repo/download/CreateDownloadArchiveAction.java
+++ b/source/java/org/alfresco/repo/download/CreateDownloadArchiveAction.java
@@ -83,8 +83,8 @@ public class CreateDownloadArchiveAction extends ActionExecuterAbstractBase
private static class SizeEstimator extends BaseExporter
{
/**
- * @param checkOutCheckInService
- * @param nodeService
+ * @param checkOutCheckInService CheckOutCheckInService
+ * @param nodeService NodeService
*/
SizeEstimator(CheckOutCheckInService checkOutCheckInService, NodeService nodeService)
{
diff --git a/source/java/org/alfresco/repo/download/DownloadStatusUpdateService.java b/source/java/org/alfresco/repo/download/DownloadStatusUpdateService.java
index 4a775cfb71..b595f4b0c6 100644
--- a/source/java/org/alfresco/repo/download/DownloadStatusUpdateService.java
+++ b/source/java/org/alfresco/repo/download/DownloadStatusUpdateService.java
@@ -37,7 +37,7 @@ public interface DownloadStatusUpdateService
*
* @param nodeRef The download node, whose status is to be updated.
* @param status The new status
- * @param sequenceNumber
+ * @param sequenceNumber int
*/
void update(NodeRef nodeRef, DownloadStatus status, int sequenceNumber);
}
diff --git a/source/java/org/alfresco/repo/download/DownloadStorage.java b/source/java/org/alfresco/repo/download/DownloadStorage.java
index 20f3fa28d8..075d3fa830 100644
--- a/source/java/org/alfresco/repo/download/DownloadStorage.java
+++ b/source/java/org/alfresco/repo/download/DownloadStorage.java
@@ -36,7 +36,7 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
- * This class is responsible for the persistence of {@link DownloadDefinition} objects using lower-level
+ * This class is responsible for the persistence of objects using lower-level
* repo services such as the {@link NodeService}. The higher-level business logic around these CRUD calls
* is contained within the {@link DownloadServiceImpl}.
*
@@ -250,7 +250,7 @@ public class DownloadStorage
/**
* Delete the download node identified by nodeRef
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
public void delete(NodeRef nodeRef)
{
diff --git a/source/java/org/alfresco/repo/download/ZipDownloadExporter.java b/source/java/org/alfresco/repo/download/ZipDownloadExporter.java
index c32bc815c7..efe48e70c6 100644
--- a/source/java/org/alfresco/repo/download/ZipDownloadExporter.java
+++ b/source/java/org/alfresco/repo/download/ZipDownloadExporter.java
@@ -79,15 +79,16 @@ public class ZipDownloadExporter extends BaseExporter
/**
* Construct
- *
- * @param zipFile
- * @param checkOutCheckInService
- * @param transactionHelper
- * @param updateService
- * @param downloadStorage
- * @param downloadNodeRef
- * @param total
- * @param totalFileCount
+ *
+ * @param zipFile File
+ * @param checkOutCheckInService CheckOutCheckInService
+ * @param nodeService NodeService
+ * @param transactionHelper RetryingTransactionHelper
+ * @param updateService DownloadStatusUpdateService
+ * @param downloadStorage DownloadStorage
+ * @param downloadNodeRef NodeRef
+ * @param total long
+ * @param totalFileCount long
*/
public ZipDownloadExporter(File zipFile, CheckOutCheckInService checkOutCheckInService, NodeService nodeService, RetryingTransactionHelper transactionHelper, DownloadStatusUpdateService updateService, DownloadStorage downloadStorage, NodeRef downloadNodeRef, long total, long totalFileCount)
{
diff --git a/source/java/org/alfresco/repo/exporter/ACPExportPackageHandler.java b/source/java/org/alfresco/repo/exporter/ACPExportPackageHandler.java
index e4f6efd1fe..f857ff9b96 100644
--- a/source/java/org/alfresco/repo/exporter/ACPExportPackageHandler.java
+++ b/source/java/org/alfresco/repo/exporter/ACPExportPackageHandler.java
@@ -70,10 +70,12 @@ public class ACPExportPackageHandler
/**
* Construct
*
- * @param destDir
- * @param zipFile
- * @param dataFile
- * @param contentDir
+ * @param destDir File
+ * @param zipFile File
+ * @param dataFile File
+ * @param contentDir File
+ * @param overwrite boolean
+ * @param mimetypeService MimetypeService
*/
public ACPExportPackageHandler(File destDir, File zipFile, File dataFile, File contentDir, boolean overwrite, MimetypeService mimetypeService)
{
@@ -112,9 +114,10 @@ public class ACPExportPackageHandler
/**
* Construct
*
- * @param outputStream
- * @param dataFile
- * @param contentDir
+ * @param outputStream OutputStream
+ * @param dataFile File
+ * @param contentDir File
+ * @param mimetypeService MimetypeService
*/
public ACPExportPackageHandler(OutputStream outputStream, File dataFile, File contentDir, MimetypeService mimetypeService)
{
@@ -125,7 +128,7 @@ public class ACPExportPackageHandler
}
/**
- * @param nodeService
+ * @param nodeService NodeService
*/
public void setNodeService(NodeService nodeService)
{
@@ -135,7 +138,7 @@ public class ACPExportPackageHandler
/**
* Export content into folder structure of nodes
*
- * @param exportAsFolders
+ * @param exportAsFolders boolean
*/
public void setExportAsFolders(boolean exportAsFolders)
{
@@ -310,7 +313,7 @@ public class ACPExportPackageHandler
}
/**
- * @param path
+ * @param path Path
* @return display path
*/
private String toDisplayPath(Path path)
diff --git a/source/java/org/alfresco/repo/exporter/ExporterComponent.java b/source/java/org/alfresco/repo/exporter/ExporterComponent.java
index 94aa50f4c7..a11b4b9a1e 100644
--- a/source/java/org/alfresco/repo/exporter/ExporterComponent.java
+++ b/source/java/org/alfresco/repo/exporter/ExporterComponent.java
@@ -589,12 +589,12 @@ public class ExporterComponent
/**
* Export Property
*
- * @param nodeRef
- * @param property
- * @param value
- * @param index
- * @param parameters
- * @param exporter
+ * @param nodeRef NodeRef
+ * @param property QName
+ * @param value Object
+ * @param index int
+ * @param parameters ExporterCrawlerParameters
+ * @param exporter Exporter
*/
private void walkProperty(NodeRef nodeRef, QName property, Object value, int index, ExporterCrawlerParameters parameters, Exporter exporter)
{
@@ -673,9 +673,9 @@ public class ExporterComponent
/**
* Export Secondary Links
*
- * @param nodeRef
- * @param parameters
- * @param exporter
+ * @param nodeRef NodeRef
+ * @param parameters ExporterCrawlerParameters
+ * @param exporter Exporter
*/
private void walkNodeSecondaryLinks(NodeRef nodeRef, ExporterCrawlerParameters parameters, Exporter exporter)
{
@@ -743,9 +743,9 @@ public class ExporterComponent
/**
* Export Node Associations
*
- * @param nodeRef
- * @param parameters
- * @param exporter
+ * @param nodeRef NodeRef
+ * @param parameters ExporterCrawlerParameters
+ * @param exporter Exporter
*/
private void walkNodeAssociations(NodeRef nodeRef, ExporterCrawlerParameters parameters, Exporter exporter)
{
@@ -1101,7 +1101,7 @@ public class ExporterComponent
/**
* Record that associations exist for node
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
public void recordAssociation(NodeRef nodeRef)
{
@@ -1117,7 +1117,7 @@ public class ExporterComponent
/**
* Gets nodes that have been recorded with associations
*
- * @return
+ * @return Set
*/
public Set getNodesWithAssociations()
{
@@ -1132,7 +1132,7 @@ public class ExporterComponent
/**
* Record that secondary links exist for node
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
public void recordSecondaryLink(NodeRef nodeRef)
{
@@ -1203,9 +1203,9 @@ public class ExporterComponent
/**
* Gets the parent node of the items to be exported
*
- * @param exportOf
- * @param exportSelf
- * @return
+ * @param exportOf NodeRef
+ * @param exportSelf boolean
+ * @return NodeRef
*/
private NodeRef getParent(NodeRef exportOf, boolean exportSelf)
{
diff --git a/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java b/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java
index 0b932ec83b..966c289bde 100644
--- a/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java
+++ b/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java
@@ -913,9 +913,9 @@ import org.xml.sax.helpers.AttributesImpl;
/**
* Helper to convert a path into an indexed path which uniquely identifies a node
*
- * @param nodeRef
- * @param path
- * @return
+ * @param nodeRef NodeRef
+ * @param path Path
+ * @return Path
*/
private Path createIndexedPath(NodeRef nodeRef, Path path)
{
diff --git a/source/java/org/alfresco/repo/forms/Form.java b/source/java/org/alfresco/repo/forms/Form.java
index e2d90372b0..6b18b1a523 100644
--- a/source/java/org/alfresco/repo/forms/Form.java
+++ b/source/java/org/alfresco/repo/forms/Form.java
@@ -176,7 +176,7 @@ public class Form
* specified dataKey.
*
* @param dataKey The dataKey for the field.
- * @return
+ * @return boolean
*/
public boolean dataExists(String dataKey)
{
@@ -205,7 +205,7 @@ public class Form
* Adds a {@link Field} to the form by adding the {@link FieldDefinition}
* and the value if any.
*
- * @param field
+ * @param field Field
*/
public void addField(Field field)
{
diff --git a/source/java/org/alfresco/repo/forms/FormData.java b/source/java/org/alfresco/repo/forms/FormData.java
index 1c04857292..ac9cdb1df1 100644
--- a/source/java/org/alfresco/repo/forms/FormData.java
+++ b/source/java/org/alfresco/repo/forms/FormData.java
@@ -105,7 +105,7 @@ public class FormData implements Iterable
*
* @param fieldName The name of the field
* @param fieldValue The value of the data
- * @param overwrite
+ * @param overwrite boolean
*/
@SuppressWarnings("unchecked")
public void addFieldData(String fieldName, Object fieldValue, boolean overwrite)
diff --git a/source/java/org/alfresco/repo/forms/processor/AbstractFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/AbstractFormProcessor.java
index 1e4314673f..2e1d08b7c7 100644
--- a/source/java/org/alfresco/repo/forms/processor/AbstractFormProcessor.java
+++ b/source/java/org/alfresco/repo/forms/processor/AbstractFormProcessor.java
@@ -155,8 +155,8 @@ public abstract class AbstractFormProcessor implements FormProcessor
* Gets the Item from the form parameter and sets its type
* field to type.
*
- * @param form
- * @param type
+ * @param form Form
+ * @param type String
*/
protected void setFormItemType(Form form, String type)
{
@@ -167,8 +167,8 @@ public abstract class AbstractFormProcessor implements FormProcessor
* Gets the Item from the form parameter and sets its URL field
* to url.
*
- * @param form
- * @param url
+ * @param form Form
+ * @param url String
*/
protected void setFormItemUrl(Form form, String url)
{
diff --git a/source/java/org/alfresco/repo/forms/processor/FieldProcessorRegistry.java b/source/java/org/alfresco/repo/forms/processor/FieldProcessorRegistry.java
index 435398e8a1..8fca3a39bf 100644
--- a/source/java/org/alfresco/repo/forms/processor/FieldProcessorRegistry.java
+++ b/source/java/org/alfresco/repo/forms/processor/FieldProcessorRegistry.java
@@ -42,8 +42,8 @@ public class FieldProcessorRegistry
/**
* Registers a {@link FieldProcessor} with this registry using the specified key.
- * @param key
- * @param processor
+ * @param key String
+ * @param processor FieldProcessor
*/
public void register(String key, FieldProcessor processor)
{
@@ -52,8 +52,8 @@ public class FieldProcessorRegistry
/**
* Returns the {@link FieldProcessor} that was registered witht he specified key.
- * @param key
- * @return
+ * @param key String
+ * @return FieldProcessor
*/
public FieldProcessor get(String key)
{
@@ -80,7 +80,7 @@ public class FieldProcessorRegistry
/**
* Returns a FieldProcessor for the given field name.
*
- * @param fieldName
+ * @param fieldName String
* @return The FieldProcessor implementation for the field or null if there isn't one regsitered.
*/
protected FieldProcessor getFieldProcessor(String fieldName)
@@ -95,7 +95,7 @@ public class FieldProcessorRegistry
/**
* Determines if the defaultProcessor should be used.
- * @param fieldName
+ * @param fieldName String
* @return true if the defaultProcessor should be used, otherwise false.
*/
protected boolean useDefaultProcessor(String fieldName)
@@ -105,7 +105,7 @@ public class FieldProcessorRegistry
/**
* Derives the key used to look up the {@link FieldProcessor} from the fieldName.
- * @param fieldName
+ * @param fieldName String
* @return the key used to look up the {@link FieldProcessor}.
*/
protected String getKey(String fieldName)
diff --git a/source/java/org/alfresco/repo/forms/processor/Filter.java b/source/java/org/alfresco/repo/forms/processor/Filter.java
index 0ae2ec9ce6..292d07788a 100644
--- a/source/java/org/alfresco/repo/forms/processor/Filter.java
+++ b/source/java/org/alfresco/repo/forms/processor/Filter.java
@@ -52,7 +52,7 @@ public interface Filter
* @param fields Restricted list of fields to include
* @param forcedFields List of fields to forcibly include
* @param form The Form object
- * @param @param context Map representing optional context that
+ * @param context Map representing optional context that
* can be used during retrieval of the form
*/
public void beforeGenerate(ItemType item, List fields, List forcedFields,
diff --git a/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java
index c012766aa4..d4bc7a01c7 100644
--- a/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java
+++ b/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java
@@ -246,7 +246,7 @@ public abstract class FilteredFormProcessor extends Abstr
/**
* Creates a data object used by the {@link FormProcessor} and {@link FieldProcessor FieldProcessors} to create {@link Field Fields}
- * @return
+ * @return Object
*/
protected abstract Object makeItemData(ItemType item);
@@ -271,15 +271,15 @@ public abstract class FilteredFormProcessor extends Abstr
/**
* Returns a {@link String} describing the type fo the specified item.
- * @param item
- * @return
+ * @param item ItemType
+ * @return String
*/
protected abstract String getItemType(ItemType item);
/**
* Returns the URI location of the specified item.
- * @param item
- * @return
+ * @param item ItemType
+ * @return String
*/
protected abstract String getItemURI(ItemType item);
diff --git a/source/java/org/alfresco/repo/forms/processor/node/ContentModelFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/node/ContentModelFormProcessor.java
index 614caa1137..25a72903bb 100644
--- a/source/java/org/alfresco/repo/forms/processor/node/ContentModelFormProcessor.java
+++ b/source/java/org/alfresco/repo/forms/processor/node/ContentModelFormProcessor.java
@@ -828,7 +828,7 @@ abstract class AbstractAssocCommand
* This method should use the specified nodeService reference to effect the
* update to the supplied associations.
*
- * @param nodeService
+ * @param nodeService NodeService
*/
protected abstract void updateAssociations(NodeService nodeService);
}
diff --git a/source/java/org/alfresco/repo/forms/processor/workflow/AbstractWorkflowFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/workflow/AbstractWorkflowFormProcessor.java
index 8ccc0caecb..5da3275201 100644
--- a/source/java/org/alfresco/repo/forms/processor/workflow/AbstractWorkflowFormProcessor.java
+++ b/source/java/org/alfresco/repo/forms/processor/workflow/AbstractWorkflowFormProcessor.java
@@ -219,15 +219,15 @@ public abstract class AbstractWorkflowFormProcessor exten
* Returns an implementation of {@link ContentModelFormPersister} which is
* used to accumulate all the changes specified in the {@link Form} and then persist them.
*
- * @param item
- * @return
+ * @param item ItemType
+ * @return ContentModelFormPersister
*/
protected abstract ContentModelFormPersister makeFormPersister(ItemType item);
/**
* Returns the typed item.
* @param itemId the decoded item Id.
- * @return
+ * @return ItemType
*/
protected abstract ItemType getTypedItemForDecodedId(String itemId);
diff --git a/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java
index a39130aafe..44df9f2c5e 100644
--- a/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java
+++ b/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java
@@ -174,8 +174,8 @@ public class TaskFormProcessor extends AbstractWorkflowFormProcessor
- * Once registered the messages will be available via getMessage, assuming the
- * bundle resource exists at the given path location.
- *
- * @param bundleBasePath the bundle base path
- */
- public void registerResourceBundle(String bundleBasePath);
-
+ * Once registered the messages will be available via getMessage, assuming the
+ * bundle resource exists at the given path location.
+ *
+ * @param bundleBasePath the bundle base path
+ */
+ public void registerResourceBundle(String bundleBasePath);
+
/**
* Unregister a resource bundle
*
* This should be the bundle base path
* eg alfresco/messages/errors
* or workspace://SpaceStore/app:company_home/app:dictionary/app:labels/cm:errors
- *
- * Once unregistered the messages will no longer be available via getMessage
- *
- * @param resBundlePath the bundle base path
- */
- public void unregisterResourceBundle(String resBundlePath);
-
+ *
+ * Once unregistered the messages will no longer be available via getMessage
+ *
+ * @param resBundlePath the bundle base path
+ */
+ public void unregisterResourceBundle(String resBundlePath);
+
/**
* Get message resource bundle from the repository
*
@@ -135,7 +135,7 @@ public interface MessageService extends TenantDeployer, MessageLookup
/**
* Register message deployer with message service
*
- * @param messageDeployer
+ * @param messageDeployer MessageDeployer
*/
public void register(MessageDeployer messageDeployer);
diff --git a/source/java/org/alfresco/repo/imap/AbstractImapFolder.java b/source/java/org/alfresco/repo/imap/AbstractImapFolder.java
index beb603ec22..8b61ba0d95 100644
--- a/source/java/org/alfresco/repo/imap/AbstractImapFolder.java
+++ b/source/java/org/alfresco/repo/imap/AbstractImapFolder.java
@@ -60,14 +60,14 @@ public abstract class AbstractImapFolder implements MailFolder
{
this.serviceRegistry = serviceRegistry;
}
-
- /**
- * Method that checks mandatory parameter.
- * @param parameter The parameter instance to check.
- * @param name The name of the parameter.
- */
- protected void checkParameter(Object parameter, String name)
- {
+
+ /**
+ * Method that checks mandatory parameter.
+ * @param parameter The parameter instance to check.
+ * @param name The name of the parameter.
+ */
+ protected void checkParameter(Object parameter, String name)
+ {
if (parameter == null)
{
throw new IllegalArgumentException(name + " parameter is null.");
@@ -81,7 +81,7 @@ public abstract class AbstractImapFolder implements MailFolder
* @param message - message.
* @param flags - message flags.
* @param internalDate - not used. Current date used instead.
- * @return
+ * @return long
*/
public long appendMessage(final MimeMessage message, final Flags flags, final Date internalDate) throws FolderException
{
@@ -127,7 +127,7 @@ public abstract class AbstractImapFolder implements MailFolder
}
/**
- * Marks all messages in the folder as deleted using {@link Flags.Flag#DELETED} flag.
+ * Marks all messages in the folder as deleted using {@link javax.mail.Flags.Flag#DELETED} flag.
*/
public void deleteAllMessages() throws FolderException
{
@@ -145,7 +145,7 @@ public abstract class AbstractImapFolder implements MailFolder
/**
- * Deletes messages marked with {@link Flags.Flag#DELETED}. Note that this message deletes all messages with this flag.
+ * Deletes messages marked with {@link javax.mail.Flags.Flag#DELETED}. Note that this message deletes all messages with this flag.
*/
public void expunge() throws FolderException
{
@@ -165,7 +165,7 @@ public abstract class AbstractImapFolder implements MailFolder
}
/**
- * Deletes messages marked with {@link Flags.Flag#DELETED}. Note that this message deletes the messages with current uid
+ * Deletes messages marked with {@link javax.mail.Flags.Flag#DELETED}. Note that this message deletes the messages with current uid
*/
public void expunge(final long uid) throws FolderException
{
@@ -238,7 +238,7 @@ public abstract class AbstractImapFolder implements MailFolder
}
/**
- * Returns the list of messages that have no {@link Flags.Flag#DELETED} flag set for current user.
+ * Returns the list of messages that have no {@link javax.mail.Flags.Flag#DELETED} flag set for current user.
*
* @return the list of non-deleted messages.
*/
diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java b/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java
index 349cd2dbbc..3fa0ca3b9e 100644
--- a/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java
+++ b/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java
@@ -138,21 +138,21 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
- /**
- * Constructs {@link AlfrescoImapFolder} object.
- *
- * @param folderInfo - reference to the {@link FileInfo} object representing the folder.
- * @param userName - name of user (e.g. "admin" for admin user).
- * @param folderName - name of the folder.
- * @param folderPath - path of the folder.
- * @param viewMode - defines view mode. Can be one of the following: {@link ImapViewMode#ARCHIVE} or {@link ImapViewMode#VIRTUAL}.
- * @param extractAttachmentsEnabled
- * @param imapService
- * @param serviceRegistry
- * @param mountPointId - id of the mount point.
- */
- public AlfrescoImapFolder(
- FileInfo folderInfo,
+ /**
+ * Constructs {@link AlfrescoImapFolder} object.
+ *
+ * @param folderInfo - reference to the {@link FileInfo} object representing the folder.
+ * @param userName - name of user (e.g. "admin" for admin user).
+ * @param folderName - name of the folder.
+ * @param folderPath - path of the folder.
+ * @param viewMode - defines view mode. Can be one of the following: {@link ImapViewMode#ARCHIVE} or {@link ImapViewMode#VIRTUAL}.
+ * @param extractAttachmentsEnabled boolean
+ * @param imapService ImapService
+ * @param serviceRegistry ServiceRegistry
+ * @param mountPointId - id of the mount point.
+ */
+ public AlfrescoImapFolder(
+ FileInfo folderInfo,
String userName,
String folderName,
String folderPath,
@@ -165,22 +165,22 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
this(folderInfo, userName, folderName, folderPath, viewMode, imapService, serviceRegistry, null, extractAttachmentsEnabled, mountPointId);
}
- /**
- * Constructs {@link AlfrescoImapFolder} object.
- *
- * @param folderInfo - reference to the {@link FileInfo} object representing the folder.
- * @param userName - name of the user (e.g. "admin" for admin user).
- * @param folderName - name of the folder.
- * @param folderPath - path of the folder.
- * @param viewMode - defines view mode. Can be one of the following: {@link ImapViewMode#ARCHIVE} or {@link ImapViewMode#VIRTUAL}.
- * @param imapService - the IMAP service.
- * @param serviceRegistry
- * @param selectable - defines whether the folder is selectable or not.
- * @param extractAttachmentsEnabled
- * @param mountPointId
- */
- public AlfrescoImapFolder(
- FileInfo folderInfo,
+ /**
+ * Constructs {@link AlfrescoImapFolder} object.
+ *
+ * @param folderInfo - reference to the {@link FileInfo} object representing the folder.
+ * @param userName - name of the user (e.g. "admin" for admin user).
+ * @param folderName - name of the folder.
+ * @param folderPath - path of the folder.
+ * @param viewMode - defines view mode. Can be one of the following: {@link ImapViewMode#ARCHIVE} or {@link ImapViewMode#VIRTUAL}.
+ * @param imapService - the IMAP service.
+ * @param serviceRegistry ServiceRegistry
+ * @param selectable - defines whether the folder is selectable or not.
+ * @param extractAttachmentsEnabled boolean
+ * @param mountPointId int
+ */
+ public AlfrescoImapFolder(
+ FileInfo folderInfo,
String userName,
String folderName,
String folderPath,
@@ -334,10 +334,10 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
* Moves the node sourceNodeRef extracted from the message id.
* A part of a complex move operation.
*
- * @param folderInfo
- * @param message
- * @param flags
- * @param sourceNodeRef
+ * @param folderInfo FileInfo
+ * @param message MimeMessage
+ * @param flags Flags
+ * @param sourceNodeRef NodeRef
* @return UUID of the moved node
* @throws FileExistsException
* @throws FileNotFoundException
@@ -378,7 +378,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
* Typical message id is "<74bad8aa-75a5-4063-8e46-9d1b5737f43b@alfresco.org>"
* See {@link AbstractMimeMessage#updateMessageID()}
*
- * @param message
+ * @param message MimeMessage
* @return null if nothing is found
*/
private NodeRef extractNodeRef(MimeMessage message)
@@ -443,8 +443,8 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
/**
* Determine if it is a complex move operation, which consists of a create superseded by a delete.
*
- * @param sourceNodeRef
- * @return
+ * @param sourceNodeRef NodeRef
+ * @return boolean
*/
@SuppressWarnings("deprecation")
private boolean isMoveOperation(NodeRef sourceNodeRef)
@@ -505,7 +505,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Marks all messages in the folder as deleted using {@link Flags.Flag#DELETED} flag.
+ * Marks all messages in the folder as deleted using {@link javax.mail.Flags.Flag#DELETED} flag.
*/
@Override
public void deleteAllMessagesInternal() throws FolderException
@@ -524,7 +524,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Deletes messages marked with {@link Flags.Flag#DELETED}. Note that this message deletes all messages with this flag.
+ * Deletes messages marked with {@link javax.mail.Flags.Flag#DELETED}. Note that this message deletes all messages with this flag.
*/
@Override
protected void expungeInternal() throws FolderException
@@ -541,7 +541,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Deletes messages marked with {@link Flags.Flag#DELETED}. Note that this message deletes the message with current uid
+ * Deletes messages marked with {@link javax.mail.Flags.Flag#DELETED}. Note that this message deletes the message with current uid
*/
@Override
protected void expungeInternal(long uid) throws Exception
@@ -699,7 +699,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Returns the list of messages that have no {@link Flags.Flag#DELETED} flag set for current user.
+ * Returns the list of messages that have no {@link javax.mail.Flags.Flag#DELETED} flag set for current user.
*
* @return the list of non-deleted messages.
*/
@@ -740,11 +740,11 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Returns count of messages with {@link Flags.Flag#RECENT} flag.
- * If {@code reset} parameter is {@code true} - removes {@link Flags.Flag#RECENT} flag from
+ * Returns count of messages with {@link javax.mail.Flags.Flag#RECENT} flag.
+ * If {@code reset} parameter is {@code true} - removes {@link javax.mail.Flags.Flag#RECENT} flag from
* the message for current user.
*
- * @param reset - if true the {@link Flags.Flag#RECENT} will be deleted for current user if exists.
+ * @param reset - if true the {@link javax.mail.Flags.Flag#RECENT} will be deleted for current user if exists.
* @return returns count of recent messages.
*/
@Override
@@ -807,7 +807,7 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab
}
/**
- * Returns count of the messages with {@link Flags.Flag#SEEN} in the folder for the current user.
+ * Returns count of the messages with {@link javax.mail.Flags.Flag#SEEN} in the folder for the current user.
*
* @return Count of the unseen messages for current user.
*/
diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapHostManager.java b/source/java/org/alfresco/repo/imap/AlfrescoImapHostManager.java
index d1d72fd3f9..6e631ac660 100644
--- a/source/java/org/alfresco/repo/imap/AlfrescoImapHostManager.java
+++ b/source/java/org/alfresco/repo/imap/AlfrescoImapHostManager.java
@@ -53,7 +53,7 @@ public class AlfrescoImapHostManager implements ImapHostManager
private static Log logger = LogFactory.getLog(AlfrescoImapHostManager.class);
/**
- * @param imapService
+ * @param imapService ImapService
*/
public AlfrescoImapHostManager(ImapService imapService)
{
diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapServer.java b/source/java/org/alfresco/repo/imap/AlfrescoImapServer.java
index b4adbe171a..99c0caaa7e 100644
--- a/source/java/org/alfresco/repo/imap/AlfrescoImapServer.java
+++ b/source/java/org/alfresco/repo/imap/AlfrescoImapServer.java
@@ -67,7 +67,6 @@ public class AlfrescoImapServer extends AbstractLifecycleBean implements Applica
}
/**
- * @override
* Use Java's default SSL Server SocketFactory
* controlled via System Properties
* -Djavax.net.ssl.keyStore=mySrvKeystore
diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java b/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java
index c623411a1b..36d29fea33 100644
--- a/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java
+++ b/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java
@@ -22,6 +22,9 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
+import com.icegreen.greenmail.imap.ImapRequestLineReader;
+import com.icegreen.greenmail.imap.ImapResponse;
+import com.icegreen.greenmail.imap.ImapSession;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.security.authentication.AuthenticationException;
import org.alfresco.service.cmr.repository.NodeRef;
@@ -99,13 +102,12 @@ public class AlfrescoImapUserManager extends UserManager
}
}
- /**
- * The login method.
- *
- * @see com.icegreen.greenmail.imap.commands.LoginCommand#doProcess(com.icegreen.greenmail.imap.ImapRequestLineReader, com.icegreen.greenmail.imap.ImapResponse, com.icegreen.greenmail.imap.ImapSession)
- */
- public boolean test(String userid, String password)
- {
+ /**
+ * The login method.
+ *
+ */
+ public boolean test(String userid, String password)
+ {
try
{
authenticationService.authenticate(userid, password.toCharArray());
diff --git a/source/java/org/alfresco/repo/imap/ImapService.java b/source/java/org/alfresco/repo/imap/ImapService.java
index 0335581dbd..0b44abcc3b 100644
--- a/source/java/org/alfresco/repo/imap/ImapService.java
+++ b/source/java/org/alfresco/repo/imap/ImapService.java
@@ -101,7 +101,6 @@ public interface ImapService
*
* @param user User making the request.
* @param mailboxName String name of the target,
- * @throws com.icegreen.greenmail.store.FolderException if mailbox has a non-selectable store with children
*/
public void deleteMailbox(AlfrescoImapUser user, String mailboxName);
@@ -189,14 +188,14 @@ public interface ImapService
// public List searchFolders(NodeRef contextNodeRef, String namePattern, boolean includeSubFolders, ImapViewMode viewMode);
/**
- * Search for emails in specified folder depend on view mode.
- *
- * @param contextNodeRef context folder for search
- * @param contextNodeRef context NodeRef
- * @param viewMode (ARCHIVE, MIXED or VIRTUAL)
- * @return list of emails that context folder contains.
- */
- public FolderStatus getFolderStatus(final String userName, final NodeRef contextNodeRef, ImapViewMode viewMode);
+ * Search for emails in specified folder depend on view mode.
+ *
+ * @param userName user name
+ * @param contextNodeRef context NodeRef
+ * @param viewMode (ARCHIVE, MIXED or VIRTUAL)
+ * @return list of emails that context folder contains.
+ */
+ public FolderStatus getFolderStatus(final String userName, final NodeRef contextNodeRef, ImapViewMode viewMode);
/**
* Gets a cached MIME message for the given file, complete with message body.
@@ -221,30 +220,30 @@ public interface ImapService
*/
public void expungeMessage(FileInfo messageFileInfo);
- /**
- * Return flags that belong to the specified imap folder.
- *
- * @param messageFileInfo imap folder info.
- * @return flags.
- */
- public Flags getFlags(FileInfo messageFileInfo);
+ /**
+ * Return flags that belong to the specified imap folder.
+ *
+ * @param messageFileInfo imap folder info.
+ * @return flags.
+ */
+ public Flags getFlags(FileInfo messageFileInfo);
- /**
- * Set flags to the specified imapFolder.
- *
- * @param messageFileInfo FileInfo of imap Folder.
- * @param flags flags to set.
- * @param value value to set.
- */
+ /**
+ * Set flags to the specified imapFolder.
+ *
+ * @param messageFileInfo FileInfo of imap Folder.
+ * @param flags flags to set.
+ * @param value value to set.
+ */
public void setFlags(FileInfo messageFileInfo, Flags flags, boolean value);
- /**
- * Set flag to the specified imapFolder.
- *
- * @param messageFileInfo FileInfo of imap Folder
- * @param flag flag to set.
- * @param value value value to set.
- */
+ /**
+ * Set flag to the specified imapFolder.
+ *
+ * @param messageFileInfo FileInfo of imap Folder
+ * @param flag flag to set.
+ * @param value value value to set.
+ */
public void setFlag(FileInfo messageFileInfo, Flag flag, boolean value);
/**
@@ -276,13 +275,13 @@ public interface ImapService
* Returns a template for email body. It is either classpath path or NodeRef.toString().
* This method trying to find a template on the path in the repository first
* e.g. {@code "Data Dictionary > IMAP Templates >"}. This path should be set as the property of the "imapHelper" bean.
- * In this case it returns {@code NodeRef.toString()} of the template. If there are no template in the repository it
- * returns a default template on the classpath.
- *
- * @param type one of the possible body types text/html and text/plain
- * @return
- */
- public String getDefaultEmailBodyTemplate(EmailBodyFormat type);
+ * In this case it returns {@code NodeRef.toString()} of the template. If there are no template in the repository it
+ * returns a default template on the classpath.
+ *
+ * @param type one of the possible body types text/html and text/plain
+ * @return String
+ */
+ public String getDefaultEmailBodyTemplate(EmailBodyFormat type);
/**
* Get the node's site container if it belongs to Sites.
@@ -345,7 +344,7 @@ public interface ImapService
}
/**
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return path for node relatively to site root
*/
public String getPathFromSites(NodeRef nodeRef);
diff --git a/source/java/org/alfresco/repo/imap/ImapServiceImpl.java b/source/java/org/alfresco/repo/imap/ImapServiceImpl.java
index 175e89fb0b..a158926066 100644
--- a/source/java/org/alfresco/repo/imap/ImapServiceImpl.java
+++ b/source/java/org/alfresco/repo/imap/ImapServiceImpl.java
@@ -570,7 +570,7 @@ public class ImapServiceImpl implements ImapService, OnRestoreNodePolicy, OnCrea
/**
* Workaround for MNT-12259
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
@SuppressWarnings("deprecation")
private void hideAndDelete(final NodeRef nodeRef)
@@ -1183,7 +1183,7 @@ public class ImapServiceImpl implements ImapService, OnRestoreNodePolicy, OnCrea
/**
* Recursively search the given root to get a list of folders
*
- * @return
+ * @return List
*/
private List expandFolder(
NodeRef root,
@@ -1477,7 +1477,7 @@ public class ImapServiceImpl implements ImapService, OnRestoreNodePolicy, OnCrea
/**
* Checks for the existence of the flaggable aspect and adds it if it is not already present on the folder.
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
private void checkForFlaggableAspect(NodeRef nodeRef)
{
diff --git a/source/java/org/alfresco/repo/importer/DefaultContentHandler.java b/source/java/org/alfresco/repo/importer/DefaultContentHandler.java
index 57bc5f9d09..17753b255f 100644
--- a/source/java/org/alfresco/repo/importer/DefaultContentHandler.java
+++ b/source/java/org/alfresco/repo/importer/DefaultContentHandler.java
@@ -43,7 +43,7 @@ public class DefaultContentHandler
/**
* Construct
*
- * @param targetHandler
+ * @param targetHandler ImportContentHandler
*/
public DefaultContentHandler(ImportContentHandler targetHandler)
{
diff --git a/source/java/org/alfresco/repo/importer/ExportSource.java b/source/java/org/alfresco/repo/importer/ExportSource.java
index f3f9cd6b8d..6a1f705da9 100644
--- a/source/java/org/alfresco/repo/importer/ExportSource.java
+++ b/source/java/org/alfresco/repo/importer/ExportSource.java
@@ -25,7 +25,7 @@ public interface ExportSource
/**
* Generate XML suitable for use with the importer.
*
- * @param writer
+ * @param writer XMLWriter
*/
public void generateExport(XMLWriter writer);
}
diff --git a/source/java/org/alfresco/repo/importer/FileImportPackageHandler.java b/source/java/org/alfresco/repo/importer/FileImportPackageHandler.java
index 06a4394ca1..a22ba4817c 100644
--- a/source/java/org/alfresco/repo/importer/FileImportPackageHandler.java
+++ b/source/java/org/alfresco/repo/importer/FileImportPackageHandler.java
@@ -48,9 +48,9 @@ public class FileImportPackageHandler
/**
* Construct
*
- * @param sourceDir
- * @param dataFile
- * @param dataFileEncoding
+ * @param sourceDir File
+ * @param dataFile File
+ * @param dataFileEncoding String
*/
public FileImportPackageHandler(File sourceDir, File dataFile, String dataFileEncoding)
{
diff --git a/source/java/org/alfresco/repo/importer/FileImporter.java b/source/java/org/alfresco/repo/importer/FileImporter.java
index 027cea3e11..e96b42e1c2 100644
--- a/source/java/org/alfresco/repo/importer/FileImporter.java
+++ b/source/java/org/alfresco/repo/importer/FileImporter.java
@@ -45,10 +45,10 @@ public interface FileImporter
/**
* Load all files or directories that match the file filter in the given directory
*
- * @param container
- * @param file
- * @param filter
- * @param recurse
+ * @param container NodeRef
+ * @param file File
+ * @param filter FileFilter
+ * @param recurse boolean
* @return Returns the number of successfully imported files and directories
* @throws FileImporterException
*/
@@ -58,8 +58,8 @@ public interface FileImporter
/**
* Load a single file or directory without any recursion
*
- * @param container
- * @param file
+ * @param container NodeRef
+ * @param file File
* @return Returns the number of successfully imported files and directories
* @throws FileImporterException
*/
diff --git a/source/java/org/alfresco/repo/importer/ImportContentHandler.java b/source/java/org/alfresco/repo/importer/ImportContentHandler.java
index 5873236b4a..a4814bfff3 100644
--- a/source/java/org/alfresco/repo/importer/ImportContentHandler.java
+++ b/source/java/org/alfresco/repo/importer/ImportContentHandler.java
@@ -34,7 +34,7 @@ public interface ImportContentHandler extends ContentHandler, ErrorHandler
/**
* Sets the Importer
*
- * @param importer
+ * @param importer Importer
*/
public void setImporter(Importer importer);
diff --git a/source/java/org/alfresco/repo/importer/ImportTimerProgress.java b/source/java/org/alfresco/repo/importer/ImportTimerProgress.java
index 5a309bd75b..fa319d83df 100644
--- a/source/java/org/alfresco/repo/importer/ImportTimerProgress.java
+++ b/source/java/org/alfresco/repo/importer/ImportTimerProgress.java
@@ -56,7 +56,7 @@ public class ImportTimerProgress implements ImporterProgress
/**
* Construct
*
- * @param logger
+ * @param logger Log
*/
public ImportTimerProgress(Log logger)
{
@@ -168,7 +168,7 @@ public class ImportTimerProgress implements ImporterProgress
/**
* Dump statistics
*
- * @param end
+ * @param end Date
*/
private void dumpStats(Date end)
{
diff --git a/source/java/org/alfresco/repo/importer/ImporterBootstrap.java b/source/java/org/alfresco/repo/importer/ImporterBootstrap.java
index 973b5a61d8..70526acd4e 100644
--- a/source/java/org/alfresco/repo/importer/ImporterBootstrap.java
+++ b/source/java/org/alfresco/repo/importer/ImporterBootstrap.java
@@ -194,7 +194,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Set the authentication component
*
- * @param authenticationContext
+ * @param authenticationContext AuthenticationContext
*/
public void setAuthenticationContext(AuthenticationContext authenticationContext)
{
@@ -204,7 +204,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Sets the bootstrap views
*
- * @param bootstrapViews
+ * @param bootstrapViews List
*/
public void setBootstrapViews(List bootstrapViews)
{
@@ -214,7 +214,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Sets the bootstrap views
*
- * @param bootstrapViews
+ * @param bootstrapViews List
*/
public void addBootstrapViews(List bootstrapViews)
{
@@ -228,7 +228,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Sets the Store Ref to bootstrap into
*
- * @param storeUrl
+ * @param storeUrl String
*/
public void setStoreUrl(String storeUrl)
{
@@ -258,7 +258,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Sets the Configuration values for binding place holders
*
- * @param configuration
+ * @param configuration Properties
*/
public void setConfiguration(Properties configuration)
{
@@ -585,7 +585,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Set Import Configuration
*
- * @param configuration
+ * @param configuration Properties
*/
public void setConfiguration(Properties configuration)
{
@@ -605,7 +605,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Set Resource Bundle
*
- * @param resourceBundle
+ * @param resourceBundle ResourceBundle
*/
public void setResourceBundle(ResourceBundle resourceBundle)
{
@@ -615,7 +615,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean
/**
* Set Location
*
- * @param location
+ * @param location Location
*/
public void setLocation(Location location)
{
diff --git a/source/java/org/alfresco/repo/importer/ImporterBootstrapViews.java b/source/java/org/alfresco/repo/importer/ImporterBootstrapViews.java
index 586123498d..a76a810ae9 100644
--- a/source/java/org/alfresco/repo/importer/ImporterBootstrapViews.java
+++ b/source/java/org/alfresco/repo/importer/ImporterBootstrapViews.java
@@ -38,7 +38,7 @@ public class ImporterBootstrapViews implements InitializingBean
/**
* Sets the importer
*
- * @param importer
+ * @param importer ImporterBootstrap
*/
public void setImporter(ImporterBootstrap importer)
{
@@ -48,7 +48,7 @@ public class ImporterBootstrapViews implements InitializingBean
/**
* Sets the bootstrap views
*
- * @param bootstrapViews
+ * @param bootstrapViews List
*/
public void setBootstrapViews(List bootstrapViews)
{
diff --git a/source/java/org/alfresco/repo/importer/ImporterComponent.java b/source/java/org/alfresco/repo/importer/ImporterComponent.java
index 9690b4ed07..098f3e6644 100644
--- a/source/java/org/alfresco/repo/importer/ImporterComponent.java
+++ b/source/java/org/alfresco/repo/importer/ImporterComponent.java
@@ -362,8 +362,8 @@ public class ImporterComponent implements ImporterService
* ../../cm:people_x0020_folder
* sys:people/cm:admin_x0040_test
*
- * @param path
- * @return
+ * @param path String
+ * @return String
*/
private String createValidPath(String path)
{
@@ -402,13 +402,13 @@ public class ImporterComponent implements ImporterService
/**
* Perform Import via Parser
- *
- * @param nodeRef node reference to import under
- * @param location the location to import under
- * @param viewReader the view Reader
- * @param streamHandler the content property import stream handler
- * @param binding import configuration
- * @param progress import progress
+ *
+ * @param nodeRef node reference to import under
+ * @param location the location to import under
+ * @param viewReader the view Reader
+ * @param streamHandler the content property import stream handler
+ * @param binding import configuration
+ * @param progress import progress
*/
public void parserImport(NodeRef nodeRef, Location location, Reader viewReader, ImportPackageHandler streamHandler, ImporterBinding binding, ImporterProgress progress)
{
@@ -488,10 +488,11 @@ public class ImporterComponent implements ImporterService
/**
* Construct
*
- * @param rootRef
- * @param location
- * @param binding
- * @param progress
+ * @param rootRef NodeRef
+ * @param location Location
+ * @param binding ImporterBinding
+ * @param streamHandler ImportPackageHandler
+ * @param progress ImporterProgress
*/
private NodeImporter(NodeRef rootRef, Location location, ImporterBinding binding, ImportPackageHandler streamHandler, ImporterProgress progress)
{
@@ -766,13 +767,13 @@ public class ImporterComponent implements ImporterService
*
* The content URL, if present, will be a local URL. This import copies the content
* from the local URL to a server-assigned location.
- *
- * @param nodeRef containing node
- * @param propertyName the name of the content-type property
- * @param importContentData the identifier of the content to import
- */
- private void importContent(NodeRef nodeRef, QName propertyName, String importContentData)
- {
+ *
+ * @param nodeRef containing node
+ * @param propertyName the name of the content-type property
+ * @param importContentData the identifier of the content to import
+ */
+ private void importContent(NodeRef nodeRef, QName propertyName, String importContentData)
+ {
ImporterContentCache contentCache = (binding == null) ? null : binding.getImportConentCache();
// bind import content data description
@@ -1083,13 +1084,13 @@ public class ImporterComponent implements ImporterService
return classNames;
}
- /**
- * Bind properties
- *
- * @param context
- * @return
- */
- @SuppressWarnings("unchecked")
+ /**
+ * Bind properties
+ *
+ * @param context ImportNode
+ * @return Map
+ */
+ @SuppressWarnings("unchecked")
private Map bindProperties(ImportNode context)
{
Map properties = context.getProperties();
@@ -1141,13 +1142,13 @@ public class ImporterComponent implements ImporterService
return boundProperties;
}
- /**
- * Bind permissions - binds authorities
- *
- * @param permissions
- * @return
- */
- private List bindPermissions(List permissions)
+ /**
+ * Bind permissions - binds authorities
+ *
+ * @param permissions List
+ * @return List
+ */
+ private List bindPermissions(List permissions)
{
List boundPermissions = new ArrayList(permissions.size());
@@ -1196,7 +1197,7 @@ public class ImporterComponent implements ImporterService
*
* @param sourceNodeRef context to resolve within
* @param importedRef reference to resolve
- * @return
+ * @return NodeRef
*/
private NodeRef resolveImportedNodeRef(NodeRef sourceNodeRef, String importedRef)
{
@@ -1275,7 +1276,7 @@ public class ImporterComponent implements ImporterService
/**
* Helper to report error
*
- * @param e
+ * @param e Throwable
*/
private void reportError(Throwable e)
{
@@ -1285,12 +1286,12 @@ public class ImporterComponent implements ImporterService
}
}
- /**
- * Helper to report node created progress
- *
- * @param childAssocRef
- */
- private void reportNodeCreated(ChildAssociationRef childAssocRef)
+ /**
+ * Helper to report node created progress
+ *
+ * @param childAssocRef ChildAssociationRef
+ */
+ private void reportNodeCreated(ChildAssociationRef childAssocRef)
{
if (progress != null)
{
@@ -1298,28 +1299,28 @@ public class ImporterComponent implements ImporterService
}
}
- /**
- * Helper to report node linked progress
- *
- * @param childRef
- * @param parentRef
- * @param assocType
- * @param childName
- */
- private void reportNodeLinked(NodeRef childRef, NodeRef parentRef, QName assocType, QName childName)
- {
+ /**
+ * Helper to report node linked progress
+ *
+ * @param childRef NodeRef
+ * @param parentRef NodeRef
+ * @param assocType QName
+ * @param childName QName
+ */
+ private void reportNodeLinked(NodeRef childRef, NodeRef parentRef, QName assocType, QName childName)
+ {
if (progress != null)
{
progress.nodeLinked(childRef, parentRef, assocType, childName);
}
}
- /**
- * Helper to report content created progress
- *
- * @param nodeRef
- * @param sourceUrl
- */
+ /**
+ * Helper to report content created progress
+ *
+ * @param nodeRef NodeRef
+ * @param sourceUrl String
+ */
private void reportContentCreated(NodeRef nodeRef, String sourceUrl)
{
if (progress != null)
@@ -1328,12 +1329,12 @@ public class ImporterComponent implements ImporterService
}
}
- /**
- * Helper to report aspect added progress
- *
- * @param nodeRef
- * @param aspect
- */
+ /**
+ * Helper to report aspect added progress
+ *
+ * @param nodeRef NodeRef
+ * @param aspect QName
+ */
private void reportAspectAdded(NodeRef nodeRef, QName aspect)
{
if (progress != null)
@@ -1342,12 +1343,12 @@ public class ImporterComponent implements ImporterService
}
}
- /**
- * Helper to report property set progress
- *
- * @param nodeRef
- * @param properties
- */
+ /**
+ * Helper to report property set progress
+ *
+ * @param nodeRef NodeRef
+ * @param properties Map
+ */
private void reportPropertySet(NodeRef nodeRef, Map properties)
{
if (progress != null && properties != null)
@@ -1362,8 +1363,8 @@ public class ImporterComponent implements ImporterService
/**
* Helper to report permission set progress
*
- * @param nodeRef
- * @param permissions
+ * @param nodeRef NodeRef
+ * @param permissions List
*/
private void reportPermissionSet(NodeRef nodeRef, List permissions)
{
@@ -1385,13 +1386,13 @@ public class ImporterComponent implements ImporterService
// force allocation of new UUID, even if one already specified
private boolean assignNewUUID;
- /**
- * Construct
- *
- * @param assignNewUUID force allocation of new UUID
- */
- public CreateNewNodeImporterStrategy(boolean assignNewUUID)
- {
+ /**
+ * Construct
+ *
+ * @param assignNewUUID force allocation of new UUID
+ */
+ public CreateNewNodeImporterStrategy(boolean assignNewUUID)
+ {
this.assignNewUUID = assignNewUUID;
}
@@ -1686,9 +1687,9 @@ public class ImporterComponent implements ImporterService
/**
* Construct
*
- * @param context
- * @param property
- * @param value
+ * @param context ImportNode
+ * @param property QName
+ * @param value Serializable
*/
private ImportedNodeRef(ImportNode context, QName property, Serializable value)
{
@@ -1768,7 +1769,7 @@ public class ImporterComponent implements ImporterService
/**
* Construct
*
- * @param handler
+ * @param handler ImportContentHandler
*/
private ContentHandlerStreamHandler(ImportContentHandler handler)
{
diff --git a/source/java/org/alfresco/repo/importer/Parser.java b/source/java/org/alfresco/repo/importer/Parser.java
index 046579e0ac..6ced6edb57 100644
--- a/source/java/org/alfresco/repo/importer/Parser.java
+++ b/source/java/org/alfresco/repo/importer/Parser.java
@@ -36,8 +36,8 @@ public interface Parser
/**
* Parse nodes from specified input stream and import via the provided importer
*
- * @param viewReader
- * @param importer
+ * @param viewReader Reader
+ * @param importer Importer
*/
public void parse(Reader viewReader, Importer importer);
diff --git a/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java b/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java
index 9ca60a3ef4..ca2d4985d2 100644
--- a/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java
+++ b/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java
@@ -72,7 +72,7 @@ public class SystemInfoBootstrap extends AbstractLifecycleBean
/**
* Set the authentication component
*
- * @param authenticationContext
+ * @param authenticationContext AuthenticationContext
*/
public void setAuthenticationContext(AuthenticationContext authenticationContext)
{
@@ -82,7 +82,7 @@ public class SystemInfoBootstrap extends AbstractLifecycleBean
/**
* Set the System Importer
*
- * @param systemImporter
+ * @param systemImporter SystemExporterImporter
*/
public void setSystemImporter(SystemExporterImporter systemImporter)
{
@@ -102,7 +102,7 @@ public class SystemInfoBootstrap extends AbstractLifecycleBean
/**
* Set the bootstrap view containing the system information
*
- * @param bootstrapView
+ * @param bootstrapView String
*/
public void setBootstrapView(String bootstrapView)
{
diff --git a/source/java/org/alfresco/repo/importer/view/ElementContext.java b/source/java/org/alfresco/repo/importer/view/ElementContext.java
index 1f454b04bb..1816bdc7d6 100644
--- a/source/java/org/alfresco/repo/importer/view/ElementContext.java
+++ b/source/java/org/alfresco/repo/importer/view/ElementContext.java
@@ -41,15 +41,15 @@ public class ElementContext
private Importer importer;
- /**
- * Construct
- *
- * @param elementName
- * @param dictionary
- * @param importer
- */
- public ElementContext(QName elementName, DictionaryService dictionary, Importer importer)
- {
+ /**
+ * Construct
+ *
+ * @param elementName QName
+ * @param dictionary DictionaryService
+ * @param importer Importer
+ */
+ public ElementContext(QName elementName, DictionaryService dictionary, Importer importer)
+ {
this.elementName = elementName;
this.dictionary = dictionary;
this.importer = importer;
diff --git a/source/java/org/alfresco/repo/importer/view/MetaDataContext.java b/source/java/org/alfresco/repo/importer/view/MetaDataContext.java
index 7a3d0cdda6..3ab02a9486 100644
--- a/source/java/org/alfresco/repo/importer/view/MetaDataContext.java
+++ b/source/java/org/alfresco/repo/importer/view/MetaDataContext.java
@@ -36,13 +36,13 @@ public class MetaDataContext extends ElementContext
/**
- * Construct
- *
- * @param elementName
- * @param context
- */
- public MetaDataContext(QName elementName, ElementContext context)
- {
+ * Construct
+ *
+ * @param elementName QName
+ * @param context ElementContext
+ */
+ public MetaDataContext(QName elementName, ElementContext context)
+ {
super(elementName, context.getDictionaryService(), context.getImporter());
}
diff --git a/source/java/org/alfresco/repo/importer/view/NodeContext.java b/source/java/org/alfresco/repo/importer/view/NodeContext.java
index 6a23c3de13..c45b0e65a3 100644
--- a/source/java/org/alfresco/repo/importer/view/NodeContext.java
+++ b/source/java/org/alfresco/repo/importer/view/NodeContext.java
@@ -73,9 +73,9 @@ public class NodeContext extends ElementContext
/**
* Construct
*
- * @param elementName
- * @param parentContext
- * @param typeDef
+ * @param elementName QName
+ * @param parentContext ParentContext
+ * @param typeDef TypeDefinition
*/
public NodeContext(QName elementName, ParentContext parentContext, TypeDefinition typeDef)
{
@@ -121,7 +121,7 @@ public class NodeContext extends ElementContext
/**
* Set Type Definition
*
- * @param typeDef
+ * @param typeDef TypeDefinition
*/
public void setTypeDefinition(TypeDefinition typeDef)
{
@@ -213,7 +213,7 @@ public class NodeContext extends ElementContext
/**
* Adds a collection property to the node
*
- * @param property
+ * @param property QName
*/
public void addPropertyCollection(QName property)
{
@@ -356,9 +356,9 @@ public class NodeContext extends ElementContext
/**
* Adds an Access Control Entry
*
- * @param accessStatus
- * @param authority
- * @param permission
+ * @param accessStatus AccessStatus
+ * @param authority String
+ * @param permission String
*/
public void addAccessControlEntry(AccessStatus accessStatus, String authority, String permission)
{
@@ -387,7 +387,7 @@ public class NodeContext extends ElementContext
* Determine the type of definition (aspect, property, association) from the
* specified name
*
- * @param defName
+ * @param defName QName
* @return the dictionary definition
*/
public Object determineDefinition(QName defName)
@@ -407,8 +407,8 @@ public class NodeContext extends ElementContext
/**
* Determine if name referes to an aspect
*
- * @param defName
- * @return
+ * @param defName QName
+ * @return AspectDefinition
*/
public AspectDefinition determineAspect(QName defName)
{
@@ -423,8 +423,8 @@ public class NodeContext extends ElementContext
/**
* Determine if name refers to a property
*
- * @param defName
- * @return
+ * @param defName QName
+ * @return PropertyDefinition
*/
public PropertyDefinition determineProperty(QName defName)
{
@@ -456,8 +456,8 @@ public class NodeContext extends ElementContext
/**
* Determine if name referes to an association
*
- * @param defName
- * @return
+ * @param defName QName
+ * @return AssociationDefinition
*/
public AssociationDefinition determineAssociation(QName defName)
{
diff --git a/source/java/org/alfresco/repo/importer/view/ParentContext.java b/source/java/org/alfresco/repo/importer/view/ParentContext.java
index 3748a807fa..63adaac92c 100644
--- a/source/java/org/alfresco/repo/importer/view/ParentContext.java
+++ b/source/java/org/alfresco/repo/importer/view/ParentContext.java
@@ -46,16 +46,15 @@ public class ParentContext extends ElementContext
private QName assocType;
- /**
- * Construct
- *
- * @param elementName
- * @param dictionary
- * @param elementName
- * @param importer
- */
- public ParentContext(QName elementName, DictionaryService dictionary, Importer importer)
- {
+ /**
+ * Construct
+ *
+ * @param elementName QName
+ * @param dictionary DictionaryService
+ * @param importer Importer
+ */
+ public ParentContext(QName elementName, DictionaryService dictionary, Importer importer)
+ {
super(elementName, dictionary, importer);
parentRef = importer.getRootRef();
assocType = importer.getRootAssocType();
@@ -64,8 +63,8 @@ public class ParentContext extends ElementContext
/**
* Construct (with unknown child association)
*
- * @param elementName
- * @param parent
+ * @param elementName QName
+ * @param parent NodeContext
*/
public ParentContext(QName elementName, NodeContext parent)
{
@@ -75,13 +74,13 @@ public class ParentContext extends ElementContext
/**
* Construct
- *
- * @param elementName
- * @param parent
- * @param assocDef
- */
- public ParentContext(QName elementName, NodeContext parent, AssociationDefinition assocDef)
- {
+ *
+ * @param elementName QName
+ * @param parent NodeContext
+ * @param assocDef AssociationDefinition
+ */
+ public ParentContext(QName elementName, NodeContext parent, AssociationDefinition assocDef)
+ {
this(elementName, parent);
TypeDefinition typeDef = parent.getTypeDefinition();
diff --git a/source/java/org/alfresco/repo/importer/view/ViewParser.java b/source/java/org/alfresco/repo/importer/view/ViewParser.java
index 067b837e9c..4e4d49d291 100644
--- a/source/java/org/alfresco/repo/importer/view/ViewParser.java
+++ b/source/java/org/alfresco/repo/importer/view/ViewParser.java
@@ -207,8 +207,8 @@ public class ViewParser implements Parser
/**
* Process start of xml element
*
- * @param xpp
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -343,8 +343,8 @@ public class ViewParser implements Parser
/**
* Process Root
*
- * @param xpp
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -361,9 +361,9 @@ public class ViewParser implements Parser
/**
* Process meta-data
*
- * @param xpp
- * @param metaDataName
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param metaDataName QName
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -392,9 +392,9 @@ public class ViewParser implements Parser
/**
* Process start of a node definition
*
- * @param xpp
- * @param typeDef
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param typeDef TypeDefinition
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -427,9 +427,9 @@ public class ViewParser implements Parser
/**
* Process start reference
*
- * @param xpp
- * @param refName
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param refName QName
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -506,9 +506,9 @@ public class ViewParser implements Parser
/**
* Process aspect definition
*
- * @param xpp
- * @param aspectDef
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param aspectDef AspectDefinition
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -531,8 +531,8 @@ public class ViewParser implements Parser
/**
* Process ACL definition
*
- * @param xpp
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param parserContext ParserContext
*/
private void processACL(XmlPullParser xpp, ParserContext parserContext)
{
@@ -552,8 +552,8 @@ public class ViewParser implements Parser
/**
* Process ACE definition
*
- * @param xpp
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -647,9 +647,9 @@ public class ViewParser implements Parser
/**
* Process property definition
*
- * @param xpp
- * @param propertyName
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param propertyName QName
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -819,9 +819,9 @@ public class ViewParser implements Parser
/**
* Process start of association definition
*
- * @param xpp
- * @param assocDef
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param assocDef AssociationDefinition
+ * @param parserContext ParserContext
* @throws XmlPullParserException
* @throws IOException
*/
@@ -842,8 +842,8 @@ public class ViewParser implements Parser
/**
* Process end of xml element
*
- * @param xpp
- * @param parserContext
+ * @param xpp XmlPullParser
+ * @param parserContext ParserContext
*/
private void processEndElement(XmlPullParser xpp, ParserContext parserContext)
{
@@ -874,7 +874,7 @@ public class ViewParser implements Parser
/**
* Process end of the type definition
*
- * @param node
+ * @param node NodeContext
*/
private void processEndType(ParserContext parserContext, NodeContext node)
{
@@ -886,8 +886,8 @@ public class ViewParser implements Parser
/**
* Process end of the child association
*
- * @param parserContext
- * @param parent
+ * @param parserContext ParserContext
+ * @param parent ParserContext
*/
private void processEndAssoc(ParserContext parserContext, ParentContext parent)
{
@@ -896,7 +896,7 @@ public class ViewParser implements Parser
/**
* Process end of meta data
*
- * @param context
+ * @param context ParserContext
*/
private void processEndMetaData(ParserContext parserContext, MetaDataContext context)
{
@@ -976,8 +976,8 @@ public class ViewParser implements Parser
/**
* Helper to create Qualified name from current xml element
*
- * @param xpp
- * @return
+ * @param xpp XmlPullParser
+ * @return QName
*/
private QName getName(XmlPullParser xpp)
{
@@ -995,10 +995,10 @@ public class ViewParser implements Parser
/**
* Helper to indent debug output
- *
- * @param msg
- * @param depth
- * @return
+ *
+ * @param msg String
+ * @param depth int
+ * @return String
*/
private String indentLog(String msg, int depth)
{
diff --git a/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java b/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java
index 88b6ed79a2..87fb7fad3e 100644
--- a/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java
+++ b/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java
@@ -179,15 +179,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
}
/**
- * Start the invitation process for a NominatedInvitation
- *
- * @param inviteeUserName Alfresco user name of the invitee
- * @param resourceType resourceType
- * @param resourceName
- * @param inviteeRole
- * @param serverPath
- * @param acceptUrl
- * @param rejectUrl
+ * Start the invitation process for a NominatedInvitation
+ *
+ * @param inviteeUserName Alfresco user name of the invitee
+ * @param resourceType resourceType
+ * @param resourceName String
+ * @param inviteeRole String
+ * @param serverPath String
+ * @param acceptUrl String
+ * @param rejectUrl String
* @return the nominated invitation which will contain the invitationId and
* ticket which will uniqely identify this invitation for the rest
* of the workflow.
@@ -212,14 +212,14 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
serverPath, acceptUrl, rejectUrl);
}
/**
- * Start the invitation process for a NominatedInvitation
- *
- * @param inviteeUserName Alfresco user name of the invitee
- * @param resourceType resourceType
- * @param resourceName
- * @param inviteeRole
- * @param acceptUrl
- * @param rejectUrl
+ * Start the invitation process for a NominatedInvitation
+ *
+ * @param inviteeUserName Alfresco user name of the invitee
+ * @param resourceType resourceType
+ * @param resourceName String
+ * @param inviteeRole String
+ * @param acceptUrl String
+ * @param rejectUrl String
* @return the nominated invitation which will contain the invitationId and
* ticket which will uniqely identify this invitation for the rest
* of the workflow.
@@ -247,15 +247,14 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Start the invitation process for a NominatedInvitation
*
- * @param inviteeFirstName
- * @param inviteeLastName
- * @param inviteeEmail
- * @param inviteeEmail
- * @param resourceType Invitation.ResourceType
- * @param resourceName
- * @param inviteeRole
- * @param acceptUrl
- * @param rejectUrl
+ * @param inviteeFirstName String
+ * @param inviteeLastName String
+ * @param inviteeEmail String
+ * @param resourceType Invitation.ResourceType
+ * @param resourceName String
+ * @param inviteeRole String
+ * @param acceptUrl String
+ * @param rejectUrl String
* @return the nominated invitation which will contain the invitationId and
* ticket which will uniqely identify this invitation for the rest
* of the workflow.
@@ -274,15 +273,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Start the invitation process for a NominatedInvitation
*
- * @param inviteeFirstName
- * @param inviteeLastName
- * @param inviteeEmail
- * @param resourceType
- * @param resourceName
- * @param inviteeRole
- * @param serverPath
- * @param acceptUrl
- * @param rejectUrl
+ * @param inviteeFirstName String
+ * @param inviteeLastName String
+ * @param inviteeEmail String
+ * @param resourceType Invitation.ResourceTyp
+ * @param resourceName String
+ * @param inviteeRole String
+ * @param serverPath String
+ * @param acceptUrl String
+ * @param rejectUrl String
* @return the nominated invitation which will contain the invitationId and
* ticket which will uniqely identify this invitation for the rest
* of the workflow.
@@ -316,15 +315,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
throw new InvitationException("unknown resource type");
}
- /**
- * Start the invitation process for a ModeratedInvitation
- *
- * @param inviteeComments why does the invitee want access to the resource ?
- * @param inviteeUserName who is to be invited
- * @param resourceType Invitation .ResourceType what resource type ?
- * @param resourceName which resource
- * @param inviteeRole which role ?
- */
+ /**
+ * Start the invitation process for a ModeratedInvitation
+ *
+ * @param inviteeComments why does the invitee want access to the resource ?
+ * @param inviteeUserName who is to be invited
+ * @param resourceType Invitation .ResourceType what resource type ?
+ * @param resourceName which resource
+ * @param inviteeRole which role ?
+ */
public ModeratedInvitation inviteModerated(String inviteeComments, String inviteeUserName,
Invitation.ResourceType resourceType, String resourceName, String inviteeRole)
{
@@ -395,13 +394,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
}
}
- /**
- * Moderator approves this invitation
- *
- * @param invitationId the request id
- * @param reason comments about the acceptance
- */
- public Invitation approve(String invitationId, String reason)
+ /**
+ * Moderator approves this invitation
+ *
+ * @param invitationId the request id
+ * @param reason comments about the acceptance
+ */
+ public Invitation approve(String invitationId, String reason)
{
WorkflowTask startTask = getStartTask(invitationId);
ModeratedInvitation invitation = getModeratedInvitation(invitationId);
@@ -427,7 +426,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* User or moderator rejects this request
*
- * @param invitationId
+ * @param invitationId String
* @param reason , optional reason for rejection
*/
public Invitation reject(String invitationId, String reason)
@@ -718,8 +717,8 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* list Invitations for a specific resource
*
- * @param resourceType
- * @param resourceName
+ * @param resourceType Invitation.ResourceType
+ * @param resourceName String
*/
public List listPendingInvitationsForResource(Invitation.ResourceType resourceType, String resourceName)
{
@@ -729,8 +728,8 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Returns search criteria to find pending invitations
- * @param resourceType
- * @param resourceName
+ * @param resourceType Invitation.ResourceType
+ * @param resourceName String
* @return search criteria
*/
private InvitationSearchCriteriaImpl getPendingInvitationCriteriaForResource(
@@ -746,7 +745,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* This is the general search invitation method returning {@link Invitation}s
*
- * @param criteria
+ * @param criteria InvitationSearchCriteria
* @return the list of start tasks for invitations
*/
public List searchInvitation(final InvitationSearchCriteria criteria)
@@ -777,7 +776,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* This is a general search invitation method returning IDs
*
- * @param criteria
+ * @param criteria InvitationSearchCriteria
* @param limit maximum number of IDs to return. If less than 1, there is no limit.
* @return the list of invitation IDs (the IDs of the invitations not the IDs of the invitation start tasks)
*/
@@ -819,9 +818,9 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Fix for ALF-2598
- * @param invitation
- * @param criteria
- * @return
+ * @param invitation Invitation
+ * @param criteria InvitationSearchCriteria
+ * @return boolean
*/
private boolean invitationMatches(Invitation invitation, InvitationSearchCriteria criteria)
{
@@ -984,7 +983,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Set the workflow service
*
- * @param workflowService
+ * @param workflowService WorkflowService
*/
public void setWorkflowService(WorkflowService workflowService)
{
@@ -1164,7 +1163,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
* Creates a disabled user account for the given invitee user name with a
* generated password
*
- * @param inviteeUserName
+ * @param inviteeUserName String
* @return password generated for invitee user account
*/
private String createInviteeDisabledAccount(String inviteeUserName)
@@ -1220,22 +1219,22 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
}
/**
- * Starts the Invite workflow
- *
- * @param inviteeFirstName first name of invitee
- * @param inviteeLastName last name of invitee
- * @param inviteeEmail email address of invitee
- * @param siteShortName short name of site that the invitee is being invited
- * to by the inviter
+ * Starts the Invite workflow
+ *
+ * @param inviteeFirstName first name of invitee
+ * @param inviteeLastName last name of invitee
+ * @param inviteeEmail email address of invitee
+ * @param siteShortName short name of site that the invitee is being invited
+ * to by the inviter
* @param inviteeSiteRole role under which invitee is being invited to the
- * site by the inviter
- * @param serverPath externally accessible server address of server hosting
- * invite web scripts
- * @param acceptUrl accept Url
- * @param rejectUrl reject Url
- */
- private NominatedInvitation startNominatedInvite(String inviteeFirstName, String inviteeLastName,
- String inviteeEmail, String inviteeUserName, Invitation.ResourceType resourceType,
+ * site by the inviter
+ * @param serverPath externally accessible server address of server hosting
+ * invite web scripts
+ * @param acceptUrl accept Url
+ * @param rejectUrl reject Url
+ */
+ private NominatedInvitation startNominatedInvite(String inviteeFirstName, String inviteeLastName,
+ String inviteeEmail, String inviteeUserName, Invitation.ResourceType resourceType,
String siteShortName, String inviteeSiteRole, String serverPath, String acceptUrl, String rejectUrl)
{
@@ -1491,7 +1490,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Return Activiti workflow definition unless Activiti engine is disabled.
* @param isNominated TODO
- * @return
+ * @return WorkflowDefinition
*/
private WorkflowDefinition getWorkflowDefinition(boolean isNominated)
{
@@ -1532,13 +1531,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
throw new IllegalStateException("None of the Workflow engines supported by teh InvitationService are currently enabled!");
}
- /**
- * Check that the specified user has manager role over the resource.
- *
- * @param userId user id
- * @throws InvitationException
- */
- private void checkManagerRole(String userId, Invitation.ResourceType resourceType, String siteShortName)
+ /**
+ * Check that the specified user has manager role over the resource.
+ *
+ * @param userId user id
+ * @throws InvitationException
+ */
+ private void checkManagerRole(String userId, Invitation.ResourceType resourceType, String siteShortName)
{
// if inviter is not the site manager then throw web script exception
String inviterRole = this.siteService.getMembersRole(siteShortName, userId);
@@ -1553,7 +1552,7 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli
/**
* Validator for invitationId
*
- * @param invitationId
+ * @param invitationId String
*/
private void validateInvitationId(String invitationId)
{
diff --git a/source/java/org/alfresco/repo/invitation/InviteHelper.java b/source/java/org/alfresco/repo/invitation/InviteHelper.java
index 0659150f8e..edab503d97 100644
--- a/source/java/org/alfresco/repo/invitation/InviteHelper.java
+++ b/source/java/org/alfresco/repo/invitation/InviteHelper.java
@@ -184,12 +184,12 @@ public class InviteHelper implements InitializingBean
/**
* Returns an InviteInfo instance for the given startInvite task
- * (used for rendering the response).
- *
- * @param startInviteTask startInvite task to get invite info properties from
- * @return InviteInfo instance containing invite information
- */
- public InviteInfo getPendingInviteInfo(WorkflowTask startInviteTask)
+ * (used for rendering the response).
+ *
+ * @param startInviteTask startInvite task to get invite info properties from
+ * @return InviteInfo instance containing invite information
+ */
+ public InviteInfo getPendingInviteInfo(WorkflowTask startInviteTask)
{
Map taskProps = startInviteTask.getProperties();
// get the inviter, invitee, role and site short name
@@ -230,13 +230,13 @@ public class InviteHelper implements InitializingBean
/**
* Add Invitee to Site with the site role that the inviter "started" the invite process with
- * @param invitee
- * @param siteName
- * @param role
- * @param runAsUser
- * @param overrideExisting
- */
- public void addSiteMembership(final String invitee, final String siteName, final String role, final String runAsUser, final boolean overrideExisting)
+ * @param invitee String
+ * @param siteName String
+ * @param role String
+ * @param runAsUser String
+ * @param overrideExisting boolean
+ */
+ public void addSiteMembership(final String invitee, final String siteName, final String role, final String runAsUser, final boolean overrideExisting)
{
AuthenticationUtil.runAs(new RunAsWork()
{
@@ -256,12 +256,12 @@ public class InviteHelper implements InitializingBean
* Clean up invitee user account and person node when no longer in use.
* They are deemed to no longer be in use when the invitee user account
* is still disabled and there are no outstanding pending invites for that invitee.
- *
- * @param inviteeUserName
- * @param currentInviteId TODO
- */
- public void deleteAuthenticationIfUnused(final String inviteeUserName, final String currentInviteId)
- {
+ *
+ * @param inviteeUserName String
+ * @param currentInviteId String
+ */
+ public void deleteAuthenticationIfUnused(final String inviteeUserName, final String currentInviteId)
+ {
AuthenticationUtil.runAs(new RunAsWork()
{
public Object doWork() throws Exception
@@ -302,9 +302,11 @@ public class InviteHelper implements InitializingBean
}
}, AuthenticationUtil.getSystemUserName());
}
-
+
/**
- * @param executionVariables
+ *
+ * @param executionVariables Map
+ * @param currentInviteId String
*/
public void cancelInvitation(Map executionVariables, String currentInviteId)
{
@@ -366,7 +368,7 @@ public class InviteHelper implements InitializingBean
}
/**
- * @param vars
+ * @param vars Map
*/
public void rejectModeratedInvitation(Map vars)
{
diff --git a/source/java/org/alfresco/repo/invitation/ModeratedInvitationProcess.java b/source/java/org/alfresco/repo/invitation/ModeratedInvitationProcess.java
index 1a092f6d66..5e4c0747d9 100644
--- a/source/java/org/alfresco/repo/invitation/ModeratedInvitationProcess.java
+++ b/source/java/org/alfresco/repo/invitation/ModeratedInvitationProcess.java
@@ -32,8 +32,8 @@ public interface ModeratedInvitationProcess extends InvitationProcess
{
/**
* Invitee kicks off process
- * @param request
- * @param reason
+ * @param request Invitation
+ * @param reason String
*/
public Invitation invite(Invitation request, String reason);
diff --git a/source/java/org/alfresco/repo/invitation/NominatedInvitationProcess.java b/source/java/org/alfresco/repo/invitation/NominatedInvitationProcess.java
index be4ac6978f..b0f5f49a36 100644
--- a/source/java/org/alfresco/repo/invitation/NominatedInvitationProcess.java
+++ b/source/java/org/alfresco/repo/invitation/NominatedInvitationProcess.java
@@ -37,13 +37,13 @@ public interface NominatedInvitationProcess extends InvitationProcess
/**
* invitee accepts this request
- * @param request
+ * @param request Invitation
*/
public void accept(Invitation request);
/**
* invitee rejects this request
- * @param request
+ * @param request Invitation
*/
public void reject(Invitation request);
diff --git a/source/java/org/alfresco/repo/invitation/script/ScriptInvitationService.java b/source/java/org/alfresco/repo/invitation/script/ScriptInvitationService.java
index 826784aec2..f3e5fe92ec 100644
--- a/source/java/org/alfresco/repo/invitation/script/ScriptInvitationService.java
+++ b/source/java/org/alfresco/repo/invitation/script/ScriptInvitationService.java
@@ -101,10 +101,7 @@ public class ScriptInvitationService extends BaseScopableProcessorExtension
* List the open invitations.
* props specifies optional properties to constrain the search.
*
- * @param props inviteeUserName
- * @param props resourceName
- * @param props resourceType
- * @param props invitationType
+ * @param props props
*
* @return the invitations
*/
diff --git a/source/java/org/alfresco/repo/invitation/site/InviteSender.java b/source/java/org/alfresco/repo/invitation/site/InviteSender.java
index 1b4ff85175..e428cb505c 100644
--- a/source/java/org/alfresco/repo/invitation/site/InviteSender.java
+++ b/source/java/org/alfresco/repo/invitation/site/InviteSender.java
@@ -136,7 +136,7 @@ public class InviteSender
}
/**
- * @param properties
+ * @param properties Map
*/
private void checkProperties(Map properties)
{
diff --git a/source/java/org/alfresco/repo/invitation/site/SiteNominatedInvitationProcess.java b/source/java/org/alfresco/repo/invitation/site/SiteNominatedInvitationProcess.java
index 339f5f69a8..fb77f5c417 100644
--- a/source/java/org/alfresco/repo/invitation/site/SiteNominatedInvitationProcess.java
+++ b/source/java/org/alfresco/repo/invitation/site/SiteNominatedInvitationProcess.java
@@ -37,7 +37,7 @@ public class SiteNominatedInvitationProcess implements NominatedInvitationProces
/**
* invitee accepts this request
- * @param request
+ * @param request Invitation
*/
public void accept(Invitation request)
{
@@ -45,7 +45,7 @@ public class SiteNominatedInvitationProcess implements NominatedInvitationProces
/**
* invitee rejects this request
- * @param request
+ * @param request Invitation
*/
public void reject(Invitation request)
{
diff --git a/source/java/org/alfresco/repo/jscript/CategoryNode.java b/source/java/org/alfresco/repo/jscript/CategoryNode.java
index cadc7980f1..d233af520f 100644
--- a/source/java/org/alfresco/repo/jscript/CategoryNode.java
+++ b/source/java/org/alfresco/repo/jscript/CategoryNode.java
@@ -162,8 +162,8 @@ public class CategoryNode extends ScriptNode
/**
* Build category nodes from collection of association references.
*
- * @param cars
- * @return
+ * @param cars Collection
+ * @return CategoryNode[]
*/
private CategoryNode[] buildCategoryNodes(Collection cars)
{
@@ -179,8 +179,8 @@ public class CategoryNode extends ScriptNode
/**
* Build script nodes from a collection of association references.
*
- * @param cars
- * @return
+ * @param cars Collection
+ * @return ScriptNode[]
*/
private ScriptNode[] buildNodes(Collection cars)
{
@@ -196,8 +196,8 @@ public class CategoryNode extends ScriptNode
/**
* Build script nodes and category nodes from a mixed collection of association references.
*
- * @param cars
- * @return
+ * @param cars Collection
+ * @return ScriptNode[]
*/
private ScriptNode[] buildMixedNodes(Collection cars)
{
diff --git a/source/java/org/alfresco/repo/jscript/CategoryTemplateNode.java b/source/java/org/alfresco/repo/jscript/CategoryTemplateNode.java
index c800b80792..5bde548367 100644
--- a/source/java/org/alfresco/repo/jscript/CategoryTemplateNode.java
+++ b/source/java/org/alfresco/repo/jscript/CategoryTemplateNode.java
@@ -40,9 +40,9 @@ public class CategoryTemplateNode extends TemplateNode
/**
* Constructor
*
- * @param nodeRef
- * @param services
- * @param resolver
+ * @param nodeRef NodeRef
+ * @param services ServiceRegistry
+ * @param resolver TemplateImageResolver
*/
public CategoryTemplateNode(NodeRef nodeRef, ServiceRegistry services, TemplateImageResolver resolver)
{
@@ -155,7 +155,7 @@ public class CategoryTemplateNode extends TemplateNode
/**
* Support to build node lists from category service API calls.
*
- * @param childRefs
+ * @param childRefs Collection
*
* @return List of TemplateNode
*/
diff --git a/source/java/org/alfresco/repo/jscript/ChildAssociation.java b/source/java/org/alfresco/repo/jscript/ChildAssociation.java
index 723b56af95..d30ab99b5b 100644
--- a/source/java/org/alfresco/repo/jscript/ChildAssociation.java
+++ b/source/java/org/alfresco/repo/jscript/ChildAssociation.java
@@ -52,8 +52,9 @@ public class ChildAssociation implements Scopeable, Serializable
/**
* Constructor
*
- * @param services
- * @param childAssocRef
+ * @param services ServiceRegistry
+ * @param childAssocRef ChildAssociationRef
+ * @param scope Scriptable
*/
public ChildAssociation(ServiceRegistry services, ChildAssociationRef childAssocRef, Scriptable scope)
{
diff --git a/source/java/org/alfresco/repo/jscript/Classification.java b/source/java/org/alfresco/repo/jscript/Classification.java
index e1d0190e65..c89b7f45d7 100644
--- a/source/java/org/alfresco/repo/jscript/Classification.java
+++ b/source/java/org/alfresco/repo/jscript/Classification.java
@@ -66,8 +66,8 @@ public final class Classification extends BaseScopableProcessorExtension
/**
* Find all the category nodes in a given classification.
*
- * @param aspect
- * @return
+ * @param aspect String
+ * @return Scriptable
*/
public Scriptable getAllCategoryNodes(String aspect)
{
@@ -79,7 +79,7 @@ public final class Classification extends BaseScopableProcessorExtension
/**
* Get all the aspects that define a classification.
*
- * @return
+ * @return String[]
*/
public String[] getAllClassificationAspects()
{
@@ -96,8 +96,8 @@ public final class Classification extends BaseScopableProcessorExtension
/**
* Create a root category in a classification.
*
- * @param aspect
- * @param name
+ * @param aspect String
+ * @param name String
*/
public CategoryNode createRootCategory(String aspect, String name)
{
@@ -128,8 +128,8 @@ public final class Classification extends BaseScopableProcessorExtension
/**
* Get the root categories in a classification.
*
- * @param aspect
- * @return
+ * @param aspect String
+ * @return Scriptable
*/
public Scriptable getRootCategories(String aspect)
{
@@ -141,9 +141,9 @@ public final class Classification extends BaseScopableProcessorExtension
/**
* Get the category usage count.
*
- * @param aspect
- * @param maxCount
- * @return
+ * @param aspect String
+ * @param maxCount int
+ * @return Scriptable
*/
public Scriptable getCategoryUsage(String aspect, int maxCount)
{
@@ -194,12 +194,12 @@ public final class Classification extends BaseScopableProcessorExtension
}
return qname;
}
-
- /**
- * Tag class returned from getCategoryUsage().
- */
- public final class Tag
- {
+
+ /**
+ * Tag class returned from getCategoryUsage().
+ */
+ public final class Tag
+ {
private CategoryNode categoryNode;
private int frequency = 0;
diff --git a/source/java/org/alfresco/repo/jscript/NativeMap.java b/source/java/org/alfresco/repo/jscript/NativeMap.java
index c528f691ef..ea4fb92b78 100644
--- a/source/java/org/alfresco/repo/jscript/NativeMap.java
+++ b/source/java/org/alfresco/repo/jscript/NativeMap.java
@@ -42,8 +42,8 @@ public class NativeMap implements Scriptable, Wrapper
/**
* Construct
*
- * @param scope
- * @param map
+ * @param scope Scriptable
+ * @param map Map
* @return native map
*/
public static NativeMap wrap(Scriptable scope, Map map)
@@ -54,8 +54,8 @@ public class NativeMap implements Scriptable, Wrapper
/**
* Construct
*
- * @param scope
- * @param map
+ * @param scope Scriptable
+ * @param map Map
*/
public NativeMap(Scriptable scope, Map map)
{
diff --git a/source/java/org/alfresco/repo/jscript/People.java b/source/java/org/alfresco/repo/jscript/People.java
index cc38bc67e1..8f8b2503ba 100644
--- a/source/java/org/alfresco/repo/jscript/People.java
+++ b/source/java/org/alfresco/repo/jscript/People.java
@@ -231,7 +231,7 @@ public class People extends BaseScopableProcessorExtension implements Initializi
/**
* Set the UserRegistrySynchronizer
*
- * @param userRegistrySynchronizer
+ * @param userRegistrySynchronizer UserRegistrySynchronizer
*/
public void setUserRegistrySynchronizer(UserRegistrySynchronizer userRegistrySynchronizer)
{
@@ -512,7 +512,7 @@ public class People extends BaseScopableProcessorExtension implements Initializi
* @param filter filter query string by which to filter the collection of people.
* If
null
then all people stored in the repository are returned
*
- * @deprecate see getPeople(filter, maxResults)
+ * @deprecated recated see getPeople(filter, maxResults)
*
* @return people collection as a JavaScript array
*/
@@ -1236,8 +1236,8 @@ public class People extends BaseScopableProcessorExtension implements Initializi
* This enables a script to interogate which properties are dealt with by an external
* system such as LDAP and should not be mutable in any client UI.
*
- * @param username
- *
+ * @param username String
+ *
* @return ScriptableHashMap
*/
public ScriptableHashMap getImmutableProperties(String username)
diff --git a/source/java/org/alfresco/repo/jscript/RhinoScriptProcessor.java b/source/java/org/alfresco/repo/jscript/RhinoScriptProcessor.java
index 17c17a377a..80c56fb382 100644
--- a/source/java/org/alfresco/repo/jscript/RhinoScriptProcessor.java
+++ b/source/java/org/alfresco/repo/jscript/RhinoScriptProcessor.java
@@ -542,7 +542,7 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
*
* @param model the model
*
- * @return Map the converted model
+ * @return Map the converted model
*/
private Map convertToRhinoModel(Map model)
{
diff --git a/source/java/org/alfresco/repo/jscript/ScriptNode.java b/source/java/org/alfresco/repo/jscript/ScriptNode.java
index 427036b0a6..1fbe54b28c 100644
--- a/source/java/org/alfresco/repo/jscript/ScriptNode.java
+++ b/source/java/org/alfresco/repo/jscript/ScriptNode.java
@@ -624,7 +624,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
*
* @deprecated API for review (subject to change prior to release)
*
- * @author janv
+ * author janv
* @since 4.0
*/
public ScriptPagingNodes childFileFolders(boolean files, boolean folders, Object ignoreTypes, int maxItems)
@@ -652,7 +652,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
* system folder types from the results.
* This is equivalent to @see FileFolderService.listFiles() and @see FileFolderService.listFolders()
*
- * @author janv
+ *
author janv
* @since 4.0
*/
public ScriptPagingNodes childFileFolders(boolean files, boolean folders, Object ignoreTypes, int skipOffset, int maxItems, int requestTotalCountMax, String sortProp, Boolean sortAsc, String queryExecutionId)
@@ -944,7 +944,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
/**
* Checks whether the {@link ScriptNode} exists in the repository.
- * @return
+ * @return boolean
*/
public boolean exists()
{
@@ -1672,7 +1672,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
/**
* Get the owner of the node.
*
- * @return
+ * @return String
*/
public String getOwner()
{
@@ -2422,7 +2422,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
/**
* Performs a check-out of this document for the purposes of an upload
*
- * @return
+ * @return ScriptNode
*/
public ScriptNode checkoutForUpload()
{
@@ -3456,7 +3456,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
* Given a long-form QName, this method uses the namespace service to create a
* short-form QName string.
*
- * @param longQName
+ * @param longQName QName
* @return the short form of the QName string, e.g. "cm:content"
*/
protected String getShortQName(QName longQName)
@@ -3814,7 +3814,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider
/**
* Set the content stream from another input stream.
*
- * @param inputStream
+ * @param inputStream InputStream
*/
public void write(InputStream inputStream)
{
diff --git a/source/java/org/alfresco/repo/jscript/ScriptUtils.java b/source/java/org/alfresco/repo/jscript/ScriptUtils.java
index 8b889be46f..b91f1931da 100644
--- a/source/java/org/alfresco/repo/jscript/ScriptUtils.java
+++ b/source/java/org/alfresco/repo/jscript/ScriptUtils.java
@@ -217,8 +217,8 @@ public class ScriptUtils extends BaseScopableProcessorExtension
/**
* Format timeInMillis to ISO 8601 formatted string
*
- * @param timeInMillis
- * @return
+ * @param timeInMillis long
+ * @return String
*/
public String toISO8601(long timeInMillis)
{
@@ -228,8 +228,8 @@ public class ScriptUtils extends BaseScopableProcessorExtension
/**
* Format date to ISO 8601 formatted string
*
- * @param date
- * @return
+ * @param date Date
+ * @return String
*/
public String toISO8601(Date date)
{
@@ -239,8 +239,8 @@ public class ScriptUtils extends BaseScopableProcessorExtension
/**
* Parse date from ISO formatted string
*
- * @param isoDateString
- * @return
+ * @param isoDateString String
+ * @return Date
*/
public Date fromISO8601(String isoDateString)
{
diff --git a/source/java/org/alfresco/repo/jscript/ScriptableQNameMap.java b/source/java/org/alfresco/repo/jscript/ScriptableQNameMap.java
index 4d26bf3705..65b866a3b0 100644
--- a/source/java/org/alfresco/repo/jscript/ScriptableQNameMap.java
+++ b/source/java/org/alfresco/repo/jscript/ScriptableQNameMap.java
@@ -30,7 +30,7 @@ import org.mozilla.javascript.Scriptable;
public class ScriptableQNameMap extends QNameMap implements Scriptable
{
/**
- * @param resolver
+ * @param resolver NamespacePrefixResolverProvider
*/
public ScriptableQNameMap(NamespacePrefixResolverProvider resolver)
{
diff --git a/source/java/org/alfresco/repo/jscript/Search.java b/source/java/org/alfresco/repo/jscript/Search.java
index 73392fefcb..b69e11e9dc 100644
--- a/source/java/org/alfresco/repo/jscript/Search.java
+++ b/source/java/org/alfresco/repo/jscript/Search.java
@@ -539,7 +539,7 @@ public class Search extends BaseScopableProcessorExtension implements Initializi
*
* Note that only some query languages support custom query templates, such as 'fts-alfresco'.
* See the following documentation for more details:
- * {@link http://wiki.alfresco.com/wiki/Full_Text_Search_Query_Syntax#Templates}
+ * Templates
*
*
* @param search Search definition object as above
diff --git a/source/java/org/alfresco/repo/jscript/Session.java b/source/java/org/alfresco/repo/jscript/Session.java
index 12a50e4893..d348d88994 100644
--- a/source/java/org/alfresco/repo/jscript/Session.java
+++ b/source/java/org/alfresco/repo/jscript/Session.java
@@ -46,7 +46,7 @@ public class Session extends BaseProcessorExtension
/**
* Get the user's authentication ticket.
*
- * @return
+ * @return String
*/
public String getTicket()
{
diff --git a/source/java/org/alfresco/repo/jscript/app/CustomResponse.java b/source/java/org/alfresco/repo/jscript/app/CustomResponse.java
index c68b811c7f..8e94140b7a 100644
--- a/source/java/org/alfresco/repo/jscript/app/CustomResponse.java
+++ b/source/java/org/alfresco/repo/jscript/app/CustomResponse.java
@@ -24,7 +24,7 @@ import java.io.Serializable;
/**
* Interface for returning custom properties
*
- * @author: mikeh
+ * @author mikeh
*/
public interface CustomResponse
{
diff --git a/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java b/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java
index 1339067b09..ec2e960e6b 100644
--- a/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java
+++ b/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java
@@ -171,7 +171,7 @@ public class JSONConversionComponent
/**
* Register a property decorator;
*
- * @param propertyDecorator
+ * @param propertyDecorator PropertyDecorator
*/
public void registerPropertyDecorator(PropertyDecorator propertyDecorator)
{
@@ -219,10 +219,9 @@ public class JSONConversionComponent
/**
*
- * @param nodeInfo
- * @param rootJSONObject
- * @param useShortQNames
- * @throws JSONException
+ * @param nodeInfo FileInfo
+ * @param rootJSONObject JSONObject
+ * @param useShortQNames boolean
*/
@SuppressWarnings("unchecked")
protected void setRootValues(final FileInfo nodeInfo, final JSONObject rootJSONObject, final boolean useShortQNames)
@@ -277,9 +276,8 @@ public class JSONConversionComponent
/**
* Handles the work of converting node permissions to JSON.
*
- * @param nodeRef
- * @return
- * @throws JSONException
+ * @param nodeRef NodeRef
+ * @return JSONObject
*/
@SuppressWarnings("unchecked")
protected JSONObject permissionsToJSON(final NodeRef nodeRef)
@@ -297,8 +295,8 @@ public class JSONConversionComponent
/**
* Handles the work of converting user permissions to JSON.
*
- * @param nodeRef
- * @return
+ * @param nodeRef NodeRef
+ * @return JSONObject
*/
@SuppressWarnings("unchecked")
protected JSONObject userPermissionsToJSON(final NodeRef nodeRef)
@@ -315,10 +313,10 @@ public class JSONConversionComponent
/**
* Handles the work of converting values to JSON.
*
- * @param nodeRef
- * @param propertyName
- * @param key
- * @param value
+ * @param nodeRef NodeRef
+ * @param propertyName QName
+ * @param key String
+ * @param value Serializable
* @return the JSON value
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@@ -374,11 +372,10 @@ public class JSONConversionComponent
/**
*
- * @param nodeRef
- * @param properties
- * @param useShortQNames
- * @return
- * @throws JSONException
+ * @param nodeRef NodeRef
+ * @param properties Map
+ * @param useShortQNames boolean
+ * @return JSONObject
*/
@SuppressWarnings("unchecked")
protected JSONObject propertiesToJSON(NodeRef nodeRef, Map properties, boolean useShortQNames)
@@ -408,10 +405,9 @@ public class JSONConversionComponent
/**
* Handles the work of converting aspects to JSON.
*
- * @param nodeRef
- * @param useShortQNames
- * @return
- * @throws JSONException
+ * @param nodeRef NodeRef
+ * @param useShortQNames boolean
+ * @return JSONArray
*/
@SuppressWarnings("unchecked")
protected JSONArray apsectsToJSON(NodeRef nodeRef, boolean useShortQNames)
@@ -430,8 +426,8 @@ public class JSONConversionComponent
/**
* Handles the work of converting all set permissions to JSON.
*
- * @param nodeRef
- * @return
+ * @param nodeRef NodeRef
+ * @return JSONArray
*/
@SuppressWarnings("unchecked")
protected JSONArray allSetPermissionsToJSON(NodeRef nodeRef)
@@ -455,8 +451,8 @@ public class JSONConversionComponent
/**
* Convert a qname to a string - either full or short prefixed named.
*
- * @param qname
- * @param isShortName
+ * @param qname QName
+ * @param isShortName boolean
* @return qname string.
*/
private String nameToString(final QName qname, final boolean isShortName)
@@ -485,8 +481,8 @@ public class JSONConversionComponent
/**
* Return true if the node is locked.
*
- * @param nodeRef
- * @return
+ * @param nodeRef NodeRef
+ * @return boolean
*/
private boolean isLocked(final NodeRef nodeRef)
{
diff --git a/source/java/org/alfresco/repo/jscript/app/VtiServerCustomResponse.java b/source/java/org/alfresco/repo/jscript/app/VtiServerCustomResponse.java
index 6b422ff8c4..4b412c6bee 100644
--- a/source/java/org/alfresco/repo/jscript/app/VtiServerCustomResponse.java
+++ b/source/java/org/alfresco/repo/jscript/app/VtiServerCustomResponse.java
@@ -31,7 +31,7 @@ import java.util.Map;
/**
* Return current state of VTI (SharePoint) Server module
*
- * @author: mikeh
+ * @author mikeh
*/
public class VtiServerCustomResponse implements CustomResponse
{
@@ -59,7 +59,7 @@ public class VtiServerCustomResponse implements CustomResponse
/**
* Setter for sysAdminParams
*
- * @param sysAdminParams
+ * @param sysAdminParams SysAdminParams
*/
public void setSysAdminParams(SysAdminParams sysAdminParams)
{
@@ -69,7 +69,7 @@ public class VtiServerCustomResponse implements CustomResponse
/**
* Setter for vtiServer Port
*
- * @param vtiServerPort
+ * @param vtiServerPort int
*/
public void setPort(int vtiServerPort)
{
@@ -79,7 +79,7 @@ public class VtiServerCustomResponse implements CustomResponse
/**
* Setter for vtiServer Host
*
- * @param vtiServerHost
+ * @param vtiServerHost String
*/
public void setHost(String vtiServerHost)
{
@@ -89,7 +89,7 @@ public class VtiServerCustomResponse implements CustomResponse
/**
* Setter for vtiServer Protocol
*
- * @param vtiServerProtocol
+ * @param vtiServerProtocol String
*/
public void setProtocol(String vtiServerProtocol)
{
@@ -99,7 +99,7 @@ public class VtiServerCustomResponse implements CustomResponse
/**
* Setter for the vtiServer (external) context path.
*
- * @param contextPath
+ * @param contextPath String
*/
public void setContextPath(String contextPath)
{
diff --git a/source/java/org/alfresco/repo/lock/JobLockServiceImpl.java b/source/java/org/alfresco/repo/lock/JobLockServiceImpl.java
index c3c16b7c03..474e3a1b2e 100644
--- a/source/java/org/alfresco/repo/lock/JobLockServiceImpl.java
+++ b/source/java/org/alfresco/repo/lock/JobLockServiceImpl.java
@@ -38,8 +38,7 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
- * {@inheritDoc JobLockService}
- *
+ *
* @author Derek Hulley
* @since 3.2
*/
diff --git a/source/java/org/alfresco/repo/lock/LockServiceImpl.java b/source/java/org/alfresco/repo/lock/LockServiceImpl.java
index b7f4258fdc..9c29f6f262 100644
--- a/source/java/org/alfresco/repo/lock/LockServiceImpl.java
+++ b/source/java/org/alfresco/repo/lock/LockServiceImpl.java
@@ -265,40 +265,40 @@ public class LockServiceImpl implements LockService,
return ignoreNodeRefs.contains(nodeRef);
}
return false;
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType)
- */
- public void lock(NodeRef nodeRef, LockType lockType)
- {
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType)
+ */
+ public void lock(NodeRef nodeRef, LockType lockType)
+ {
// Lock with no expiration
lock(nodeRef, lockType, 0);
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int)
- */
- @Override
- public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire)
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int)
+ */
+ @Override
+ public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire)
{
lock(nodeRef, lockType, timeToExpire, Lifetime.PERSISTENT);
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, Lifetime, String)
- */
- @Override
- public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime)
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, Lifetime, String)
+ */
+ @Override
+ public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime)
{
lock(nodeRef, lockType, timeToExpire, lifetime, null);
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, Lifetime, String)
- */
- @Override
- public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime, String additionalInfo)
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, Lifetime, String)
+ */
+ @Override
+ public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime, String additionalInfo)
{
invokeBeforeLock(nodeRef, lockType);
if (lifetime.equals(Lifetime.EPHEMERAL) && (timeToExpire > MAX_EPHEMERAL_LOCK_SECONDS))
@@ -411,13 +411,13 @@ public class LockServiceImpl implements LockService,
expiryDate = calendar.getTime();
}
return expiryDate;
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, boolean)
- */
- public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, boolean lockChildren)
- throws UnableToAquireLockException
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockType, int, boolean)
+ */
+ public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, boolean lockChildren)
+ throws UnableToAquireLockException
{
lock(nodeRef, lockType, timeToExpire);
@@ -429,26 +429,26 @@ public class LockServiceImpl implements LockService,
lock(childAssocRef.getChildRef(), lockType, timeToExpire, lockChildren);
}
}
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#lock(java.util.Collection, org.alfresco.service.cmr.lock.LockType, int)
- */
- public void lock(Collection nodeRefs, LockType lockType, int timeToExpire)
- throws UnableToAquireLockException
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#lock(java.util.Collection, org.alfresco.service.cmr.lock.LockType, int)
+ */
+ public void lock(Collection nodeRefs, LockType lockType, int timeToExpire)
+ throws UnableToAquireLockException
{
// Lock each of the specifed nodes
for (NodeRef nodeRef : nodeRefs)
{
lock(nodeRef, lockType, timeToExpire);
}
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#unlock(NodeRef)
- */
- @Override
- public void unlock(NodeRef nodeRef) throws UnableToReleaseLockException
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#unlock(NodeRef)
+ */
+ @Override
+ public void unlock(NodeRef nodeRef) throws UnableToReleaseLockException
{
unlock(nodeRef, false, false);
}
@@ -460,13 +460,13 @@ public class LockServiceImpl implements LockService,
public void unlock(NodeRef nodeRef, boolean lockChildren) throws UnableToReleaseLockException
{
unlock(nodeRef, lockChildren, false);
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#unlock(NodeRef, boolean, boolean)
- */
- @Override
- public void unlock(NodeRef nodeRef, boolean unlockChildren, boolean allowCheckedOut)
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#unlock(NodeRef, boolean, boolean)
+ */
+ @Override
+ public void unlock(NodeRef nodeRef, boolean unlockChildren, boolean allowCheckedOut)
throws UnableToReleaseLockException
{
// Unlock the parent
@@ -525,13 +525,13 @@ public class LockServiceImpl implements LockService,
unlock(childAssocRef.getChildRef(), unlockChildren);
}
}
- }
-
- /**
- * @see org.alfresco.service.cmr.lock.LockService#unlock(Collection)
- */
- public void unlock(Collection nodeRefs) throws UnableToReleaseLockException
- {
+ }
+
+ /**
+ * @see org.alfresco.service.cmr.lock.LockService#unlock(Collection)
+ */
+ public void unlock(Collection nodeRefs) throws UnableToReleaseLockException
+ {
for (NodeRef nodeRef : nodeRefs)
{
unlock(nodeRef);
@@ -736,12 +736,12 @@ public class LockServiceImpl implements LockService,
private String getUserName()
{
return this.authenticationService.getCurrentUserName();
- }
-
- /**
- * @deprecated Uses search and does not report on ephemeral locks.
- */
- @Deprecated
+ }
+
+ /**
+ * @deprecated Uses search and does not report on ephemeral locks.
+ */
+ @Deprecated
public List getLocks(StoreRef storeRef)
{
return getLocks(
@@ -779,12 +779,12 @@ public class LockServiceImpl implements LockService,
}
}
return result;
- }
-
- /**
- * @deprecated Uses search and does not report on ephemeral locks.
- */
- @Deprecated
+ }
+
+ /**
+ * @deprecated Uses search and does not report on ephemeral locks.
+ */
+ @Deprecated
public List getLocks(StoreRef storeRef, LockType lockType)
{
return getLocks(
diff --git a/source/java/org/alfresco/repo/lock/LockServicePolicies.java b/source/java/org/alfresco/repo/lock/LockServicePolicies.java
index dbc5ede72e..7bd18b43f4 100644
--- a/source/java/org/alfresco/repo/lock/LockServicePolicies.java
+++ b/source/java/org/alfresco/repo/lock/LockServicePolicies.java
@@ -42,8 +42,8 @@ public interface LockServicePolicies
/**
* Called before an attempt to lock the given node is made.
*
- * @param nodeRef
- * @param lockType
+ * @param nodeRef NodeRef
+ * @param lockType LockType
*/
void beforeLock(
NodeRef nodeRef,
diff --git a/source/java/org/alfresco/repo/lock/mem/LockState.java b/source/java/org/alfresco/repo/lock/mem/LockState.java
index 98120bd10c..d42cf6f974 100644
--- a/source/java/org/alfresco/repo/lock/mem/LockState.java
+++ b/source/java/org/alfresco/repo/lock/mem/LockState.java
@@ -44,13 +44,14 @@ public final class LockState implements Serializable
/**
* Constructor.
*
- * @param nodeRef
- * @param lockType
- * @param owner
- * @param expires
- * @param additionalInfo
- */
- private LockState(NodeRef nodeRef, LockType lockType, String owner, Date expires,
+ * @param nodeRef NodeRef
+ * @param lockType LockType
+ * @param owner String
+ * @param expires Date
+ * @param lifetime Lifetime
+ * @param additionalInfo String
+ */
+ private LockState(NodeRef nodeRef, LockType lockType, String owner, Date expires,
Lifetime lifetime, String additionalInfo)
{
this.nodeRef = nodeRef;
@@ -127,13 +128,13 @@ public final class LockState implements Serializable
return new LockState(nodeRef, null, null, null, null, null);
}
- /**
- * Returns whether this {@link LockState} is for a lock or whether there is no
- * lock defined for the node. If a lock is defined for a node, that does not mean that
- * the node is locked - the {@link org.alfresco.service.cmr.lock.LockService} must be used to determine that.
- *
- * @return true if there is a lock defined for the node.
- */
+ /**
+ * Returns whether this {@link LockState} is for a lock or whether there is no
+ * lock defined for the node. If a lock is defined for a node, that does not mean that
+ * the node is locked - the {@link org.alfresco.service.cmr.lock.LockService} must be used to determine that.
+ *
+ * @return true if there is a lock defined for the node.
+ */
public boolean isLockInfo()
{
return (lockType != null);
diff --git a/source/java/org/alfresco/repo/lock/mem/LockStoreImpl.java b/source/java/org/alfresco/repo/lock/mem/LockStoreImpl.java
index 4e9994ee69..faacfdf7c4 100644
--- a/source/java/org/alfresco/repo/lock/mem/LockStoreImpl.java
+++ b/source/java/org/alfresco/repo/lock/mem/LockStoreImpl.java
@@ -45,7 +45,7 @@ public class LockStoreImpl extends AbstractLockStoreisLockProperty(propQName) == true.
*
- * @param properties
+ * @param properties Map
* @return filtered properties.
*/
private Map filterLockProperties(Map properties)
diff --git a/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java b/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java
index 360e46e3b4..c059d341eb 100644
--- a/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java
+++ b/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java
@@ -231,7 +231,7 @@ public class AlfrescoJavaMailSender extends JavaMailSenderImpl
}
/**
- * @return A new {@link PooledTransportWrapper} which borrows a pooled {@link Transport} on connect, and returns it to
+ * @return A new {@code PooledTransportWrapper} which borrows a pooled {@link Transport} on connect, and returns it to
* the pool on close.
*/
@Override
diff --git a/source/java/org/alfresco/repo/management/JmxDumpUtil.java b/source/java/org/alfresco/repo/management/JmxDumpUtil.java
index 92347bcb10..406b9b4040 100644
--- a/source/java/org/alfresco/repo/management/JmxDumpUtil.java
+++ b/source/java/org/alfresco/repo/management/JmxDumpUtil.java
@@ -164,7 +164,7 @@ public class JmxDumpUtil
* Adds a Linux version
*
* @param osName os.name attribute
- * @return
+ * @return String
*/
public static String updateOSNameAttributeForLinux(String osName)
{
diff --git a/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java b/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java
index 71c9575350..08c51ede58 100644
--- a/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java
+++ b/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java
@@ -94,8 +94,6 @@ public class SafeApplicationEventMulticaster implements ApplicationEventMulticas
* context (class loader, transaction association) unless the TaskExecutor
* explicitly supports this.
*
- * @see org.springframework.core.task.SyncTaskExecutor
- * @see org.springframework.core.task.SimpleAsyncTaskExecutor
*/
public void setTaskExecutor(Executor taskExecutor)
{
diff --git a/source/java/org/alfresco/repo/management/subsystems/CryptodocSwitchableApplicationContextFactory.java b/source/java/org/alfresco/repo/management/subsystems/CryptodocSwitchableApplicationContextFactory.java
index 9be4a3d73f..5b4a45bc49 100644
--- a/source/java/org/alfresco/repo/management/subsystems/CryptodocSwitchableApplicationContextFactory.java
+++ b/source/java/org/alfresco/repo/management/subsystems/CryptodocSwitchableApplicationContextFactory.java
@@ -89,7 +89,7 @@ public class CryptodocSwitchableApplicationContextFactory extends SwitchableAppl
/**
* The bean name of the unencrypted ContentStore subsystem.
*
- * @param unencryptedContentStoreBeanName
+ * @param unencryptedContentStoreBeanName String
*/
public void setUnencryptedContentStoreBeanName(String unencryptedContentStoreBeanName)
{
diff --git a/source/java/org/alfresco/repo/management/subsystems/DefaultChildApplicationContextManager.java b/source/java/org/alfresco/repo/management/subsystems/DefaultChildApplicationContextManager.java
index c222666dd6..a04b1a8534 100644
--- a/source/java/org/alfresco/repo/management/subsystems/DefaultChildApplicationContextManager.java
+++ b/source/java/org/alfresco/repo/management/subsystems/DefaultChildApplicationContextManager.java
@@ -44,7 +44,7 @@ import org.springframework.context.ApplicationContext;
* this property is editable at runtime via JMX. If a new <id> is included in the list then a new
* {@link ChildApplicationContextFactory} will be brought into existence. Similarly, if one is removed from the list,
* then the corresponding instance will be destroyed. For Alfresco community edition, the chain is best configured
- * through the {@link #setChain(String)} method via Spring configuration.
+ * through the method via Spring configuration.
*
* @author dward
*/
diff --git a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java
index b5ff693d4a..4c028ab808 100644
--- a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java
+++ b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java
@@ -69,17 +69,17 @@ public interface PropertyBackedBean extends PropertyBackedBeanState
* confirmed to the entire cluster with {@link #start()}, presumably after persistence of the new state has been
* completed.
*
- * @param properties
+ * @param properties Map
*/
public void setProperties(Map properties);
/**
* Tries removing the given properties on this component. Will leave the component in a started state consisting of
* the new properties if they are valid, or the previous state otherwise. Note that the new state still has to be
- * confirmed to the entire cluster with {@link #start()}, presumably after persistence of the new state has been
- * completed.
- *
- * @param attributes
- */
- public void removeProperties(Collection attributes);
-}
+ * confirmed to the entire cluster with {@link #start()}, presumably after persistence of the new state has been
+ * completed.
+ *
+ * @param attributes Collection
+ */
+ public void removeProperties(Collection attributes);
+}
diff --git a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanRegistry.java b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanRegistry.java
index d953f0372c..bc00db44e0 100644
--- a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanRegistry.java
+++ b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanRegistry.java
@@ -51,7 +51,7 @@ public interface PropertyBackedBeanRegistry
public void register(PropertyBackedBean bean);
/**
- * Signals that {@link PropertyBackedBean#destroy(boolean)} has been called on a bean.
+ * Signals the {@link PropertyBackedBeanUnregisteredEvent} event.
*
* @param bean
* the bean
diff --git a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanState.java b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanState.java
index 1c95968ce0..d82c735210 100644
--- a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanState.java
+++ b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanState.java
@@ -49,8 +49,7 @@ public interface PropertyBackedBeanState
public String getProperty(String name);
/**
- * Sets the value of a property. This may only be called after {@link #stop()} and should only be called for
- * property names for which the {@link #isUpdateable(String)} method returns true.
+ * Sets the value of a property. This may only be called after {@link #stop()}.
*
* @param name
* the property name
@@ -60,8 +59,7 @@ public interface PropertyBackedBeanState
public void setProperty(String name, String value);
/**
- * Removes a property. This may only be called after {@link #stop()} and should only be called for
- * property names for which the {@link #isUpdateable(String)} method returns true.
+ * Removes a property. This may only be called after {@link #stop()}.
*
* @param name
* the property name
diff --git a/source/java/org/alfresco/repo/model/Repository.java b/source/java/org/alfresco/repo/model/Repository.java
index 016218fcb4..55ba62cf44 100644
--- 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)
{
diff --git a/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java b/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java
index 94d448aeb2..9a9017a1b9 100644
--- 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 listImpl(NodeRef contextNodeRef, String pattern, Set searchTypeQNames, Set ignoreAspectQNames, List> 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
*/
/*
@@ -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
{
diff --git a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java
index 564870a2d6..b9d287a2c4 100644
--- 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
*
* 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
*/
diff --git a/source/java/org/alfresco/repo/model/ml/EmptyTranslationAspect.java b/source/java/org/alfresco/repo/model/ml/EmptyTranslationAspect.java
index 4b2e9a947a..18195ed061 100644
--- 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)
{
diff --git a/source/java/org/alfresco/repo/module/LoggerModuleComponent.java b/source/java/org/alfresco/repo/module/LoggerModuleComponent.java
index 76ca760031..80b6791d5f 100644
--- a/source/java/org/alfresco/repo/module/LoggerModuleComponent.java
+++ b/source/java/org/alfresco/repo/module/LoggerModuleComponent.java
@@ -50,8 +50,8 @@ public class LoggerModuleComponent extends AbstractModuleComponent
/**
* Set the level at which the bean must log the message.
- * @param logLevel One of the {@link LogLevel values}.
- * The default is {@link LogLevel#INFO}.
+ * @param logLevel One of the {@code LogLevel} values.
+ * The default is {@code LogLevel#INFO}.
*/
public void setLogLevel(String logLevel)
{
diff --git a/source/java/org/alfresco/repo/module/ModuleComponentHelper.java b/source/java/org/alfresco/repo/module/ModuleComponentHelper.java
index ec2de59426..28f7ae6e93 100644
--- a/source/java/org/alfresco/repo/module/ModuleComponentHelper.java
+++ b/source/java/org/alfresco/repo/module/ModuleComponentHelper.java
@@ -193,9 +193,6 @@ public class ModuleComponentHelper
}
}
- /**
- * {@inheritDoc}
- */
public synchronized void startModules()
{
// Check properties
@@ -327,9 +324,6 @@ public class ModuleComponentHelper
}, AuthenticationUtil.getSystemUserName());
}
- /**
- * {@inheritDoc}
- */
public synchronized void shutdownModules()
{
// Check properties
@@ -364,7 +358,7 @@ public class ModuleComponentHelper
/**
* Checks that all components have been executed or considered for execution.
- * @param executedComponents
+ * @param executedComponents Set
*/
private void checkForOrphanComponents(Set executedComponents)
{
@@ -420,8 +414,8 @@ public class ModuleComponentHelper
/**
* Returns the version number of a module from the Registry.
*
- * @param moduleId
- * @return
+ * @param moduleId String
+ * @return ModuleVersionNumber
*/
ModuleVersionNumber getVersion(String moduleId)
{
diff --git a/source/java/org/alfresco/repo/module/ModuleDetailsImpl.java b/source/java/org/alfresco/repo/module/ModuleDetailsImpl.java
index 658eca06b4..b333ebc671 100644
--- a/source/java/org/alfresco/repo/module/ModuleDetailsImpl.java
+++ b/source/java/org/alfresco/repo/module/ModuleDetailsImpl.java
@@ -77,7 +77,6 @@ public class ModuleDetailsImpl implements ModuleDetails
* whitespace strings are not supported.
*
* @param properties the set of properties
- * @Throws AlfrescoRuntimeException if unable to parse values
*/
public ModuleDetailsImpl(Properties properties)
{
@@ -444,11 +443,11 @@ public class ModuleDetailsImpl implements ModuleDetails
/**
* Grateful received from Apache Commons StringUtils class
*
- * @param array
- * @param separator
- * @param startIndex
- * @param endIndex
- * @return
+ * @param array Object[]
+ * @param separator char
+ * @param startIndex int
+ * @param endIndex int
+ * @return String
*/
private static String join(Object[] array, char separator, int startIndex, int endIndex) {
if (array == null) {
diff --git a/source/java/org/alfresco/repo/module/tool/WarHelper.java b/source/java/org/alfresco/repo/module/tool/WarHelper.java
index f7e0daacbb..dfb7645a1e 100644
--- a/source/java/org/alfresco/repo/module/tool/WarHelper.java
+++ b/source/java/org/alfresco/repo/module/tool/WarHelper.java
@@ -21,15 +21,15 @@ public interface WarHelper
/**
* Gets the module details or an available alias
* @param war a valid war file or exploded directory from a war
- * @param installingModuleDetails
+ * @param installingModuleDetails ModuleDetails
* @return ModuleDetails
*/
public ModuleDetails getModuleDetailsOrAlias(TFile war, ModuleDetails installingModuleDetails);
/**
* Checks the dependencies of this module
- * @param war
- * @param installingModuleDetails
+ * @param war TFile
+ * @param installingModuleDetails ModuleDetails
*/
public void checkModuleDependencies(TFile war, ModuleDetails installingModuleDetails);
@@ -45,7 +45,7 @@ public interface WarHelper
* If not module edition is specfied then it will just return. However, if an edition is specified and it doesn't match
* then an error is thrown.
* @param war a valid war file or exploded directory from a war
- * @param installingModuleDetails
+ * @param installingModuleDetails ModuleDetails
*/
public void checkCompatibleEdition(TFile war, ModuleDetails installingModuleDetails);
@@ -54,7 +54,7 @@ public interface WarHelper
* Returns true if the Share war manifest states its a share war.
* @since 3.4.11,4.1.1,Community 4.2
*
- * @param war
+ * @param war TFile
* @return boolean - true if it is a share war
*/
public boolean isShareWar(TFile war);
diff --git a/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java b/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java
index a0e0d97294..dc1cd81206 100644
--- a/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java
+++ b/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java
@@ -69,8 +69,8 @@ public class WarHelperImpl implements WarHelper
/**
* Checks if the module is compatible using the entry in the manifest. This is more accurate and works for both alfresco.war and share.war, however
* valid manifest entries weren't added until 3.4.11, 4.1.1 and Community 4.2
- * @param war
- * @param installingModuleDetails
+ * @param war TFile
+ * @param installingModuleDetails ModuleDetails
*/
protected void checkCompatibleVersionUsingManifest(TFile war, ModuleDetails installingModuleDetails)
{
@@ -149,9 +149,9 @@ public class WarHelperImpl implements WarHelper
/**
* Compares the version information with the module details to see if their valid. If they are invalid then it throws an exception.
- * @param warVersion
- * @param installingModuleDetails
- * @throws ModuleManagementToolException/home/gethin/development/projects/updatetool/code/update-tool
+ * @param warVersion VersionNumber
+ * @param installingModuleDetails ModuleDetails
+ * @throws ModuleManagementToolException
*/
private void checkVersions(VersionNumber warVersion, ModuleDetails installingModuleDetails) throws ModuleManagementToolException
{
@@ -198,8 +198,8 @@ public class WarHelperImpl implements WarHelper
* Checks to see if the module that is being installed is compatible with the war, (using the entry in the manifest).
* This is more accurate and works for both alfresco.war and share.war, however
* valid manifest entries weren't added until 3.4.11, 4.1.1 and Community 4.2
- * @param war
- * @param installingModuleDetails
+ * @param war TFile
+ * @param installingModuleDetails ModuleDetails
*/
public void checkCompatibleEditionUsingManifest(TFile war, ModuleDetails installingModuleDetails)
{
@@ -381,8 +381,8 @@ public class WarHelperImpl implements WarHelper
/**
* Gets the module details for the specified module from the war.
* @param war a valid war file or exploded directory from a war
- * @param moduleId
- * @return
+ * @param moduleId String
+ * @return ModuleDetails
*/
protected ModuleDetails getModuleDetails(TFile war, String moduleId)
{
diff --git a/source/java/org/alfresco/repo/node/MLPropertyInterceptor.java b/source/java/org/alfresco/repo/node/MLPropertyInterceptor.java
index 51b58c43e3..feafbc0eca 100644
--- a/source/java/org/alfresco/repo/node/MLPropertyInterceptor.java
+++ b/source/java/org/alfresco/repo/node/MLPropertyInterceptor.java
@@ -53,13 +53,12 @@ import org.springframework.extensions.surf.util.I18NUtil;
* transform to multilingual text for setter methods.
*
* This interceptor ensures that all multilingual (ML) text is transformed to the
- * locale chosen {@link org.alfresco.service.cmr.repository.MLText#getContextLocale() for the request}
+ * locale chosen for the request
* for getters and transformed to the default locale type for setters.
*
* Where {@link org.alfresco.service.cmr.repository.MLText ML text} has been passed in, this
* will be allowed to pass.
*
- * @see org.alfresco.service.cmr.repository.MLText#getContextLocale()
* @see org.alfresco.service.cmr.repository.NodeService#getProperty(NodeRef, QName)
* @see org.alfresco.service.cmr.repository.NodeService#getProperties(NodeRef)
* @see org.alfresco.service.cmr.repository.NodeService#setProperty(NodeRef, QName, Serializable)
@@ -478,8 +477,8 @@ public class MLPropertyInterceptor implements MethodInterceptor
}
/**
- * @param outboundValue
- * @return
+ * @param outboundValue Serializable
+ * @return boolean
*/
private boolean isCollectionOfMLText(Serializable outboundValue)
{
@@ -684,9 +683,9 @@ public class MLPropertyInterceptor implements MethodInterceptor
* with updatedText keyed by the language of contentLocale. This ensures that the mlText
* will have no more than one entry for the particular language.
*
- * @param contentLocale
- * @param updatedText
- * @param mlText
+ * @param contentLocale Locale
+ * @param updatedText String
+ * @param mlText MLText
*/
private void replaceTextForLanguage(Locale contentLocale, String updatedText, MLText mlText)
{
diff --git a/source/java/org/alfresco/repo/node/NodeRefPropertyMethodInterceptor.java b/source/java/org/alfresco/repo/node/NodeRefPropertyMethodInterceptor.java
index 81a4320453..4d501506b6 100644
--- a/source/java/org/alfresco/repo/node/NodeRefPropertyMethodInterceptor.java
+++ b/source/java/org/alfresco/repo/node/NodeRefPropertyMethodInterceptor.java
@@ -280,9 +280,9 @@ public class NodeRefPropertyMethodInterceptor implements MethodInterceptor
* Remove unknown node ref values Remove unknowen categories - the node will be removed if it does exist and it is
* not a category
*
- * @param propertyQName
- * @param inboundValue
- * @return
+ * @param propertyQName QName
+ * @param inboundValue Serializable
+ * @return Serializable
*/
private Serializable getValue(QName propertyQName, Serializable inboundValue)
{
diff --git a/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryFactory.java b/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryFactory.java
index 1fe1d2452a..74863cf295 100644
--- a/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryFactory.java
+++ b/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryFactory.java
@@ -45,11 +45,12 @@ public class GetArchivedNodesCannedQueryFactory extends AbstractQNameAwareCanned
}
/**
- * @param archiveStoreRootNodeRef
- * @param filter
- * @param filterIgnoreCase
- * @param pagingRequest
- * @param sortOrderAscending
+ * @param archiveStoreRootNodeRef NodeRef
+ * @param assocTypeQName QName
+ * @param filter String
+ * @param filterIgnoreCase boolean
+ * @param pagingRequest PagingRequest
+ * @param sortOrderAscending boolean
* @return an implementation that will execute the query
*/
public CannedQuery getCannedQuery(NodeRef archiveStoreRootNodeRef, QName assocTypeQName,
diff --git a/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryParams.java b/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryParams.java
index 2d9bee2191..863e592b59 100644
--- a/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryParams.java
+++ b/source/java/org/alfresco/repo/node/archive/GetArchivedNodesCannedQueryParams.java
@@ -31,12 +31,13 @@ public class GetArchivedNodesCannedQueryParams extends ArchivedNodeEntity
private int limit;
/**
- * @param parentNodeId
- * @param assocTypeQNameId
- * @param filter
- * @param filterIgnoreCase
- * @param nameQNameId
- * @param sortOrderAscending
+ *
+ * @param parentNodeId Long
+ * @param assocTypeQNameId Long
+ * @param filter String
+ * @param filterIgnoreCase Boolean
+ * @param nameQNameId Long
+ * @param sortOrderAscending Boolean
*/
public GetArchivedNodesCannedQueryParams(Long parentNodeId, Long assocTypeQNameId,
String filter, Boolean filterIgnoreCase, Long nameQNameId,
diff --git a/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java b/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java
index 8ee9fad451..17f41dba40 100644
--- a/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java
+++ b/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java
@@ -37,13 +37,13 @@ public interface NodeArchiveService
/** Static 'sys:archivedItem' path for all archived nodes. */
public static final QName QNAME_ARCHIVED_ITEM = QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, "archivedItem");
- /**
- * Get the parent node that holds all nodes archived from the given store.
- *
- * @param originalStoreRef the original store of the archived nodes. This is the
- * store where the currently archived nodes could originally be found.
- * @return Returns the parent of the archived nodes, or null if archiving
- * is not configured for the store
+ /**
+ * Get the parent node that holds all nodes archived from the given store.
+ *
+ * @param originalStoreRef the original store of the archived nodes. This is the
+ * store where the currently archived nodes could originally be found.
+ * @return Returns the parent of the archived nodes, or null if archiving
+ * is not configured for the store
*/
public NodeRef getStoreArchiveNode(StoreRef originalStoreRef);
@@ -192,7 +192,7 @@ public interface NodeArchiveService
/**
* Check if the current user has authority to access the archived node.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return true if the currently authenticated user has authority to access
* the archived node, otherwise false.
*/
diff --git a/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java b/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java
index a51472359e..abb0a99c04 100644
--- a/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java
+++ b/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java
@@ -233,7 +233,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
/**
* Defers to the typed service
- * @see StoreDaoService#createWorkspace(String)
*/
public StoreRef createStore(String protocol, String identifier)
{
@@ -798,9 +797,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
}
}
- /**
- * @see Node#countChildAssocs()
- */
public int countChildAssocs(NodeRef nodeRef, boolean isPrimary) throws InvalidNodeRefException
{
final Pair nodePair = getNodePairNotNull(nodeRef);
@@ -1582,7 +1578,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
* Gets the properties map, sets the value (null is allowed) and checks that the new set
* of properties is valid.
*
- * @see DbNodeServiceImpl#NullPropertyValue
*/
public void setProperty(NodeRef nodeRef, QName qname, Serializable value) throws InvalidNodeRefException
{
@@ -1631,7 +1626,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
* If any of the values are null, a marker object is put in to mimic nulls. They will be turned back into
* a real nulls when the properties are requested again.
*
- * @see Node#getProperties(boolean)
*/
public void setProperties(NodeRef nodeRef, Map properties) throws InvalidNodeRefException
{
@@ -2272,7 +2266,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
/**
* @see #getPaths(NodeRef, boolean)
- * @see #prependPaths(Node, Path, Collection, Stack, boolean)
*/
public Path getPath(NodeRef nodeRef) throws InvalidNodeRefException
{
@@ -2287,7 +2280,6 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
/**
* When searching for primaryOnly == true, checks that there is exactly
* one path.
- * @see #prependPaths(Node, Path, Collection, Stack, boolean)
*/
public List getPaths(NodeRef nodeRef, boolean primaryOnly) throws InvalidNodeRefException
{
@@ -2317,7 +2309,7 @@ public class DbNodeServiceImpl extends AbstractNodeServiceImpl
* Archive (direct copy) a node hierarchy
*
* @param walker the node hierarchy to archive
- * @param archiveStoreRef
+ * @param archiveStoreRef StoreRef
*/
private void archiveHierarchyImpl(NodeHierarchyWalker walker, StoreRef archiveStoreRef)
{
diff --git a/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java b/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java
index 69cc897109..181f70f0f9 100644
--- a/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java
+++ b/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java
@@ -81,13 +81,13 @@ public class DeletedNodeCleanupWorker extends AbstractNodeCleanupWorker
this.minPurgeAgeMs = ((long) minPurgeAgeDays) * 24L * 3600L * 1000L;
}
- /**
- * Set the purge transaction block size. This determines how many unused transactions are purged in one go.
- *
- * @param purgeSize
- */
- public void setPurgeSize(int purgeSize)
- {
+ /**
+ * Set the purge transaction block size. This determines how many unused transactions are purged in one go.
+ *
+ * @param purgeSize int
+ */
+ public void setPurgeSize(int purgeSize)
+ {
this.purgeSize = purgeSize;
}
diff --git a/source/java/org/alfresco/repo/node/index/AbstractReindexComponent.java b/source/java/org/alfresco/repo/node/index/AbstractReindexComponent.java
index fdd5a2c271..f934016ea8 100644
--- a/source/java/org/alfresco/repo/node/index/AbstractReindexComponent.java
+++ b/source/java/org/alfresco/repo/node/index/AbstractReindexComponent.java
@@ -154,13 +154,13 @@ public abstract class AbstractReindexComponent implements IndexRecovery
logger.warn("Bean property 'authenticationComponent' is no longer required on 'AbstractReindexComponent'.");
}
- /**
- * Set the low-level transaction component to use
- *
- * @param transactionService provide transactions to index each missed transaction
- */
- public void setTransactionService(TransactionServiceImpl transactionService)
- {
+ /**
+ * Set the low-level transaction component to use
+ *
+ * @param transactionService provide transactions to index each missed transaction
+ */
+ public void setTransactionService(TransactionServiceImpl transactionService)
+ {
this.transactionService = transactionService;
}
@@ -749,7 +749,6 @@ public abstract class AbstractReindexComponent implements IndexRecovery
/**
* Callback to notify caller whenever a node has been indexed
*
- * @see
* @author Derek Hulley
* @since 2.1.4
*/
@@ -1239,13 +1238,13 @@ public abstract class AbstractReindexComponent implements IndexRecovery
/**
* Performs indexing off the current thread, which may return quickly if there are threads immediately
* available in the thread pool.
- *
- * Commits are guaranteed to occur in the order in which this reindex jobs are added to the queue.
- *
- * @see #reindexTransaction(Long, boolean)
- * @see #waitForAsynchronousReindexing()
- * @since 2.1.4
- */
+ *
+ * Commits are guaranteed to occur in the order in which this reindex jobs are added to the queue.
+ *
+ * @see #reindexTransaction(Long, boolean)
+ * @see #waitForAsynchronousReindexing()
+ * @since 2.1.4
+ */
protected void reindexTransactionAsynchronously(final List txnIds, final boolean isFull)
{
// Bypass if there is no thread pool
diff --git a/source/java/org/alfresco/repo/node/integrity/AbstractIntegrityEvent.java b/source/java/org/alfresco/repo/node/integrity/AbstractIntegrityEvent.java
index 803a293a36..a926c8bd01 100644
--- a/source/java/org/alfresco/repo/node/integrity/AbstractIntegrityEvent.java
+++ b/source/java/org/alfresco/repo/node/integrity/AbstractIntegrityEvent.java
@@ -127,7 +127,7 @@ public abstract class AbstractIntegrityEvent implements IntegrityEvent
/**
* Gets the node type if the node exists
*
- * @param nodeRef
+ * @param nodeRef NodeRef
* @return Returns the node's type or null if the node no longer exists
*/
protected QName getNodeType(NodeRef nodeRef)
diff --git a/source/java/org/alfresco/repo/node/integrity/IncompleteNodeTagger.java b/source/java/org/alfresco/repo/node/integrity/IncompleteNodeTagger.java
index 15c848f1af..64fd8b09ca 100644
--- a/source/java/org/alfresco/repo/node/integrity/IncompleteNodeTagger.java
+++ b/source/java/org/alfresco/repo/node/integrity/IncompleteNodeTagger.java
@@ -187,7 +187,7 @@ public class IncompleteNodeTagger
* Ensures that this service is registered with the transaction and saves the node
* reference for use (property check) later.
*
- * @param nodeRef
+ * @param nodeRef NodeRef
*/
private Set save(NodeRef nodeRef)
{
@@ -226,8 +226,8 @@ public class IncompleteNodeTagger
* Ensures that this service is registered with the transaction and saves the node
* reference for use (association check) later.
*
- * @param nodeRef
- * @param assocType
+ * @param nodeRef NodeRef
+ * @param assocType QName
*/
private void saveAssoc(NodeRef nodeRef, QName assocType)
{
@@ -536,9 +536,9 @@ public class IncompleteNodeTagger
}
/**
- * @param nodeRef
- * @param assocDef
- * @return
+ * @param nodeRef NodeRef
+ * @param assocDef AssociationDefinition
+ * @return boolean
*/
private boolean checkAssociation(NodeRef nodeRef, AssociationDefinition assocDef)
{
diff --git a/source/java/org/alfresco/repo/node/integrity/IntegrityChecker.java b/source/java/org/alfresco/repo/node/integrity/IntegrityChecker.java
index 359d51a3f1..066ac6b53d 100644
--- a/source/java/org/alfresco/repo/node/integrity/IntegrityChecker.java
+++ b/source/java/org/alfresco/repo/node/integrity/IntegrityChecker.java
@@ -55,7 +55,7 @@ import org.apache.commons.logging.LogFactory;
* In order to fulfill the contract of the interface, this class registers to receive notifications
* pertinent to changes in the node structure. These are then store away in the persistent
* store until the request to
- * {@link org.alfresco.repo.integrity.IntegrityService#checkIntegrity(String) check integrity} is
+ * check integrity is
* made.
*
* In order to ensure registration of these events, the {@link #init()} method must be called.
@@ -73,10 +73,8 @@ import org.apache.commons.logging.LogFactory;
*
* @see #setPolicyComponent(PolicyComponent)
* @see #setDictionaryService(DictionaryService)
- * @see #setIntegrityDaoService(IntegrityDaoService)
* @see #setMaxErrorsPerTransaction(int)
- * @see #setFlushSize(int)
- *
+ *
* @author Derek Hulley
*/
public class IntegrityChecker
@@ -276,7 +274,7 @@ public class IntegrityChecker
/**
* Ensures that this service is registered with the transaction and saves the event
*
- * @param event
+ * @param event IntegrityEvent
*/
@SuppressWarnings("unchecked")
private void save(IntegrityEvent event)
diff --git a/source/java/org/alfresco/repo/oauth1/OAuth1CredentialsStoreServiceImpl.java b/source/java/org/alfresco/repo/oauth1/OAuth1CredentialsStoreServiceImpl.java
index fc0d0327e1..8ed80a6ccc 100644
--- a/source/java/org/alfresco/repo/oauth1/OAuth1CredentialsStoreServiceImpl.java
+++ b/source/java/org/alfresco/repo/oauth1/OAuth1CredentialsStoreServiceImpl.java
@@ -47,9 +47,9 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
* Add or Update OAuth1 Credentials for the current user to the OAuth1
* Credential Store
*
- * @param remoteSystemId
- * @param token
- * @param secret
+ * @param remoteSystemId String
+ * @param token String
+ * @param secret String
* @return OAuth1CredentialsInfo
*/
@@ -77,9 +77,9 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
/**
* Add Shared OAuth1 Credentials to the OAuth1 Credential Store
*
- * @param remoteSystemId
- * @param token
- * @param secret
+ * @param remoteSystemId String
+ * @param token String
+ * @param secret String
* @return OAuth1CredentialsInfo
*/
@Override
@@ -95,10 +95,10 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
}
/**
- * @param exisitingCredentials
- * @param remoteSystemId
- * @param token
- * @param secret
+ * @param exisitingCredentials OAuth1CredentialsInfo
+ * @param remoteSystemId String
+ * @param token String
+ * @param secret String
* @return OAuth1CredentialsInfo
*/
@Override
@@ -132,9 +132,9 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
}
/**
- * @param remoteSystemId
- * @param token
- * @param secret
+ * @param remoteSystemId String
+ * @param token String
+ * @param secret String
* @return OAuth1CredentialsInfo
*/
private OAuth1CredentialsInfo buildPersonalOAuth1CredentialsInfo(String remoteSystemId,
@@ -155,9 +155,9 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
}
/**
- * @param remoteSystemId
- * @param token
- * @param secret
+ * @param remoteSystemId String
+ * @param token String
+ * @param secret String
* @return OAuth1CredentialsInfo
*/
private OAuth1CredentialsInfo buildSharedOAuth1CredentialsInfo(String remoteSystemId,
@@ -174,7 +174,7 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
/**
* Get the current users OAuth1Credentials for the remote systems
*
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return OAuth1CredentialsInfo
*/
@Override
@@ -186,7 +186,7 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
}
/**
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return List
*/
@Override
@@ -204,7 +204,7 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
/**
* Delete the current users OAuth1 Credentials for the remote system
*
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return boolean
*/
@Override
@@ -244,9 +244,9 @@ public class OAuth1CredentialsStoreServiceImpl implements OAuth1CredentialsStore
}
/**
- * @param succeeded
- * @param credentials
- * @return
+ * @param succeeded boolean
+ * @param credentials OAuth1CredentialsInfo
+ * @return OAuth1CredentialsInfo
*/
@Override
public OAuth1CredentialsInfo updateCredentialsAuthenticationSucceeded(boolean succeeded,
diff --git a/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java b/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java
index 5c9d2555b5..4051467061 100644
--- a/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java
+++ b/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java
@@ -47,13 +47,13 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
/**
* Add or Update OAuth2 Credentials for the current user to the OAuth2
* Credential Store
- *
- * @param remoteSystemId
- * @param accessToken
- * @param refreshToken String
- * @param expiresAt
- * @param issuedAt if null, the current Datetime will be used
- * @return OAuth2CredentialsInfo
+ *
+ * @param remoteSystemId String
+ * @param accessToken String
+ * @param refreshToken String
+ * @param expiresAt Date
+ * @param issuedAt if null, the current Datetime will be used
+ * @return OAuth2CredentialsInfo
*/
@Override
public OAuth2CredentialsInfo storePersonalOAuth2Credentials(String remoteSystemId,
@@ -79,11 +79,11 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
/**
* Add Shared OAuth2 Credentials to the OAuth2 Credential Store
*
- * @param remoteSystemId
- * @param accessToken
- * @param refreshToken
- * @param expiresAt
- * @param issuedAt
+ * @param remoteSystemId String
+ * @param accessToken String
+ * @param refreshToken String
+ * @param expiresAt Date
+ * @param issuedAt Date
* @return OAuth2CredentialsInfo
*/
@Override
@@ -99,12 +99,12 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
}
/**
- * @param exisitingCredentials
- * @param remoteSystemId
- * @param accessToken
- * @param refreshToken
- * @param expiresAt
- * @param issuedAt
+ * @param exisitingCredentials OAuth2CredentialsInfo
+ * @param remoteSystemId String
+ * @param accessToken String
+ * @param refreshToken String
+ * @param expiresAt Date
+ * @param issuedAt Date
* @return OAuth2CredentialsInfo
*/
@Override
@@ -147,11 +147,11 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
}
/**
- * @param remoteSystemId
- * @param accessToken
- * @param refreshToken
- * @param expiresAt
- * @param issuedAt
+ * @param remoteSystemId String
+ * @param accessToken String
+ * @param refreshToken String
+ * @param expiresAt Date
+ * @param issuedAt Date
* @return OAuth2CredentialsInfo
*/
private OAuth2CredentialsInfo buildPersonalOAuth2CredentialsInfo(String remoteSystemId,
@@ -181,11 +181,11 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
}
/**
- * @param remoteSystemId
- * @param accessToken
- * @param refreshToken
- * @param expiresAt
- * @param issuedAt
+ * @param remoteSystemId String
+ * @param accessToken String
+ * @param refreshToken String
+ * @param expiresAt Date
+ * @param issuedAt Date
* @return OAuth2CredentialsInfo
*/
private OAuth2CredentialsInfo buildSharedOAuth2CredentialsInfo(String remoteSystemId,
@@ -211,7 +211,7 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
/**
* Get the current users OAuth2Credentials for the remote systems
*
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return OAuth2CredentialsInfo
*/
@Override
@@ -223,7 +223,7 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
}
/**
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return List
*/
@Override
@@ -241,7 +241,7 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
/**
* Delete the current users OAuth2 Credentials for the remote system
*
- * @param remoteSystemId
+ * @param remoteSystemId String
* @return boolean
*/
@Override
@@ -281,9 +281,9 @@ public class OAuth2CredentialsStoreServiceImpl implements OAuth2CredentialsStore
}
/**
- * @param succeeded
- * @param credentials
- * @return
+ * @param succeeded boolean
+ * @param credentials OAuth2CredentialsInfo
+ * @return OAuth2CredentialsInfo
*/
@Override
public OAuth2CredentialsInfo updateCredentialsAuthenticationSucceeded(boolean succeeded,
diff --git a/source/java/org/alfresco/repo/policy/AssociationPolicyDelegate.java b/source/java/org/alfresco/repo/policy/AssociationPolicyDelegate.java
index 7dc6d50acd..f84d16fb14 100644
--- a/source/java/org/alfresco/repo/policy/AssociationPolicyDelegate.java
+++ b/source/java/org/alfresco/repo/policy/AssociationPolicyDelegate.java
@@ -72,7 +72,7 @@ public class AssociationPolicyDelegate
/**
* Ensures the validity of the given assoc type
*
- * @param assocTypeQName
+ * @param assocTypeQName QName
* @throws IllegalArgumentException
*/
private void checkAssocType(QName assocTypeQName) throws IllegalArgumentException
diff --git a/source/java/org/alfresco/repo/policy/BehaviourFilter.java b/source/java/org/alfresco/repo/policy/BehaviourFilter.java
index 987d3d8b49..ff09e151ba 100644
--- a/source/java/org/alfresco/repo/policy/BehaviourFilter.java
+++ b/source/java/org/alfresco/repo/policy/BehaviourFilter.java
@@ -50,7 +50,7 @@ import org.alfresco.service.namespace.QName;
* }
*
*
- * @See org.alfresco.repo.policy.PolicyComponent
+ * @see org.alfresco.repo.policy.PolicyComponent
*
* @author Derek Hulley
*/
diff --git a/source/java/org/alfresco/repo/policy/BehaviourMap.java b/source/java/org/alfresco/repo/policy/BehaviourMap.java
index dd4e509c81..0258958cd6 100644
--- a/source/java/org/alfresco/repo/policy/BehaviourMap.java
+++ b/source/java/org/alfresco/repo/policy/BehaviourMap.java
@@ -85,7 +85,7 @@ import java.util.Map;
/**
* Remove behavior from map
*
- * @param behaviourDefinition
+ * @param behaviourDefinition BehaviourDefinition
*/
public void remove(BehaviourDefinition behaviourDefinition)
{
diff --git a/source/java/org/alfresco/repo/policy/ClassBehaviourIndex.java b/source/java/org/alfresco/repo/policy/ClassBehaviourIndex.java
index 3af61b8e8b..07d797d65d 100644
--- a/source/java/org/alfresco/repo/policy/ClassBehaviourIndex.java
+++ b/source/java/org/alfresco/repo/policy/ClassBehaviourIndex.java
@@ -251,7 +251,7 @@ import org.alfresco.util.LockHelper;
/**
* Remove class behaviour
*
- * @param behaviour
+ * @param behaviour BehaviourDefinition
*/
public void removeClassBehaviour(BehaviourDefinition behaviour)
{
diff --git a/source/java/org/alfresco/repo/policy/PolicyComponent.java b/source/java/org/alfresco/repo/policy/PolicyComponent.java
index 23b618a4d8..5ad5ab6bf2 100644
--- a/source/java/org/alfresco/repo/policy/PolicyComponent.java
+++ b/source/java/org/alfresco/repo/policy/PolicyComponent.java
@@ -211,7 +211,7 @@ public interface PolicyComponent
/**
* Unbind behaviour
*
- * @param definition
+ * @param definition BehaviourDefinition
*/
public void removeClassDefinition(BehaviourDefinition definition);
diff --git a/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java b/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java
index 343a845edc..b5be3cdea3 100644
--- a/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java
+++ b/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java
@@ -84,12 +84,12 @@ public class PolicyComponentImpl implements PolicyComponent
}
/**
- * Construct
- *
- * @param dictionary dictionary service
- */
- public PolicyComponentImpl(DictionaryService dictionary)
- {
+ * Construct
+ *
+ * @param dictionary dictionary service
+ */
+ public PolicyComponentImpl(DictionaryService dictionary)
+ {
this.dictionary = dictionary;
this.registeredPolicies = new HashMap();
}
@@ -98,7 +98,7 @@ public class PolicyComponentImpl implements PolicyComponent
/**
* Sets the behaviour filter
*
- * @param filter
+ * @param filter BehaviourFilter
*/
public void setBehaviourFilter(BehaviourFilter filter)
{
@@ -108,7 +108,7 @@ public class PolicyComponentImpl implements PolicyComponent
/**
* Sets the tenant service
*
- * @param tenantService
+ * @param tenantService TenantService
*/
public void setTenantService(TenantService tenantService)
{
@@ -119,7 +119,7 @@ public class PolicyComponentImpl implements PolicyComponent
/**
* Sets the transaction-based policy invocation handler
*
- * @param factory
+ * @param factory TransactionInvocationHandlerFactory
*/
public void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory)
{
diff --git a/source/java/org/alfresco/repo/policy/PolicyDefinition.java b/source/java/org/alfresco/repo/policy/PolicyDefinition.java
index dc691ab47f..3d7265838b 100644
--- a/source/java/org/alfresco/repo/policy/PolicyDefinition.java
+++ b/source/java/org/alfresco/repo/policy/PolicyDefinition.java
@@ -66,7 +66,7 @@ public interface PolicyDefinition
/**
* Gets Policy Argument definitions for all arguments in order of arguments
- * @return
+ * @return Arg[]
*/
public Arg[] getArguments();
diff --git a/source/java/org/alfresco/repo/policy/PolicyFactory.java b/source/java/org/alfresco/repo/policy/PolicyFactory.java
index 05f6a048dd..4a344374af 100644
--- a/source/java/org/alfresco/repo/policy/PolicyFactory.java
+++ b/source/java/org/alfresco/repo/policy/PolicyFactory.java
@@ -74,20 +74,20 @@ import org.alfresco.service.cmr.repository.StoreRef;
}
- /**
- * Sets the Transaction Invocation Handler
- *
- * @param factory
- */
- protected static void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory)
- {
+ /**
+ * Sets the Transaction Invocation Handler
+ *
+ * @param factory TransactionInvocationHandlerFactory
+ */
+ protected static void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory)
+ {
transactionHandlerFactory = factory;
}
/**
* Sets the Tenant Service
*
- * @param service
+ * @param service TenantService
*/
protected static void setTenantService(TenantService service)
{
@@ -218,13 +218,13 @@ import org.alfresco.service.cmr.repository.StoreRef;
{
private P policyInterface;
- /**
- * Construct
- *
- * @param policyInterface the collection of policy implementations
- */
- public SingleHandler(P policyInterface)
- {
+ /**
+ * Construct
+ *
+ * @param policyInterface the collection of policy implementations
+ */
+ public SingleHandler(P policyInterface)
+ {
this.policyInterface = policyInterface;
}
diff --git a/source/java/org/alfresco/repo/policy/PolicyScope.java b/source/java/org/alfresco/repo/policy/PolicyScope.java
index 34ee2bd502..61c4664dbf 100644
--- a/source/java/org/alfresco/repo/policy/PolicyScope.java
+++ b/source/java/org/alfresco/repo/policy/PolicyScope.java
@@ -127,12 +127,12 @@ public class PolicyScope extends AspectDetails
}
/**
- * Adds a child association
- *
- * @param classRef
- * @param childAssocRef
- */
- public void addChildAssociation(QName classRef, ChildAssociationRef childAssocRef)
+ * Adds a child association
+ *
+ * @param classRef QName
+ * @param childAssocRef ChildAssociationRef
+ */
+ public void addChildAssociation(QName classRef, ChildAssociationRef childAssocRef)
{
if (classRef.equals(this.classRef) == true)
{
@@ -152,9 +152,9 @@ public class PolicyScope extends AspectDetails
/**
*
- * @param classRef
- * @param childAssocRef
- * @param alwaysTraverseAssociation
+ * @param classRef QName
+ * @param childAssocRef ChildAssociationRef
+ * @param alwaysTraverseAssociation boolean
*/
public void addChildAssociation(QName classRef, ChildAssociationRef childAssocRef, boolean alwaysTraverseAssociation)
{
@@ -177,8 +177,8 @@ public class PolicyScope extends AspectDetails
/**
* Get a child association
*
- * @param classRef
- * @return
+ * @param classRef QName
+ * @return List
*/
public List getChildAssociations(QName classRef)
{
@@ -221,9 +221,8 @@ public class PolicyScope extends AspectDetails
/**
* Add an association
*
- * @param classRef
- * @param qname
- * @param nodeAssocRef
+ * @param classRef QName
+ * @param nodeAssocRef AssociationRef
*/
public void addAssociation(QName classRef, AssociationRef nodeAssocRef)
{
@@ -248,8 +247,8 @@ public class PolicyScope extends AspectDetails
/**
* Get associations
*
- * @param classRef
- * @return
+ * @param classRef QName
+ * @return List
*/
public List getAssociations(QName classRef)
{
@@ -390,13 +389,13 @@ public class PolicyScope extends AspectDetails
}
/**
- * Add a child association
- *
- * @param childAssocRef the child assoc reference
- * @param alwaysTraverseAssociation indicates whether the assoc should always be traversed
- */
- protected void addChildAssociation(ChildAssociationRef childAssocRef, boolean alwaysTraverseAssociation)
- {
+ * Add a child association
+ *
+ * @param childAssocRef the child assoc reference
+ * @param alwaysTraverseAssociation indicates whether the assoc should always be traversed
+ */
+ protected void addChildAssociation(ChildAssociationRef childAssocRef, boolean alwaysTraverseAssociation)
+ {
addChildAssociation(childAssocRef);
if (alwaysTraverseAssociation == true)
@@ -427,12 +426,12 @@ public class PolicyScope extends AspectDetails
return this.childAssocs;
}
- /**
- * Adds an association to be copied
- *
- * @param nodeAssocRef the association reference
- */
- protected void addAssociation(AssociationRef nodeAssocRef)
+ /**
+ * Adds an association to be copied
+ *
+ * @param nodeAssocRef the association reference
+ */
+ protected void addAssociation(AssociationRef nodeAssocRef)
{
this.targetAssocs.add(nodeAssocRef);
}
diff --git a/source/java/org/alfresco/repo/policy/PropertyPolicyDelegate.java b/source/java/org/alfresco/repo/policy/PropertyPolicyDelegate.java
index 1cc02cceab..dfe2098619 100644
--- a/source/java/org/alfresco/repo/policy/PropertyPolicyDelegate.java
+++ b/source/java/org/alfresco/repo/policy/PropertyPolicyDelegate.java
@@ -72,7 +72,7 @@ public class PropertyPolicyDelegate
/**
* Ensures the validity of the given property type
*
- * @param propertyQName
+ * @param propertyQName QName
* @throws IllegalArgumentException
*/
private void checkPropertyType(QName propertyQName) throws IllegalArgumentException
diff --git a/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java b/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java
index dfaff72b41..ad35c4810c 100644
--- a/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java
+++ b/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java
@@ -50,12 +50,12 @@ public class TransactionBehaviourQueue implements TransactionListener
/**
* Queue a behaviour for end-of-transaction execution
*
- * @param