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
    +     * @return Object
          */
         protected Object execute(String url, String method, List params)
         {
    diff --git a/source/java/org/alfresco/repo/bulkimport/ContentStoreMapProvider.java b/source/java/org/alfresco/repo/bulkimport/ContentStoreMapProvider.java
    index bd9f66d433..147e691858 100644
    --- a/source/java/org/alfresco/repo/bulkimport/ContentStoreMapProvider.java
    +++ b/source/java/org/alfresco/repo/bulkimport/ContentStoreMapProvider.java
    @@ -38,7 +38,7 @@ public interface ContentStoreMapProvider
     {
     	/**
     	 * Get a map of the currently registered {@link ContentStore}, keyed by store name
    -	 * @return a {@link Map}
    +	 * @return a {@link Map}
     	 */
     	public Map getStoreMap();
     	
    diff --git a/source/java/org/alfresco/repo/bulkimport/FilesystemTracker.java b/source/java/org/alfresco/repo/bulkimport/FilesystemTracker.java
    index a7d4f25177..bdc596c272 100644
    --- a/source/java/org/alfresco/repo/bulkimport/FilesystemTracker.java
    +++ b/source/java/org/alfresco/repo/bulkimport/FilesystemTracker.java
    @@ -37,7 +37,7 @@ public interface FilesystemTracker
     	/**
     	 * An estimate of the number of directories and files in the filesystem.
     	 * 
    -	 * @return
    +	 * @return int
     	 */
     	int count();
     	
    @@ -51,9 +51,9 @@ public interface FilesystemTracker
     	
     	/**
     	 * A callback to indicate that the item has been imported into the repository.
    -	 * 
    -	 * @param nodeRef
    -	 * @param importableItem
    +	 *
    +	 * @param nodeRef NodeRef
    +	 * @param importableItem ImportableItem
     	 */
     	void itemImported(NodeRef nodeRef, ImportableItem importableItem);
     
    diff --git a/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java b/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java
    index c9e91c0dda..0af8501778 100644
    --- a/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java
    +++ b/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java
    @@ -164,11 +164,6 @@ public abstract class AbstractBulkFilesystemImporter implements BulkFilesystemIm
             }
         }
     
    -    /**
    -     * Attempts to get the lock. If it fails, the current transaction is marked for rollback.
    -     * 
    -     * @return Returns the lock token
    -     */
         protected void refreshLock(String lockToken, long time)
         {
             if (lockToken == null)
    diff --git a/source/java/org/alfresco/repo/bulkimport/impl/AbstractNodeImporter.java b/source/java/org/alfresco/repo/bulkimport/impl/AbstractNodeImporter.java
    index 3b61a153a7..9fcd898141 100644
    --- a/source/java/org/alfresco/repo/bulkimport/impl/AbstractNodeImporter.java
    +++ b/source/java/org/alfresco/repo/bulkimport/impl/AbstractNodeImporter.java
    @@ -141,7 +141,7 @@ public abstract class AbstractNodeImporter implements NodeImporter
          * after metadata renames are taken into account.
          * 
          * @param importableItem The importableItem with which to 
    -     * @param metadata
    +     * @param metadata MetadataLoader.Metadata
          * @return the name of the given importable item
          */
         protected final String getImportableItemName(ImportableItem importableItem, MetadataLoader.Metadata metadata)
    diff --git a/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java b/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java
    index a72619156e..44e3df31d9 100644
    --- a/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java
    +++ b/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java
    @@ -140,7 +140,7 @@ public class DirectoryAnalyserImpl implements DirectoryAnalyser
         }
     
         /**
    -     * @see org.alfresco.repo.bulkimport.DirectoryAnalyser#analyseDirectory(java.io.File)
    +     * @see org.alfresco.repo.bulkimport.DirectoryAnalyser#analyseDirectory(ImportableItem, FileFilter)
          */
         public AnalysedDirectory analyseDirectory(ImportableItem directory, FileFilter filter)
         {
    diff --git a/source/java/org/alfresco/repo/bulkimport/impl/stores/AbstractContentStoreMapProvider.java b/source/java/org/alfresco/repo/bulkimport/impl/stores/AbstractContentStoreMapProvider.java
    index ebe795c3a1..ad7cc3aa8c 100644
    --- a/source/java/org/alfresco/repo/bulkimport/impl/stores/AbstractContentStoreMapProvider.java
    +++ b/source/java/org/alfresco/repo/bulkimport/impl/stores/AbstractContentStoreMapProvider.java
    @@ -38,7 +38,7 @@ import org.springframework.extensions.surf.util.AbstractLifecycleBean;
     
     /**
      * Common elements of the role of a {@link ContentStoreMapProvider}.
    - * Extending classes should implement {@link #setUpStoreMap()} to initialize the {@link Map}.
    + * Extending classes should implement {@link #setUpStoreMap()} to initialize the {@link Map}.
      * 
      * @since 4.0
      *
    diff --git a/source/java/org/alfresco/repo/bulkimport/impl/stores/DefaultContentStoreMapProvider.java b/source/java/org/alfresco/repo/bulkimport/impl/stores/DefaultContentStoreMapProvider.java
    index 30b9ecdaaa..f1940837bb 100644
    --- a/source/java/org/alfresco/repo/bulkimport/impl/stores/DefaultContentStoreMapProvider.java
    +++ b/source/java/org/alfresco/repo/bulkimport/impl/stores/DefaultContentStoreMapProvider.java
    @@ -30,7 +30,7 @@ import java.util.HashMap;
     import org.alfresco.repo.content.ContentStore;
     
     /**
    - * Provides a default {@link java.util.Map()} of registered content stores.
    + * Provides a default {@link java.util.Map} of registered content stores.
      * Use when the Content Store Selector is not available (e.g on community releases).
      * 
      * @since 4.0
    diff --git a/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java b/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java
    index e1deeed0aa..ed8a26915a 100644
    --- a/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java
    +++ b/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java
    @@ -100,9 +100,6 @@ abstract class AbstractMapBasedMetadataLoader implements MetadataLoader
         abstract protected Map loadMetadataFromFile(final File metadataFile);
     
     
    -    /**
    -     * @see org.alfresco.repo.bulkimport.MetadataLoader#loadMetadata(ContentAndMetadata, Metadata)
    -     */
         @Override
         public final void loadMetadata(final ContentAndMetadata contentAndMetadata, Metadata metadata)
         {
    diff --git a/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java b/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java
    index c5e6c128ac..06766d8b45 100644
    --- a/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java
    +++ b/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java
    @@ -51,7 +51,7 @@ public class BulkImport extends BaseProcessorExtension
     
     	/**
     	 * Get a list of the currently registered content stores, from the configured {@link ContentStoreMapProvider}.
    -	 * @return the {@link List} of store names
    +	 * @return the {@link List} of store names
     	 */
     	public List getStoreNames()
     	{
    diff --git a/source/java/org/alfresco/repo/cache/AbstractCacheFactory.java b/source/java/org/alfresco/repo/cache/AbstractCacheFactory.java
    index 4057d1737b..21b7f5425d 100644
    --- a/source/java/org/alfresco/repo/cache/AbstractCacheFactory.java
    +++ b/source/java/org/alfresco/repo/cache/AbstractCacheFactory.java
    @@ -53,7 +53,7 @@ public abstract class AbstractCacheFactory implements
          * For example, for a cache named cache.ticketsCache the property cache.ticketsCache.maxItems
          * will determine the capacity of the cache.
          * 
    -     * @param properties
    +     * @param properties Properties
          */
         public void setProperties(Properties properties)
         {
    diff --git a/source/java/org/alfresco/repo/cache/AsynchronouslyRefreshedCacheRegistry.java b/source/java/org/alfresco/repo/cache/AsynchronouslyRefreshedCacheRegistry.java
    index 991d599c40..4c276b0767 100644
    --- a/source/java/org/alfresco/repo/cache/AsynchronouslyRefreshedCacheRegistry.java
    +++ b/source/java/org/alfresco/repo/cache/AsynchronouslyRefreshedCacheRegistry.java
    @@ -28,13 +28,13 @@ public interface AsynchronouslyRefreshedCacheRegistry
     {
         /**
          * Register a listener
    -     * @param listener
    +     * @param listener RefreshableCacheListener
          */
         public void register(RefreshableCacheListener listener);
         
         /**
          * Fire an even 
    -     * @param event
    +     * @param event RefreshableCacheEvent
          * @param toAll - true goes to all listeners, false only to listeners that have a matching cacheId 
          */
         public void broadcastEvent(RefreshableCacheEvent event, boolean toAll);
    diff --git a/source/java/org/alfresco/repo/cache/CacheFactory.java b/source/java/org/alfresco/repo/cache/CacheFactory.java
    index c94276b3de..996253898a 100644
    --- a/source/java/org/alfresco/repo/cache/CacheFactory.java
    +++ b/source/java/org/alfresco/repo/cache/CacheFactory.java
    @@ -33,7 +33,7 @@ public interface CacheFactory
          * Creates a cache. The type of cache (e.g. localised, clustered etc.) produced is
          * dependant on the factory implementation, and will vary at runtime.
          * 
    -     * @param cacheName
    +     * @param cacheName String
          * @return SimpleCache
          */
         SimpleCache createCache(String cacheName);
    diff --git a/source/java/org/alfresco/repo/cache/DefaultSimpleCache.java b/source/java/org/alfresco/repo/cache/DefaultSimpleCache.java
    index 6e7e19c04b..219d9f59e0 100644
    --- a/source/java/org/alfresco/repo/cache/DefaultSimpleCache.java
    +++ b/source/java/org/alfresco/repo/cache/DefaultSimpleCache.java
    @@ -92,8 +92,8 @@ public final class DefaultSimpleCache
         /**
          * Create a size limited, named cache with no other features enabled.
          * 
    -     * @param maxItems
    -     * @param cacheName
    +     * @param maxItems int
    +     * @param cacheName String
          */
         public DefaultSimpleCache(int maxItems, String cacheName)
         {
    @@ -223,7 +223,7 @@ public final class DefaultSimpleCache
          * a name with each one.
          * 
          * @see #setBeanName(String)
    -     * @param cacheName
    +     * @param cacheName String
          */
         public void setCacheName(String cacheName)
         {
    diff --git a/source/java/org/alfresco/repo/cache/HibernateSimpleCacheAdapter.java b/source/java/org/alfresco/repo/cache/HibernateSimpleCacheAdapter.java
    index 2717b61860..53c8365d91 100644
    --- a/source/java/org/alfresco/repo/cache/HibernateSimpleCacheAdapter.java
    +++ b/source/java/org/alfresco/repo/cache/HibernateSimpleCacheAdapter.java
    @@ -37,8 +37,8 @@ public class HibernateSimpleCacheAdapter implements Cache
         
         /**
          * Adapt a 
    -     * @param cache
    -     * @param regionName
    +     * @param cache SimpleCache
    +     * @param regionName String
          */
         public HibernateSimpleCacheAdapter(SimpleCache cache, String regionName)
         {
    diff --git a/source/java/org/alfresco/repo/cache/RefreshableCache.java b/source/java/org/alfresco/repo/cache/RefreshableCache.java
    index 084d796011..83e07c7b1a 100644
    --- a/source/java/org/alfresco/repo/cache/RefreshableCache.java
    +++ b/source/java/org/alfresco/repo/cache/RefreshableCache.java
    @@ -31,7 +31,7 @@ public interface RefreshableCache 
          * If there is no cache value this call will block.
          * If the underlying cache is being refreshed, the old cache value will be returned until the refresh is complete.
          * 
    -     * @return
    +     * @return T
          */
         public T get();
         
    diff --git a/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshEvent.java b/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshEvent.java
    index e90392aff9..4b724f3b87 100644
    --- a/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshEvent.java
    +++ b/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshEvent.java
    @@ -27,7 +27,9 @@ package org.alfresco.repo.cache;
     public class RefreshableCacheRefreshEvent extends AbstractRefreshableCacheEvent
     {
         /**
    -     * @param cacheId
    +     *
    +     * @param cacheId String
    +     * @param tenantId String
          */
         RefreshableCacheRefreshEvent(String cacheId, String tenantId)
         {
    diff --git a/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshedEvent.java b/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshedEvent.java
    index 9ce26bc52c..877349bfbe 100644
    --- a/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshedEvent.java
    +++ b/source/java/org/alfresco/repo/cache/RefreshableCacheRefreshedEvent.java
    @@ -33,8 +33,8 @@ public class RefreshableCacheRefreshedEvent extends AbstractRefreshableCacheEven
         private static final long serialVersionUID = 2352511592269578075L;
     
         /**
    -     * @param cacheId
    -     * @param tenantId
    +     * @param cacheId String
    +     * @param tenantId String
          */
         RefreshableCacheRefreshedEvent(String cacheId, String tenantId)
         {
    diff --git a/source/java/org/alfresco/repo/coci/CheckOutCheckInServiceImpl.java b/source/java/org/alfresco/repo/coci/CheckOutCheckInServiceImpl.java
    index 27ea037ff9..d65c918241 100644
    --- a/source/java/org/alfresco/repo/coci/CheckOutCheckInServiceImpl.java
    +++ b/source/java/org/alfresco/repo/coci/CheckOutCheckInServiceImpl.java
    @@ -271,9 +271,9 @@ public class CheckOutCheckInServiceImpl implements CheckOutCheckInService
          * Invoke before check in policy
          * 
          * @param workingCopyNodeRef            the current working copy to check in
    -     * @param versionProperties             
    -     * @param contentUrl
    -     * @param keepCheckedOut
    +     * @param versionProperties Map
    +     * @param contentUrl String
    +     * @param keepCheckedOut boolean
          */
         private void invokeBeforeCheckIn(
                 NodeRef workingCopyNodeRef,
    @@ -795,9 +795,9 @@ public class CheckOutCheckInServiceImpl implements CheckOutCheckInService
          * 

    * Example: "" becomes "wc". * - * @param name - * @param workingCopyLabel - * @return + * @param name String + * @param workingCopyLabel String + * @return String */ public static String createWorkingCopyName(String name, final String workingCopyLabel) { @@ -834,7 +834,8 @@ public class CheckOutCheckInServiceImpl implements CheckOutCheckInService * Get original name from the working copy name and the cm:workingCopyLabel * that was used to create it. * - * @param workingCopyLabel + * @param workingCopyName String + * @param workingCopyLabel String * @return original name */ private String getNameFromWorkingCopyName(String workingCopyName, String workingCopyLabel) diff --git a/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java b/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java index 1f52b527a2..971f9bb266 100755 --- a/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java +++ b/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java @@ -39,10 +39,13 @@ public interface CheckOutCheckInServicePolicies public interface BeforeCheckOut extends ClassPolicy { static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "beforeCheckOut"); - + /** - * - * @param nodeRef + * + * @param nodeRef NodeRef + * @param destinationParentNodeRef NodeRef + * @param destinationAssocTypeQName QName + * @param destinationAssocQName QName */ void beforeCheckOut( NodeRef nodeRef, @@ -57,13 +60,13 @@ public interface CheckOutCheckInServicePolicies public interface OnCheckOut extends ClassPolicy { static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "onCheckOut"); - - /** - * - * @param workingCopy - working copy - */ - void onCheckOut(NodeRef workingCopy); - } + + /** + * + * @param workingCopy - working copy + */ + void onCheckOut(NodeRef workingCopy); + } /** * @@ -74,10 +77,10 @@ public interface CheckOutCheckInServicePolicies /** * - * @param workingCopyNodeRef - * @param versionProperties - * @param contentUrl - * @param keepCheckedOut + * @param workingCopyNodeRef NodeRef + * @param versionProperties Map + * @param contentUrl String + * @param keepCheckedOut boolean */ void beforeCheckIn( NodeRef workingCopyNodeRef, @@ -95,7 +98,7 @@ public interface CheckOutCheckInServicePolicies /** * - * @param nodeRef + * @param nodeRef NodeRef */ void onCheckIn(NodeRef nodeRef); } @@ -106,13 +109,13 @@ public interface CheckOutCheckInServicePolicies public interface BeforeCancelCheckOut extends ClassPolicy { static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "beforeCancelCheckOut"); - - /** - * - * @param workingCopyNodeRef - working copy nodeRef - */ - void beforeCancelCheckOut(NodeRef workingCopyNodeRef); - } + + /** + * + * @param workingCopyNodeRef - working copy nodeRef + */ + void beforeCancelCheckOut(NodeRef workingCopyNodeRef); + } /** * @@ -123,7 +126,7 @@ public interface CheckOutCheckInServicePolicies /** * - * @param nodeRef + * @param nodeRef NodeRef */ void onCancelCheckOut(NodeRef nodeRef); } diff --git a/source/java/org/alfresco/repo/coci/CheckedOutAspect.java b/source/java/org/alfresco/repo/coci/CheckedOutAspect.java index 1c88b39276..95ad2bd3b7 100644 --- a/source/java/org/alfresco/repo/coci/CheckedOutAspect.java +++ b/source/java/org/alfresco/repo/coci/CheckedOutAspect.java @@ -52,8 +52,6 @@ public class CheckedOutAspect /** * Callback behaviour retrieval for the 'onCreateVersion' aspect. - * - * @return Returns {@link DoNothingCopyBehaviourCallback} always */ public void onCreateVersion(QName classRef, NodeRef versionableNode, Map versionProperties, PolicyScope nodeDetails) { diff --git a/source/java/org/alfresco/repo/coci/WorkingCopyAspect.java b/source/java/org/alfresco/repo/coci/WorkingCopyAspect.java index 8ed9f177ca..bc020f4079 100644 --- a/source/java/org/alfresco/repo/coci/WorkingCopyAspect.java +++ b/source/java/org/alfresco/repo/coci/WorkingCopyAspect.java @@ -86,7 +86,7 @@ public class WorkingCopyAspect implements CopyServicePolicies.OnCopyNodePolicy, } /** - * @param policyBehaviourFilter + * @param policyBehaviourFilter BehaviourFilter */ public void setPolicyBehaviourFilter(BehaviourFilter policyBehaviourFilter) { @@ -156,7 +156,7 @@ public class WorkingCopyAspect implements CopyServicePolicies.OnCopyNodePolicy, } /** - * @return Returns {@link WorkingCopyAspectCopyBehaviourCallback} + * @return Returns CopyBehaviourCallback */ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/content/ContentServiceImpl.java b/source/java/org/alfresco/repo/content/ContentServiceImpl.java index c80ce12151..c999c03f06 100644 --- a/source/java/org/alfresco/repo/content/ContentServiceImpl.java +++ b/source/java/org/alfresco/repo/content/ContentServiceImpl.java @@ -194,7 +194,7 @@ public class ContentServiceImpl implements ContentService, ApplicationContextAwa /** * Helper setter of the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { diff --git a/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java b/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java index af362852d6..e7ec583b94 100644 --- a/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java +++ b/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java @@ -39,12 +39,12 @@ public class ContentStoreCreatedEvent extends ApplicationEvent /** * The Constructor. * - * @param source - * the source content store - * @param extendedEventParams - */ - public ContentStoreCreatedEvent(ContentStore source, Map extendedEventParams) - { + * @param source + * the source content store + * @param extendedEventParams Map + */ + public ContentStoreCreatedEvent(ContentStore source, Map extendedEventParams) + { super(source); this.extendedEventParams = extendedEventParams; } diff --git a/source/java/org/alfresco/repo/content/TikaOfficeDetectParser.java b/source/java/org/alfresco/repo/content/TikaOfficeDetectParser.java index 3a03a566fb..0d155e71c9 100644 --- a/source/java/org/alfresco/repo/content/TikaOfficeDetectParser.java +++ b/source/java/org/alfresco/repo/content/TikaOfficeDetectParser.java @@ -37,7 +37,7 @@ import org.xml.sax.ContentHandler; import org.xml.sax.SAXException; /** - * {@link http://tika.apache.org/ Apache Tika} assumes that + * Apache Tika assumes that * you either know exactly what your content is, or that * you'll leave it to auto-detection. * Within Alfresco, we usually do know. However, from time diff --git a/source/java/org/alfresco/repo/content/caching/CacheFileProps.java b/source/java/org/alfresco/repo/content/caching/CacheFileProps.java index a7ec6506d9..2ad77682cf 100644 --- a/source/java/org/alfresco/repo/content/caching/CacheFileProps.java +++ b/source/java/org/alfresco/repo/content/caching/CacheFileProps.java @@ -44,13 +44,13 @@ public class CacheFileProps private final File cacheFile; private final File propsFile; - /** - * Construct a CacheFileProps specifying which cache file the properties belong to. - * - * @param cacheFile - cache file - */ - public CacheFileProps(File cacheFile) - { + /** + * Construct a CacheFileProps specifying which cache file the properties belong to. + * + * @param cacheFile - cache file + */ + public CacheFileProps(File cacheFile) + { this.cacheFile = cacheFile; this.propsFile = fileForCacheFile(); } @@ -148,7 +148,7 @@ public class CacheFileProps /** * Set the value of the contentUrl property. * - * @param url + * @param url String */ public void setContentUrl(String url) { @@ -168,7 +168,7 @@ public class CacheFileProps /** * Set the value of the deleteWatchCount property. * - * @param watchCount + * @param watchCount Integer */ public void setDeleteWatchCount(Integer watchCount) { diff --git a/source/java/org/alfresco/repo/content/caching/CachingContentStore.java b/source/java/org/alfresco/repo/content/caching/CachingContentStore.java index 9b5efc3bf1..93d77b09d0 100644 --- a/source/java/org/alfresco/repo/content/caching/CachingContentStore.java +++ b/source/java/org/alfresco/repo/content/caching/CachingContentStore.java @@ -45,8 +45,7 @@ import org.springframework.context.ApplicationEventPublisherAware; * CachingContentStore should only be used to wrap content stores that are significantly * slower that FileContentStore - otherwise performance may actually degrade from its use. *

    - * It is important that cacheOnInbound is set to true for exceptionally slow backing stores, - * e.g. {@link org.alfresco.enterprise.repo.content.xam.XAMContentStore} + * It is important that cacheOnInbound is set to true for exceptionally slow backing stores. * * @author Matt Ward */ @@ -358,8 +357,8 @@ public class CachingContentStore implements ContentStore, ApplicationEventPublis * Get a ReentrantReadWriteLock for a given URL. The lock is from a pool rather than * per URL, so some contention is expected. * - * @param url - * @return + * @param url String + * @return ReentrantReadWriteLock */ public ReentrantReadWriteLock readWriteLock(String url) { @@ -421,7 +420,7 @@ public class CachingContentStore implements ContentStore, ApplicationEventPublis /** * Sets the QuotaManagerStrategy that will be used. * - * @param quota + * @param quota QuotaManagerStrategy */ @Required public void setQuota(QuotaManagerStrategy quota) diff --git a/source/java/org/alfresco/repo/content/caching/CachingContentStoreEvent.java b/source/java/org/alfresco/repo/content/caching/CachingContentStoreEvent.java index f987a43532..fef3073cec 100644 --- a/source/java/org/alfresco/repo/content/caching/CachingContentStoreEvent.java +++ b/source/java/org/alfresco/repo/content/caching/CachingContentStoreEvent.java @@ -42,8 +42,8 @@ public abstract class CachingContentStoreEvent extends ApplicationEvent /** * Is the event an instance of the specified type (or subclass)? * - * @param type - * @return + * @param type {@code Class} + * @return boolean */ public boolean isType(Class type) { diff --git a/source/java/org/alfresco/repo/content/caching/ContentCache.java b/source/java/org/alfresco/repo/content/caching/ContentCache.java index 8b09b22b29..087b1647e9 100644 --- a/source/java/org/alfresco/repo/content/caching/ContentCache.java +++ b/source/java/org/alfresco/repo/content/caching/ContentCache.java @@ -47,7 +47,7 @@ public interface ContentCache * into the cache, it does not mean that the disk item is guaranteed to be there. The temp file * clean-up process, for example, may have removed it. *

    - * @param contentUrl + * @param contentUrl String * @return true if the URL exists in the in-memory cache. It may therefore be cached on disk. */ boolean contains(String contentUrl); @@ -55,7 +55,7 @@ public interface ContentCache /** * Retrieve a ContentReader for the cached content specified by URL. * - * @param contentUrl + * @param contentUrl String * @return ContentReader * @throws org.alfresco.repo.content.caching.CacheMissException * If the cache does not contain the specified content. @@ -68,8 +68,8 @@ public interface ContentCache * * Empty content will NOT be cached - in which case false is returned. * - * @param contentUrl - * @param reader + * @param contentUrl String + * @param reader ContentReader * @return true if the content was cached, false otherwise. */ boolean put(String contentUrl, ContentReader reader); @@ -79,7 +79,7 @@ public interface ContentCache * the actual cached content (file) - this should be left to the clean-up process or can * be deleted with {@link #deleteFile(String)}. * - * @param contentUrl + * @param contentUrl String */ void remove(String contentUrl); @@ -87,16 +87,16 @@ public interface ContentCache * Deletes the cached content file for the specified URL. To remove the item from the * lookup table also, use {@link #remove(String)} after calling this method. * - * @param url + * @param url String */ void deleteFile(String url); /** - * Retrieve a ContentWriter to write content to a cache file. Upon closing the stream - * a listener will add the new content file to the in-memory lookup table. - * - * @param url url - * @return ContentWriter - */ - ContentWriter getWriter(String url); + * Retrieve a ContentWriter to write content to a cache file. Upon closing the stream + * a listener will add the new content file to the in-memory lookup table. + * + * @param url url + * @return ContentWriter + */ + ContentWriter getWriter(String url); } diff --git a/source/java/org/alfresco/repo/content/caching/ContentCacheImpl.java b/source/java/org/alfresco/repo/content/caching/ContentCacheImpl.java index 5a59dfb890..589a31cee8 100644 --- a/source/java/org/alfresco/repo/content/caching/ContentCacheImpl.java +++ b/source/java/org/alfresco/repo/content/caching/ContentCacheImpl.java @@ -36,13 +36,13 @@ import org.alfresco.service.cmr.repository.ContentWriter; import org.alfresco.util.GUID; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; - -/** - * The one and only implementation of the ContentCache class. Binary content data itself - * is stored on disk in the location specified by {@link #cacheRoot}. - *

    - * The in-memory lookup table is provided by a SimpleCache implementation. - * + +/** + * The one and only implementation of the ContentCache class. Binary content data itself + * is stored on disk in the location specified by {@link #cacheRoot}. + *

    + * The in-memory lookup table is provided by a SimpleCache implementation. + * * @author Matt Ward */ public class ContentCacheImpl implements ContentCache @@ -63,7 +63,7 @@ public class ContentCacheImpl implements ContentCache /** * Allows caller to perform lookup using a {@link Key}. * - * @param key + * @param key Key * @return true if the cache contains, false otherwise. */ public boolean contains(Key key) @@ -74,8 +74,8 @@ public class ContentCacheImpl implements ContentCache /** * Put an item in the lookup table. * - * @param key - * @param value + * @param key Key + * @param value String */ public void putIntoLookup(Key key, String value) { @@ -86,7 +86,7 @@ public class ContentCacheImpl implements ContentCache * Get the path of a cache file for the given content URL - will return null if there is no entry * in the cache for the specified URL. * - * @param contentUrl + * @param contentUrl String * @return cache file path */ public String getCacheFilePath(String contentUrl) @@ -97,8 +97,8 @@ public class ContentCacheImpl implements ContentCache /** * Get a content URL from the cache - keyed by File. * - * @param file - * @return + * @param file File + * @return String */ public String getContentUrl(File file) { @@ -152,12 +152,12 @@ public class ContentCacheImpl implements ContentCache memoryStore.put(Key.forCacheFile(cacheFile), contentUrl); } - /** - * Create a File object and makes any intermediate directories in the path. - * - * @return File - */ - private File createCacheFile() + /** + * Create a File object and makes any intermediate directories in the path. + * + * @return File + */ + private File createCacheFile() { File file = new File(cacheRoot, createNewTempCacheFilePath()); File parentDir = file.getParentFile(); @@ -303,7 +303,7 @@ public class ContentCacheImpl implements ContentCache /** * Specify the directory where cache files will be written. * - * @param cacheRoot + * @param cacheRoot File */ public void setCacheRoot(File cacheRoot) { @@ -331,7 +331,7 @@ public class ContentCacheImpl implements ContentCache /** * Ask the ContentCacheImpl to visit all the content files in the cache. - * @param handler + * @param handler FileHandler */ public void processFiles(FileHandler handler) { @@ -342,8 +342,8 @@ public class ContentCacheImpl implements ContentCache * Recurse into a directory handling cache files (*.bin) with the supplied * {@link FileHandler}. * - * @param dir - * @param handler + * @param dir File + * @param handler FileHandler */ private void handleDir(File dir, FileHandler handler) { @@ -377,8 +377,8 @@ public class ContentCacheImpl implements ContentCache *

    * The returned array contains the (numerically sorted) directories first followed by the (unsorted) plain files. * - * @param dir - * @return + * @param dir File + * @return File[] */ private File[] sortFiles(File dir) { diff --git a/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleaner.java b/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleaner.java index 44278bc88e..3fb7b3aa34 100644 --- a/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleaner.java +++ b/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleaner.java @@ -265,8 +265,8 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica * 0 would result in immediate deletion the first time the cleaner sees it as a candidate * for deletion (not recommended). * - * @param file - * @param props + * @param file File + * @param props CacheFileProps * @return true if the content file was deleted, false otherwise. */ private boolean markOrDelete(File file, CacheFileProps props) @@ -349,7 +349,7 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica /** * Sets the minimum age of a cache file before it will be considered for deletion. * @see #oldEnoughForCleanup(File) - * @param minFileAgeMillis + * @param minFileAgeMillis long */ public void setMinFileAgeMillis(long minFileAgeMillis) { @@ -361,7 +361,7 @@ public class CachedContentCleaner extends Thread implements FileHandler, Applica * Sets the maxDeleteWatchCount value. * * @see #markOrDelete(File, CacheFileProps) - * @param maxDeleteWatchCount + * @param maxDeleteWatchCount Integer */ public void setMaxDeleteWatchCount(Integer maxDeleteWatchCount) { diff --git a/source/java/org/alfresco/repo/content/caching/quota/StandardQuotaStrategy.java b/source/java/org/alfresco/repo/content/caching/quota/StandardQuotaStrategy.java index 9c0bdea77a..a9de86f370 100644 --- a/source/java/org/alfresco/repo/content/caching/quota/StandardQuotaStrategy.java +++ b/source/java/org/alfresco/repo/content/caching/quota/StandardQuotaStrategy.java @@ -250,7 +250,7 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker /** * Run a non-aggressive clean up job in a new thread. * - * @param reason + * @param reason String */ private void signalCleanerStart(final String reason) { @@ -260,7 +260,7 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker /** * Run an aggressive clean up job in a new thread. * - * @param reason + * @param reason String */ private void signalAggressiveCleanerStart(final String reason) { @@ -272,8 +272,8 @@ public class StandardQuotaStrategy implements QuotaManagerStrategy, UsageTracker * Will an increase in disk usage of contentSize bytes result in the specified * threshold (percentage of maximum allowed usage) being reached or exceeded? * - * @param threshold - * @param contentSize + * @param threshold int + * @param contentSize long * @return true if additional content will reach threshold. */ private boolean usageWillReach(int threshold, long contentSize) diff --git a/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java b/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java index 4f3e6ab596..9df0923ca1 100644 --- a/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java +++ b/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java @@ -47,10 +47,10 @@ import org.apache.commons.logging.LogFactory; * * Clean-up happens at two levels.

    * Eager cleanup: (since 3.2)

    - * If {@link #setEagerOrphanCleanup(boolean) eager cleanup} is activated, then this + * If eager cleanup is activated, then this * component listens to all content property change events and recorded for post-transaction * processing. All orphaned content is deleted from the registered store(s). Note that - * any {@link #setListeners(List) listeners} are called as normal; backup or scrubbing + * any listeners are called as normal; backup or scrubbing * procedures should be plugged in as listeners if this is required. *

    * Lazy cleanup:

    @@ -197,7 +197,7 @@ public class ContentStoreCleaner } /** - * Initializes the cleaner based on the {@link #setEagerOrphanCleanup(boolean) eagerCleanup} flag. + * Initializes the cleaner. */ public void init() { diff --git a/source/java/org/alfresco/repo/content/filestore/FileContentStore.java b/source/java/org/alfresco/repo/content/filestore/FileContentStore.java index 66f4494bdd..55d62a3948 100644 --- a/source/java/org/alfresco/repo/content/filestore/FileContentStore.java +++ b/source/java/org/alfresco/repo/content/filestore/FileContentStore.java @@ -304,7 +304,6 @@ public class FileContentStore * * @param file the file from which to create the URL * @return Returns the equivalent content URL - * @throws Exception */ /*package*/ String makeContentUrl(File file) { @@ -533,7 +532,6 @@ public class FileContentStore * the created before dat6e * @param handler * the handler - * @return the urls */ @SuppressWarnings("deprecation") public void getUrls(Date createdAfter, Date createdBefore, ContentUrlHandler handler) @@ -554,7 +552,6 @@ public class FileContentStore * @param handler the callback to use for each URL * @param createdAfter only get URLs for content create after this date * @param createdBefore only get URLs for content created before this date - * @return a list of all files within the given directory and all subdirectories */ @SuppressWarnings("deprecation") private void getUrls(File directory, ContentUrlHandler handler, Date createdAfter, Date createdBefore) diff --git a/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java index fb62a1604f..9fad265f73 100644 --- a/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java @@ -85,7 +85,7 @@ import org.springframework.extensions.surf.util.ISO8601DateFormat; * implementation. This can be overwritten with configurations. * *

  • - * Implement the {@link extractInternal} method. This now returns a raw map of extracted + * Implement the {@link #extract} method. This now returns a raw map of extracted * values keyed by document-specific property names. The trimPut method has * been replaced with an equivalent {@link #putRawValue(String, Serializable, Map)}. *
  • @@ -225,7 +225,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac /** * Set the mimetypes that are supported by the extracter. * - * @param supportedMimetypes + * @param supportedMimetypes Collection */ public void setSupportedMimetypes(Collection supportedMimetypes) { @@ -236,7 +236,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac /** * Set the mimetypes that are supported for embedding. * - * @param supportedEmbedMimetypes + * @param supportedEmbedMimetypes Collection */ public void setSupportedEmbedMimetypes(Collection supportedEmbedMimetypes) { @@ -342,7 +342,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac /** * Set the date formats, over and above the {@link ISO8601DateFormat ISO8601 format}, that will * be supported for string to date conversions. The supported syntax is described by the - * {@link http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html SimpleDateFormat Javadocs}. + * SimpleDateFormat Javadocs. * * @param supportedDateFormats a list of supported date formats. */ @@ -446,7 +446,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac /** * Sets the map of source mimetypes to metadata extracter limits. * - * @param mimetypeLimits + * @param mimetypeLimits Map */ public void setMimetypeLimits(Map mimetypeLimits) { @@ -1970,7 +1970,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac * A specific match for the given mimetype is tried first and * if none is found a wildcard of "*" is tried. * - * @param mimetype + * @param mimetype String * @return the found limits or null */ protected MetadataExtracterLimits getLimits(String mimetype) @@ -2044,7 +2044,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac * the reader must be closed if accessed directly. * @param limits the limits to impose on the extraction * @return Returns a map of document property values keyed by property name. - * @throws All exception conditions can be handled. + * @throws Throwable All exception conditions can be handled. */ private Map extractRaw( ContentReader reader, MetadataExtracterLimits limits) throws Throwable @@ -2100,7 +2100,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac * strings are *
      *
    • Null: Removed
    • - *
    • Empty String: Passed to the {@link OverwritePolicy}
    • + *
    • Empty String: Passed to the OverwritePolicy
    • *
    • Non Serializable: Converted to String or fails if that is not possible
    • *
    *

    @@ -2118,7 +2118,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac * @param reader the document to extract the values from. This stream provided by * the reader must be closed if accessed directly. * @return Returns a map of document property values keyed by property name. - * @throws All exception conditions can be handled. + * @throws Throwable All exception conditions can be handled. * * @see #getDefaultMapping() */ @@ -2136,7 +2136,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac * the reader must be closed if accessed directly. * @param writer the writer for the document to embed the values in. This stream provided by * the writer must be closed if accessed directly. - * @throws All exception conditions can be handled. + * @throws Throwable All exception conditions can be handled. * * @see #getDefaultEmbedMapping() */ diff --git a/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java index 6e58c1247d..84c0f4de54 100644 --- a/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java @@ -81,7 +81,7 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter, Be /** * Helper setter of the mimetype service. This is not always required. * - * @param mimetypeService + * @param mimetypeService MimetypeService */ public void setMimetypeService(MimetypeService mimetypeService) { @@ -205,23 +205,23 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter, Be /** * {@inheritDoc} *

    - * A {@linkplain OverwritePolicy#PRAGMATIC pragmatic} overwrite policy will be applied. + * A {@code OverwritePolicy.PRAGMATIC} will be applied. */ public Map extract(ContentReader reader, Map destination) { return extract(reader, OverwritePolicy.PRAGMATIC, destination); } - /** - * {@inheritDoc} - * - * @param reader - * @param overwritePolicy - * @param destination - * - * @see #extract(ContentReader, Map) - */ - public final Map extract( + /** + * {@inheritDoc} + * + * @param reader + * @param overwritePolicy + * @param destination + * + * @see #extract(ContentReader, Map) + */ + public final Map extract( ContentReader reader, OverwritePolicy overwritePolicy, Map destination) throws ContentIOException diff --git a/source/java/org/alfresco/repo/content/metadata/RFC822MetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/RFC822MetadataExtracter.java index 4ff8530375..a7189bb22d 100644 --- a/source/java/org/alfresco/repo/content/metadata/RFC822MetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/RFC822MetadataExtracter.java @@ -196,7 +196,7 @@ public class RFC822MetadataExtracter extends AbstractMappingMetadataExtracter /** * Back door for RM - * @return + * @return Map */ public final Map> getCurrentMapping() { diff --git a/source/java/org/alfresco/repo/content/metadata/xml/XmlMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/xml/XmlMetadataExtracter.java index 1e371bfac8..32738bb09c 100644 --- a/source/java/org/alfresco/repo/content/metadata/xml/XmlMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/xml/XmlMetadataExtracter.java @@ -43,7 +43,7 @@ import org.alfresco.util.PropertyCheck; * The {@linkplain #setSelectors(List) selectors} are used to find an extracter * most appropriate of a given XML document. The chosen extracter is then asked * to extract the values, passing through the - * {@linkplain MetadataExtracter.OverwritePolicy overwrite policy} as + * {@code MetadataExtracter.OverwritePolicy} as * {@linkplain #setOverwritePolicy(String)} on this instance. The overwrite * policy of the embedded extracters is not relevant unless they are used * separately in another context. diff --git a/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java b/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java index 1266b73e31..88ef9e45d4 100644 --- a/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java +++ b/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java @@ -60,13 +60,13 @@ import org.apache.commons.logging.LogFactory; *

    * When this is enabled, then the primary store is used for writes. When the * content write completes (i.e. the write channel is closed) then the content - * is synchronously copied to all other stores. The write is therefore slowed - * down, but the content replication will occur in-transaction. - *

    - * The {@link #setOutboundThreadPoolExecutor(ThreadPoolExecutor) outboundThreadPoolExecutor } - * property to enable asynchronous replication.
    - * With asynchronous replication, there is always a risk that a failure - * occurs during the replication. Depending on the configuration of the server, + * is synchronously copied to all other stores. The write is therefore slowed + * down, but the content replication will occur in-transaction. + *

    + * The {@link #setOutboundThreadPoolExecutor(ThreadPoolExecutor) outboundThreadPoolExecutor } + * property to enable asynchronous replication.
    + * With asynchronous replication, there is always a risk that a failure + * occurs during the replication. Depending on the configuration of the server, * further action may need to be taken to rectify the problem manually. * * Inbound Replication [DEPRECATED: Usage {@link CachingContentStore}] @@ -86,7 +86,7 @@ import org.apache.commons.logging.LogFactory; * * @author Derek Hulley * @see CachingContentStore - * @depecated use AggregatingContentStore + * @deprecated use AggregatingContentStore */ public class ReplicatingContentStore extends AbstractContentStore { @@ -153,13 +153,13 @@ public class ReplicatingContentStore extends AbstractContentStore this.primaryStore = primaryStore; } - /** - * Set the secondary stores that this component will replicate to or from - * - * @param secondaryStores a list of stores to replicate to or from - */ - public void setSecondaryStores(List secondaryStores) - { + /** + * Set the secondary stores that this component will replicate to or from + * + * @param secondaryStores a list of stores to replicate to or from + */ + public void setSecondaryStores(List secondaryStores) + { this.secondaryStores = secondaryStores; } diff --git a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java index d6b279d713..c2ca406a89 100644 --- a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java @@ -85,7 +85,7 @@ public abstract class AbstractContentTransformer implements ContentTransformer, /** * Helper setter of the mimetype service. This is not always required. * - * @param mimetypeService + * @param mimetypeService MimetypeService */ public void setMimetypeService(MimetypeService mimetypeService) { @@ -111,7 +111,7 @@ public abstract class AbstractContentTransformer implements ContentTransformer, /** * Set the transformations that this transformer can do regardless of what it returns - * via the {@link org.alfresco.repo.content.transform.ContentTransformerContentTransformer#getReliability(String, String) reliability check}. + * via the reliability check. * * @param explicitTransformations explicit key mappings */ @@ -185,8 +185,8 @@ public abstract class AbstractContentTransformer implements ContentTransformer, /** * Convenience method to check the reliability of a transformation * - * @param reader - * @param writer + * @param reader ContentReader + * @param writer ContentWriter * @throws AlfrescoRuntimeException if the reliability isn't > 0 */ protected void checkReliability(ContentReader reader, ContentWriter writer) @@ -325,13 +325,13 @@ public abstract class AbstractContentTransformer implements ContentTransformer, /** * Performs the following: - *

      - *
    • Times the transformation
    • - *
    • Ensures that the transformation is allowed
    • - *
    • Calls the subclass implementation of {@link #transformInternal(ContentReader, ContentWriter, Map)}
    • - *
    • Transforms any exceptions generated
    • - *
    • Logs a successful transformation
    • - *
    + *
      + *
    • Times the transformation
    • + *
    • Ensures that the transformation is allowed
    • + *
    • Calls the subclass implementation of {@link #transformInternal(ContentReader, ContentWriter, Map)}
    • + *
    • Transforms any exceptions generated
    • + *
    • Logs a successful transformation
    • + *
    * Subclass need only be concerned with performing the transformation. *

    * If the options provided are null, then an empty map will be created. diff --git a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer2.java b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer2.java index b729b15986..e6710a8da5 100644 --- a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer2.java +++ b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer2.java @@ -192,13 +192,13 @@ public abstract class AbstractContentTransformer2 extends AbstractContentTransfo ContentReader reader, ContentWriter writer, TransformationOptions options) throws Exception; - - /** - * @see #transform(ContentReader, ContentWriter, Map) - * @see #transformInternal(ContentReader, ContentWriter, TransformationOptions) - */ - public final void transform(ContentReader reader, ContentWriter writer) throws ContentIOException - { + + /** + * @see #transform(ContentReader, ContentWriter, Map) + * @see #transformInternal(ContentReader, ContentWriter, TransformationOptions) + */ + public final void transform(ContentReader reader, ContentWriter writer) throws ContentIOException + { transform(reader, writer, new TransformationOptions()); } @@ -482,8 +482,8 @@ public abstract class AbstractContentTransformer2 extends AbstractContentTransfo * This method is thread-safe. The time spent in this method is negligible * so the impact will be minor. * - * @param sourceMimetype - * @param targetMimetype + * @param sourceMimetype String + * @param targetMimetype String * @param transformationTime the time it took to perform the transformation. */ protected final synchronized void recordTime(String sourceMimetype, String targetMimetype, @@ -596,8 +596,8 @@ public abstract class AbstractContentTransformer2 extends AbstractContentTransfo /** * Records an error and updates the average time as if the transformation took a * long time, so that it is less likely to be called again. - * @param sourceMimetype - * @param targetMimetype + * @param sourceMimetype String + * @param targetMimetype String * @param transformationTime the time it took to perform the transformation. */ protected final synchronized void recordError(String sourceMimetype, String targetMimetype, diff --git a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java index 7ed1446d95..ab3643ac8f 100644 --- a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java +++ b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java @@ -74,7 +74,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme /** * Helper setter of the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { @@ -163,7 +163,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getTimeoutMs()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getTimeoutMs()} * which allows the limits to be selected based on mimetype and use. */ protected long getTimeoutMs() @@ -180,7 +180,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getReadLimitTimeMs()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getReadLimitTimeMs()} * which allows the limits to be selected based on mimetype and use. */ protected long getReadLimitTimeMs() @@ -197,7 +197,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getMaxSourceSizeKBytes()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getMaxSourceSizeKBytes()} * which allows the limits to be selected based on mimetype and use. */ protected long getMaxSourceSizeKBytes() @@ -214,7 +214,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getReadLimitKBytes()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getReadLimitKBytes()} * which allows the limits to be selected based on mimetype and use. */ protected long getReadLimitKBytes() @@ -231,7 +231,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getMaxPages()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getMaxPages()} * which allows the limits to be selected based on mimetype and use. */ protected int getMaxPages() @@ -248,7 +248,7 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme } /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)#getPageLimit()} + * @deprecated use {@link #getLimits(String, String, TransformationOptions) getPageLimit()} * which allows the limits to be selected based on mimetype and use. */ protected int getPageLimit() @@ -262,13 +262,13 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme public void setPageLimit(int pageLimit) { deprecatedSetter(null, null, OPT_PAGE_LIMIT+'='+pageLimit); - } - - /** - * @deprecated use @link {@link #getLimits(String, String, TransformationOptions)} which allows the - * limits to be selected based on mimetype and use. - */ - protected TransformationOptionLimits getLimits() + } + + /** + * @deprecated use {@link #getLimits(String, String, TransformationOptions)} which allows the + * limits to be selected based on mimetype and use. + */ + protected TransformationOptionLimits getLimits() { return transformerConfig.getLimits(this, null, null, null); } @@ -349,9 +349,9 @@ public abstract class AbstractContentTransformerLimits extends ContentTransforme /** * Pass on any limits to the reader. Will only do so if the reader is an * {@link AbstractContentReader}. - * @param reader passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions). - * @param writer passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions). - * @param options passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions). + * @param reader passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions)}. + * @param writer passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions)}. + * @param options passed to {@link #transform(ContentReader, ContentWriter, TransformationOptions)}. */ protected void setReaderLimits(ContentReader reader, ContentWriter writer, TransformationOptions options) diff --git a/source/java/org/alfresco/repo/content/transform/ComplexContentTransformer.java b/source/java/org/alfresco/repo/content/transform/ComplexContentTransformer.java index 8ec5fda612..aecb025285 100644 --- a/source/java/org/alfresco/repo/content/transform/ComplexContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/ComplexContentTransformer.java @@ -120,7 +120,7 @@ public class ComplexContentTransformer extends AbstractContentTransformer2 imple * to control the transformers in a different way to their default. * Note that only properties that are supported by the passed-in * {@link TransformationOptions} are changed, others are ignored. - * @param transformationOptionOverrides + * @param transformationOptionOverrides Map */ public void setTransformationOptionOverrides( Map transformationOptionOverrides) @@ -130,7 +130,7 @@ public class ComplexContentTransformer extends AbstractContentTransformer2 imple /** * Sets the ContentService. Only required if {@code null} transformers - * are provided to {@link #setTransformers(List). + * are provided to {@link #setTransformers(List)}. * @param contentService */ public void setContentService(ContentService contentService) diff --git a/source/java/org/alfresco/repo/content/transform/ContentTransformer.java b/source/java/org/alfresco/repo/content/transform/ContentTransformer.java index 4f4fddab28..0df0a4e868 100644 --- a/source/java/org/alfresco/repo/content/transform/ContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/ContentTransformer.java @@ -54,7 +54,7 @@ public interface ContentTransformer extends ContentWorker public boolean isTransformable(String sourceMimetype, long sourceSize, String targetMimetype, TransformationOptions options); /** - * Sub component of {@link #isTransformable(String, long, String, TransformationOptions) + * Sub component of {@link #isTransformable(String, long, String, TransformationOptions)} * that checks just the mimetypes. * @param sourceMimetype the source mimetype * @param targetMimetype the target mimetype @@ -64,7 +64,7 @@ public interface ContentTransformer extends ContentWorker public boolean isTransformableMimetype(String sourceMimetype, String targetMimetype, TransformationOptions options); /** - * Sub component of {@link #isTransformable(String, long, String, TransformationOptions) + * Sub component of {@link #isTransformable(String, long, String, TransformationOptions)} * that checks just the size limits. * @param sourceMimetype the source mimetype * @param sourceSize the size (bytes) of the source. If negative it is unknown. @@ -82,7 +82,6 @@ public interface ContentTransformer extends ContentWorker * {link {@link AbstractContentTransformerLimits#isTransformableMimetype(String, String, TransformationOptions)} * or {@link ContentTransformerWorker#isTransformable(String, String, TransformationOptions)} * have been overridden. - * See {@link #getCommentsOnlySupports(List, List, boolean)} which may be used to help construct a comment. * @param available indicates if the transformer has been registered and is available to be selected. * {@code false} indicates that the transformer is only available as a component of a * complex transformer. @@ -140,9 +139,6 @@ public interface ContentTransformer extends ContentWorker * Transforms the content provided by the reader and source mimetype * to the writer and target mimetype. *

    - * The transformation viability can be determined by an up front call - * to {@link #getReliability(String, String)}. - *

    * The source and target mimetypes must be available on the * {@link org.alfresco.service.cmr.repository.ContentAccessor#getMimetype()} methods of * both the reader and the writer. diff --git a/source/java/org/alfresco/repo/content/transform/ContentTransformerHelper.java b/source/java/org/alfresco/repo/content/transform/ContentTransformerHelper.java index 73dd22b85b..0c83d383ad 100644 --- a/source/java/org/alfresco/repo/content/transform/ContentTransformerHelper.java +++ b/source/java/org/alfresco/repo/content/transform/ContentTransformerHelper.java @@ -55,7 +55,7 @@ public class ContentTransformerHelper implements BeanNameAware /** * Helper setter of the mimetype service. This is not always required. * - * @param mimetypeService + * @param mimetypeService MimetypeService */ public void setMimetypeService(MimetypeService mimetypeService) { @@ -298,11 +298,11 @@ public class ContentTransformerHelper implements BeanNameAware } /** - * Helper method for {@link #getComments(boolean) to + * Helper method for {@link #getComments(boolean)} to * create a line that indicates which source and target mimetypes * it supports. - * @param sourceMimetypes - * @param targetMimetypes + * @param sourceMimetypes List + * @param targetMimetypes List * @param available TODO * @return a String of the form "# only supports xxx, yyy or zzz to aaa or bb\n". */ @@ -354,11 +354,11 @@ public class ContentTransformerHelper implements BeanNameAware } /** - * Helper method for {@link #getComments(boolean) to + * Helper method for {@link #getComments(boolean)} to * create a line that indicates which source and target mimetypes * it supports. - * @param sourceMimetype - * @param targetMimetype + * @param sourceMimetype String + * @param targetMimetype String * @param available TODO * @return a String of the form "# only supports xxx to aaa\n". */ diff --git a/source/java/org/alfresco/repo/content/transform/MailContentTransformer.java b/source/java/org/alfresco/repo/content/transform/MailContentTransformer.java index 63ce505ab0..34d67482fc 100644 --- a/source/java/org/alfresco/repo/content/transform/MailContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/MailContentTransformer.java @@ -23,8 +23,8 @@ import org.apache.tika.parser.Parser; import org.apache.tika.parser.microsoft.OfficeParser; /** - * Uses {@link http://tika.apache.org/ Apache Tika} and - * {@link http://poi.apache.org/ Apache POI} to transform + * Uses Apache Tika and + * Apache POI to transform * Outlook email msg files. * * @author Nick Burch diff --git a/source/java/org/alfresco/repo/content/transform/MediaWikiContentTransformer.java b/source/java/org/alfresco/repo/content/transform/MediaWikiContentTransformer.java index 312ce325e3..4d824c3a47 100644 --- a/source/java/org/alfresco/repo/content/transform/MediaWikiContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/MediaWikiContentTransformer.java @@ -38,7 +38,7 @@ import org.htmlcleaner.ContentToken; /** * MediaWiki content transformer. Converts mediawiki markup into HTML. * - * @see http://matheclipse.org/en/Java_Wikipedia_API + *
    @see Java_Wikipedia_API * * Tika Note - Tika doesn't currently support mediawiki markup, so this * transformer cannot currently be converted to use Tika. diff --git a/source/java/org/alfresco/repo/content/transform/OOoContentTransformerHelper.java b/source/java/org/alfresco/repo/content/transform/OOoContentTransformerHelper.java index aeea592c08..e5461f5023 100644 --- a/source/java/org/alfresco/repo/content/transform/OOoContentTransformerHelper.java +++ b/source/java/org/alfresco/repo/content/transform/OOoContentTransformerHelper.java @@ -86,7 +86,7 @@ public abstract class OOoContentTransformerHelper extends ContentTransformerHelp /** * Helper setter of the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { @@ -123,8 +123,8 @@ public abstract class OOoContentTransformerHelper extends ContentTransformerHelp * This method can be used by subclasses to check if a targetMimetype or source/target * Mimetype pair are blocked. * - * @param sourceMimetype - * @param targetMimetype + * @param sourceMimetype String + * @param targetMimetype String * @return true if the mimetypes are blocked, else false */ protected boolean isTransformationBlocked(String sourceMimetype, String targetMimetype) diff --git a/source/java/org/alfresco/repo/content/transform/OpenOfficeContentTransformerWorker.java b/source/java/org/alfresco/repo/content/transform/OpenOfficeContentTransformerWorker.java index 6b40421c9f..c48863c212 100644 --- a/source/java/org/alfresco/repo/content/transform/OpenOfficeContentTransformerWorker.java +++ b/source/java/org/alfresco/repo/content/transform/OpenOfficeContentTransformerWorker.java @@ -35,7 +35,7 @@ import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.InitializingBean; /** - * Makes use of the {@link http://sourceforge.net/projects/joott/JOOConverter} library to perform + * Makes use of the JOOConverter library to perform * OpenOffice-driven conversions. * This requires that OpenOffice be running, but delivers a wider range of transformations * than Tika is able to (Tika just translates into Text, HTML and XML) diff --git a/source/java/org/alfresco/repo/content/transform/PdfBoxContentTransformer.java b/source/java/org/alfresco/repo/content/transform/PdfBoxContentTransformer.java index 1f085e597f..24e07f6cf9 100644 --- a/source/java/org/alfresco/repo/content/transform/PdfBoxContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/PdfBoxContentTransformer.java @@ -27,8 +27,8 @@ import org.apache.tika.parser.pdf.PDFParser; import org.apache.tika.parser.pdf.PDFParserConfig; /** - * Uses {@link http://tika.apache.org/ Apache Tika} and - * {@link http://pdfbox.apache.org/ Apache PDFBox} to perform + * Uses Apache Tika and + * Apache PDFBox to perform * conversions from PDF documents. * * @author Nick Burch diff --git a/source/java/org/alfresco/repo/content/transform/PoiContentTransformer.java b/source/java/org/alfresco/repo/content/transform/PoiContentTransformer.java index ba9aa366bd..84a406d825 100644 --- a/source/java/org/alfresco/repo/content/transform/PoiContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/PoiContentTransformer.java @@ -26,8 +26,8 @@ import org.apache.tika.parser.Parser; import org.apache.tika.parser.microsoft.OfficeParser; /** - * Uses {@link http://tika.apache.org/ Apache Tika} and - * {@link http://poi.apache.org/ Apache POI} to perform + * Uses Apache Tika and + * Apache POI to perform * conversions from Office documents. * * {@link PoiHssfContentTransformer} handles the Excel diff --git a/source/java/org/alfresco/repo/content/transform/PoiHssfContentTransformer.java b/source/java/org/alfresco/repo/content/transform/PoiHssfContentTransformer.java index b8783cf999..1938147f6e 100644 --- a/source/java/org/alfresco/repo/content/transform/PoiHssfContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/PoiHssfContentTransformer.java @@ -35,8 +35,8 @@ import org.xml.sax.ContentHandler; import org.xml.sax.SAXException; /** - * Uses {@link http://tika.apache.org/ Apache Tika} and - * {@link http://poi.apache.org/ Apache POI} to perform + * Uses Apache Tika and + * Apache POI to perform * conversions from Excel spreadsheets. *

    Will transform from Excel spreadsheets into Html, * Xml or Text (space or comma separated) diff --git a/source/java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformer.java b/source/java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformer.java index 0399b072e4..e4b566c630 100644 --- a/source/java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformer.java @@ -25,8 +25,8 @@ import org.apache.tika.parser.Parser; import org.apache.tika.parser.microsoft.ooxml.OOXMLParser; /** - * Uses {@link http://tika.apache.org/ Apache Tika} and - * {@link http://poi.apache.org/ Apache POI} to perform + * Uses Apache Tika and + * Apache POI to perform * conversions from the newer OOXML Office documents. * * @author Nick Burch diff --git a/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java b/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java index 90633aefac..a0e014f8ce 100644 --- a/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java +++ b/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java @@ -121,7 +121,7 @@ public class RuntimeExecutableContentTransformerWorker extends ContentTransforme * A comma or space separated list of values that, if returned by the executed command, * indicate an error value. This defaults to "1, 2". * - * @param errCodesStr + * @param errCodesStr String */ public void setErrorCodes(String errCodesStr) { @@ -163,7 +163,7 @@ public class RuntimeExecutableContentTransformerWorker extends ContentTransforme } /** - * If the {@link #init() initialization} failed, then it returns 0.0. + * If the initialization failed, then it returns 0.0. * Otherwise the explicit transformations are checked for the reliability. * * @return Returns 1.0 if initialization succeeded, otherwise 0.0. @@ -205,7 +205,6 @@ public class RuntimeExecutableContentTransformerWorker extends ContentTransforme * Converts the source and target content to temporary files with the * correct extensions for the mimetype that they map to. * - * @see #transformInternal(File, File) */ public final void transform( ContentReader reader, diff --git a/source/java/org/alfresco/repo/content/transform/TextToPdfContentTransformer.java b/source/java/org/alfresco/repo/content/transform/TextToPdfContentTransformer.java index e1f6db2d6c..5a2461efdb 100644 --- a/source/java/org/alfresco/repo/content/transform/TextToPdfContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/TextToPdfContentTransformer.java @@ -45,7 +45,7 @@ import org.apache.pdfbox.pdmodel.edit.PDPageContentStream; import org.apache.pdfbox.pdmodel.font.PDTrueTypeFont; import org.apache.pdfbox.pdmodel.font.PDType1Font; /** - * Makes use of the {@link http://www.pdfbox.org/ PDFBox} library's TextToPDF utility. + * Makes use of the PDFBox library's TextToPDF utility. * * @author Derek Hulley * @since 2.1.0 diff --git a/source/java/org/alfresco/repo/content/transform/TikaPoweredContentTransformer.java b/source/java/org/alfresco/repo/content/transform/TikaPoweredContentTransformer.java index 982c3b655d..a032a5e1cc 100644 --- a/source/java/org/alfresco/repo/content/transform/TikaPoweredContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/TikaPoweredContentTransformer.java @@ -175,7 +175,7 @@ public abstract class TikaPoweredContentTransformer extends AbstractContentTrans /** * Sets the document selector, used for determining whether to parse embedded resources. * - * @param documentSelector + * @param documentSelector DocumentSelector */ public void setDocumentSelector(DocumentSelector documentSelector) { @@ -185,9 +185,9 @@ public abstract class TikaPoweredContentTransformer extends AbstractContentTrans * Gets the document selector, used for determining whether to parse embedded resources, * null by default so parse all. * - * @param metadata - * @param targetMimeType - * @param options + * @param metadata Metadata + * @param targetMimeType String + * @param options TransformationOptions * @return the document selector */ protected DocumentSelector getDocumentSelector(Metadata metadata, String targetMimeType, TransformationOptions options) diff --git a/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java b/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java index c18d47c2d2..d2d5ad2062 100644 --- a/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java @@ -43,7 +43,7 @@ public class TikaSpringConfiguredContentTransformer extends TikaPoweredContentTr /** * Injects the name of the Tika parser to use - * @param className + * @param className String */ @SuppressWarnings("unchecked") public void setTikaParserName(String className) @@ -61,7 +61,7 @@ public class TikaSpringConfiguredContentTransformer extends TikaPoweredContentTr /** * Injects the Tika parser to use - * @param tikaParser + * @param tikaParser Parser */ public void setTikaParser(Parser tikaParser) { diff --git a/source/java/org/alfresco/repo/content/transform/TransformerConfigMBean.java b/source/java/org/alfresco/repo/content/transform/TransformerConfigMBean.java index e5a771e932..8c9ec23264 100644 --- a/source/java/org/alfresco/repo/content/transform/TransformerConfigMBean.java +++ b/source/java/org/alfresco/repo/content/transform/TransformerConfigMBean.java @@ -70,14 +70,14 @@ public interface TransformerConfigMBean /** * Adds or replaces new transformer properties. * @param propertyNamesAndValues - * @returns a confirmation or failure message + * @return a confirmation or failure message */ public String setProperties(String propertyNamesAndValues); /** * Removes transformer properties. * @param propertyNames to be removed. Any values after the property name are ignored. - * @returns a confirmation or failure message + * @return a confirmation or failure message */ String removeProperties(String propertyNames); diff --git a/source/java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractor.java b/source/java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractor.java index 04d8e9aa35..0f9d4eb75e 100644 --- a/source/java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractor.java +++ b/source/java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractor.java @@ -57,7 +57,7 @@ public abstract class TransformerPropertyNameExtractor * the normal defaults. Such properties have a suffix of ".use." where * is a value such as "index", "webpreview", "doclib", "syncRule", "aysncRule". * @param transformerProperties that provides the properties - * @param mimetypeService + * @param mimetypeService MimetypeService */ protected Collection getTransformerSourceTargetValues(Collection suffixes, boolean includeSummary, boolean includeUse, TransformerProperties transformerProperties, MimetypeService mimetypeService) @@ -83,7 +83,7 @@ public abstract class TransformerPropertyNameExtractor * the normal defaults. Such properties have a suffix of ".use." where * is a value such as "index", "webpreview", "doclib", "syncRule", "aysncRule". * @param transformerProperties that provides the properties - * @param mimetypeService + * @param mimetypeService MimetypeService */ protected Map getTransformerSourceTargetValuesMap(Collection suffixes, boolean includeSummary, boolean includeExtensions, boolean includeUse, TransformerProperties transformerProperties, MimetypeService mimetypeService) @@ -253,7 +253,7 @@ public abstract class TransformerPropertyNameExtractor * Gets the extensions of the mimetypes that match the given expression. * However if the expression is "*", only the ANY ("*") extension is returned. * @param expression which may contain '*' to represent zero or more characters. - * @param mimetypeService + * @param mimetypeService MimetypeService * @return the list of extensions of mimetypes that match */ List getMatchingExtensionsFromMimetypes( @@ -281,7 +281,7 @@ public abstract class TransformerPropertyNameExtractor * of each mimetype is checked. * However if the expression is "*", only the ANY ("*") extension is returned. * @param expression which may contain '*' to represent zero or more characters. - * @param mimetypeService + * @param mimetypeService MimetypeService * @return the list of extensions that match */ List getMatchingExtensionsFromExtensions( @@ -308,9 +308,9 @@ public abstract class TransformerPropertyNameExtractor * Returns a transformer property value if it exists from the supplied map. * @param transformerName of the transformer * @param sourceExt {@code null} indicates this is a transformer wide property. - * @param targetExt - * @param suffix - * @param use + * @param targetExt String + * @param suffix String + * @param use String * @param transformerSourceTargetSuffixValues map of values * @return the value or {@code null} if not set. */ diff --git a/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java b/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java index af321f24f1..2cd24947ea 100644 --- a/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java +++ b/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java @@ -65,19 +65,19 @@ public abstract class AbstractImageMagickContentTransformerWorker extends Conten /** * Make the transformer available - * @param available + * @param available boolean */ protected void setAvailable(boolean available) { this.available = available; } - - /** - * Checks for the JMagick and ImageMagick dependencies, using the common - * {@link #transformInternal(File, String , File, java.lang.String, TransformationOptions) transformation method} to check - * that the sample image can be converted. - *

    - * If initialization is successful, then autoregistration takes place. + + /** + * Checks for the JMagick and ImageMagick dependencies, using the common + * {@link #transformInternal(File, String , File, java.lang.String, TransformationOptions) transformation method} to check + * that the sample image can be converted. + *

    + * If initialization is successful, then autoregistration takes place. */ public void afterPropertiesSet() { @@ -228,13 +228,13 @@ public abstract class AbstractImageMagickContentTransformerWorker extends Conten sb.append("# pdf or ai to png.\n"); sb.append("# tiff to pdf.\n"); return sb.toString(); - } - - /** - * @see #transformInternal(File, String, File, String, TransformationOptions) - */ - public final void transform( - ContentReader reader, + } + + /** + * @see #transformInternal(File, String, File, String, TransformationOptions) + */ + public final void transform( + ContentReader reader, ContentWriter writer, TransformationOptions options) throws Exception { diff --git a/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java index 64ae088982..29ae46cc26 100644 --- a/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java @@ -59,7 +59,7 @@ public abstract class AbstractCopyBehaviourCallback implements CopyBehaviourCall } /** - * @return Returns {@link ChildAssocRecurseAction#RESPECT_RECURSE_FLAG} + * @return Returns ChildAssocRecurseAction.RESPECT_RECURSE_FLAG */ public ChildAssocRecurseAction getChildAssociationRecurseAction( QName classQName, @@ -92,13 +92,13 @@ public abstract class AbstractCopyBehaviourCallback implements CopyBehaviourCall * When the copy has been completed, the second stage of the process can be applied. * * @param sourceNodeRef the node that is being copied - * @param properties the node properties being copied - * @param propertyQName the qualified name of the property to check - * - * @see #repointNodeRefs(NodeRef, NodeRef, QName, Map, NodeService) - */ - public void recordNodeRefsForRepointing( - NodeRef sourceNodeRef, + * @param properties the node properties being copied + * @param propertyQName the qualified name of the property to check + * + * @see #repointNodeRefs(NodeRef, NodeRef, QName, Map, NodeService) + */ + public void recordNodeRefsForRepointing( + NodeRef sourceNodeRef, Map properties, QName propertyQName) { diff --git a/source/java/org/alfresco/repo/copy/CompoundCopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/CompoundCopyBehaviourCallback.java index bb34223f25..a301812c5e 100644 --- a/source/java/org/alfresco/repo/copy/CompoundCopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/CompoundCopyBehaviourCallback.java @@ -122,13 +122,13 @@ public class CompoundCopyBehaviourCallback extends AbstractCopyBehaviourCallback } return bestAction; } - - /** - * Individual callbacks effectively have a veto on the copy i.e. if one of the - * callbacks returns false for {@link CopyBehaviourCallback#getMustCopy(org.alfresco.service.namespace.QName, org.alfresco.repo.copy.CopyDetails)}, - * then the copy will NOT proceed. However, a warning is generated indicating that - * there is a conflict in the defined behaviour. - * + + /** + * Individual callbacks effectively have a veto on the copy i.e. if one of the + * callbacks returns false for {@link CopyBehaviourCallback#getMustCopy(org.alfresco.service.namespace.QName, org.alfresco.repo.copy.CopyDetails)}, + * then the copy will NOT proceed. However, a warning is generated indicating that + * there is a conflict in the defined behaviour. + * * @return Returns true if all registered callbacks return true * or false if any of the registered callbacks return false. */ @@ -181,7 +181,7 @@ public class CompoundCopyBehaviourCallback extends AbstractCopyBehaviourCallback } /** - * Uses the {@link ChildAssocCopyAction} ordering to drive priority i.e. a vote + * Uses the ChildAssocCopyAction ordering to drive priority i.e. a vote * to copy will override a vote NOT to copy. * * @return Returns the most lively choice of action @@ -217,7 +217,7 @@ public class CompoundCopyBehaviourCallback extends AbstractCopyBehaviourCallback } /** - * Uses the {@link ChildAssocRecurseAction} ordering to drive recursive copy behaviour. + * Uses the ChildAssocRecurseAction ordering to drive recursive copy behaviour. * * @return Returns the most lively choice of action */ diff --git a/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java index 54b1bc6d97..cd881de976 100644 --- a/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java @@ -52,7 +52,7 @@ public interface CopyBehaviourCallback * Always copy the association. *
    * Note that this can cause duplicate associations when copying over - * {@link CopyAssociationDetails#isTargetNodeIsNew() existing target nodes}. + * {@link CopyAssociationDetails#copyTargetIsNew existing target nodes}. */ COPY, /** @@ -361,13 +361,13 @@ public interface CopyBehaviourCallback * @param classQName the name of the class that this is being invoked for * @param copyDetails the source node's copy details for quick reference * @param childAssocCopyDetails all other details relating to the child association - * @return Returns the type of {@link ChildAssocRecurseAction recursion} - * to perform after having copied the child association - * - * @see #getChildAssociationCopyAction(QName, CopyDetails, CopyChildAssociationDetails) - */ - ChildAssocRecurseAction getChildAssociationRecurseAction( - QName classQName, + * @return Returns the type of {@link ChildAssocRecurseAction recursion} + * to perform after having copied the child association + * + * @see #getChildAssociationCopyAction(QName, CopyDetails, CopyChildAssociationDetails) + */ + ChildAssocRecurseAction getChildAssociationRecurseAction( + QName classQName, CopyDetails copyDetails, CopyChildAssociationDetails childAssocCopyDetails); diff --git a/source/java/org/alfresco/repo/copy/CopyServiceImpl.java b/source/java/org/alfresco/repo/copy/CopyServiceImpl.java index 77ccecc9ac..c34d5b39a9 100644 --- a/source/java/org/alfresco/repo/copy/CopyServiceImpl.java +++ b/source/java/org/alfresco/repo/copy/CopyServiceImpl.java @@ -1402,7 +1402,7 @@ public class CopyServiceImpl extends AbstractBaseCopyService implements CopyServ /** * Callback behaviour retrieval for {@link ContentModel#TYPE_FOLDER} aspect. * - * @return Returns {@link FolderTypeCopyBehaviourCallback} + * @return Returns FolderTypeCopyBehaviourCallback.INSTANCE */ public CopyBehaviourCallback getCallbackForFolderType(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/copy/DefaultCopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/DefaultCopyBehaviourCallback.java index 743fa56b97..baecbe1f76 100644 --- a/source/java/org/alfresco/repo/copy/DefaultCopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/DefaultCopyBehaviourCallback.java @@ -65,8 +65,8 @@ public class DefaultCopyBehaviourCallback extends AbstractCopyBehaviourCallback /** * Default behaviour:
    - * * {@link AssocCopySourceAction#COPY_REMOVE_EXISTING}
    - * * {@link AssocCopyTargetAction#USE_COPIED_OTHERWISE_ORIGINAL_TARGET} + * * AssocCopySourceAction.COPY_REMOVE_EXISTING
    + * * AssocCopyTargetAction.USE_COPIED_OTHERWISE_ORIGINAL_TARGET */ @Override public Pair getAssociationCopyAction( diff --git a/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java b/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java index c76ba5e433..04b6eeb0d5 100644 --- a/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java +++ b/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java @@ -106,7 +106,7 @@ implements TenantDeployer, DictionaryListener, /*TenantDictionaryListener, */Mes /** * Sets the Dictionary DAO * - * @param dictionaryDAO + * @param dictionaryDAO DictionaryDAO */ public void setDictionaryDAO(DictionaryDAO dictionaryDAO) { diff --git a/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java b/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java index 97624b84fa..a6f3f63da3 100644 --- a/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java +++ b/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java @@ -111,7 +111,7 @@ public class ModelValidatorImpl implements ModelValidator /** * validate against repository contents / workflows (e.g. when deleting an existing model) * - * @param modelName + * @param modelName QName */ public void validateModelDelete(final QName modelName) { @@ -303,7 +303,7 @@ public class ModelValidatorImpl implements ModelValidator * - no deletion of types, aspects or properties or associations * - no addition, update or deletion of default/mandatory aspects * - * @param compiledModel + * @param compiledModel CompiledModel */ @Override public void validateModel(CompiledModel compiledModel) diff --git a/source/java/org/alfresco/repo/dictionary/types/period/AbstractCalendarPeriodProvider.java b/source/java/org/alfresco/repo/dictionary/types/period/AbstractCalendarPeriodProvider.java index 2d114e4cb7..f9fdd0c92b 100644 --- a/source/java/org/alfresco/repo/dictionary/types/period/AbstractCalendarPeriodProvider.java +++ b/source/java/org/alfresco/repo/dictionary/types/period/AbstractCalendarPeriodProvider.java @@ -72,8 +72,8 @@ public abstract class AbstractCalendarPeriodProvider extends AbstractPeriodProvi /** * Implementation add - * @param calendar - * @param value + * @param calendar Calendar + * @param value int */ public abstract void add(Calendar calendar, int value); diff --git a/source/java/org/alfresco/repo/dictionary/types/period/AbstractEndOfCalendarPeriodProvider.java b/source/java/org/alfresco/repo/dictionary/types/period/AbstractEndOfCalendarPeriodProvider.java index f6518c60ed..525c5bbe66 100644 --- a/source/java/org/alfresco/repo/dictionary/types/period/AbstractEndOfCalendarPeriodProvider.java +++ b/source/java/org/alfresco/repo/dictionary/types/period/AbstractEndOfCalendarPeriodProvider.java @@ -42,7 +42,7 @@ public abstract class AbstractEndOfCalendarPeriodProvider extends AbstractCalend /** * Set the start day of the month (as defined by Calendar) - * @param startDayOfMonth + * @param startDayOfMonth int */ public void setStartDayOfMonth(int startDayOfMonth) { @@ -60,7 +60,7 @@ public abstract class AbstractEndOfCalendarPeriodProvider extends AbstractCalend /** * Set the start month (as defined by Calendar) - * @param startMonth + * @param startMonth int */ public void setStartMonth(int startMonth) { diff --git a/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java b/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java index 6b07db2ed2..7a05a3fde5 100644 --- a/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java +++ b/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java @@ -58,7 +58,7 @@ public interface ContentDataDAO * Creates an immediately-orphaned content URL, if possible * * @param contentUrl the URL to create if it doesn't exist - * @parma orphanTime the recorded orphan time or null to apply the current time + * @param orphanTime the recorded orphan time or null to apply the current time * @return Returns the ID-URL pair * @throws DataIntegrityViolationException if the URL already exists */ @@ -136,6 +136,8 @@ public interface ContentDataDAO * @return null if the url does not exist * * @since 5.0 + * @param contentUrl + * @return */ ContentUrlEntity getContentUrl(String contentUrl); @@ -145,6 +147,8 @@ public interface ContentDataDAO * @return null if the url does not exist * * @since 5.0 + * @param contentUrlId + * @return */ ContentUrlEntity getContentUrl(Long contentUrlId); @@ -152,6 +156,7 @@ public interface ContentDataDAO * Get a content URL or create one if it does not exist * * @since 5.1 + * @param contentUrlEntity */ ContentUrlEntity getOrCreateContentUrl(String contentUrl); @@ -159,31 +164,36 @@ public interface ContentDataDAO * Updates the content key for the given content url * * @since 5.0 + * @param contentUrl + * @param contentUrlKeyEntity */ boolean updateContentUrlKey(String contentUrl, ContentUrlKeyEntity contentUrlKeyEntity); /** * Updates the content key for the given content url - * - * @since 5.0 - */ - boolean updateContentUrlKey(long contentUrlId, ContentUrlKeyEntity contentUrlKey); - + * + * @since 5.0 + * @param contentUrlId + */ + boolean updateContentUrlKey(long contentUrlId, ContentUrlKeyEntity contentUrlKey); + /** * Get symmetric keys entities for symmetric keys that have been encrypted using the given - * master key, starting from 'fromId' and returning at most 'maxResults' entities. - * - * @since 5.0 - * @param masterKeyAlias master key alias - * @param fromId id - * @param maxResults max results - */ - List getSymmetricKeysByMasterKeyAlias(String masterKeyAlias, long fromId, int maxResults); + * master key, starting from 'fromId' and returning at most 'maxResults' entities. + * + * @since 5.0 + * @param masterKeyAlias master key alias + * @param fromId id + * @param maxResults max results + * @return + */ + List getSymmetricKeysByMasterKeyAlias(String masterKeyAlias, long fromId, int maxResults); /** * Count symmetric keys entities for symmetric keys for all master keys * * @since 5.0 + * @return */ Map countSymmetricKeysForMasterKeys(); @@ -192,6 +202,8 @@ public interface ContentDataDAO * master key * * @since 5.0 + * @param masterKeyAlias + * @return */ int countSymmetricKeysForMasterKeyAlias(String masterKeyAlias); } diff --git a/source/java/org/alfresco/repo/domain/contentdata/ContentUrlEntity.java b/source/java/org/alfresco/repo/domain/contentdata/ContentUrlEntity.java index 6e829b737a..0701bf5d18 100644 --- a/source/java/org/alfresco/repo/domain/contentdata/ContentUrlEntity.java +++ b/source/java/org/alfresco/repo/domain/contentdata/ContentUrlEntity.java @@ -95,7 +95,7 @@ public class ContentUrlEntity implements Serializable } /** - * @param + * @param internalContentUrl String * @return Returns a pair of the short (12 chars lowercase) URL and the CRC value */ private static Pair getContentUrlCrcPair(String internalContentUrl) diff --git a/source/java/org/alfresco/repo/domain/locks/LockDAO.java b/source/java/org/alfresco/repo/domain/locks/LockDAO.java index c07bbc1b48..6efa6bb110 100644 --- a/source/java/org/alfresco/repo/domain/locks/LockDAO.java +++ b/source/java/org/alfresco/repo/domain/locks/LockDAO.java @@ -37,9 +37,8 @@ public interface LockDAO * * @param lockQName the unique name of the lock to acquire * @param lockToken the potential lock token (max 36 chars) - * @param timeToLive the time (in milliseconds) that the lock must remain - * @return Returns true if the lock was taken, - * otherwise false + * @param timeToLive the time (in milliseconds) that the lock must remain + * * @throws LockAcquisitionException on failure */ void getLock(QName lockQName, String lockToken, long timeToLive); @@ -52,8 +51,7 @@ public interface LockDAO * @param lockQName the unique name of the lock to update * @param lockToken the lock token for the lock held * @param timeToLive the new time to live (in milliseconds) - * @return Returns true if the lock was updated, - * otherwise false + * * @throws LockAcquisitionException on failure */ void refreshLock(QName lockQName, String lockToken, long timeToLive); diff --git a/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java b/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java index 621e4c9a3e..d1d4a19820 100644 --- a/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java @@ -486,7 +486,6 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO * Get the ID of the current server, or null if there is no ID for the current * server and one can't be created. * - * @see ServerIdCallback */ protected Long getServerId() { @@ -1067,7 +1066,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO /** * Trigger a post transaction prune of any associations that point to this deleted one. - * @param nodeId + * @param nodeId Long */ private void pruneDanglingAssocs(Long nodeId) { @@ -1699,7 +1698,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO * @param invalidateNodePropertiesCache true if the node's cached properties are unreliable * @param invalidateParentAssocsCache true if the node's cached parent assocs are unreliable * - * @see #updateNodeImpl(Node, NodeUpdateEntity, Set) + * @see #updateNodeImpl(Node, NodeUpdateEntity, Set) */ private boolean touchNode( Long nodeId, AuditablePropertiesEntity auditableProps, Set nodeAspects, @@ -2547,7 +2546,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO } /** - * Callback to cache node properties. The DAO callback only does the simple {@link #findByKey(Long)}. + * Callback to cache node properties. The DAO callback only does the simple {@link #findByKey(Serializable)}. * * @author Derek Hulley * @since 3.4 @@ -2804,7 +2803,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO } /** - * Callback to cache node aspects. The DAO callback only does the simple {@link #findByKey(Long)}. + * Callback to cache node aspects. The DAO callback only does the simple {@link #findByKey(Serializable)}. * * @author Derek Hulley * @since 3.4 @@ -4103,8 +4102,8 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO private int parentCount; /** - * @param size - * @param limitFactor + * @param size int + * @param limitFactor int */ public ParentAssocsCache(int size, int limitFactor) { diff --git a/source/java/org/alfresco/repo/domain/node/NodeDAO.java b/source/java/org/alfresco/repo/domain/node/NodeDAO.java index cc26f7ce39..d0112883c2 100644 --- a/source/java/org/alfresco/repo/domain/node/NodeDAO.java +++ b/source/java/org/alfresco/repo/domain/node/NodeDAO.java @@ -67,13 +67,13 @@ public interface NodeDAO extends NodeBulkLoader /* * Transaction - */ - - /** - * @param ensureNew true to ensure that a new transaction entry is created - * if the current transaction does not have one. - * @return Returns the ID of the current transaction entry or null if - * there have not been any modifications to nodes registered in the + */ + + /** + * @param ensureNew true to ensure that a new transaction entry is created + * if the current transaction does not have one. + * @return Returns the ID of the current transaction entry or null if + * there have not been any modifications to nodes registered in the * transaction and forceNew is false */ public Long getCurrentTransactionId(boolean ensureNew); @@ -190,7 +190,7 @@ public interface NodeDAO extends NodeBulkLoader * @param storeRef the store to which the node must belong * @param uuid the node store-unique identifier, or null to assign a GUID * @param nodeTypeQName the type of the node - * @parma nodeLocale the locale of the node + * @param nodeLocale the locale of the node * @param childNodeName the cm:name of the child node or null to use the node's UUID * @param auditableProperties a map containing any cm:auditable properties for the node * @return Returns the details of the child association created @@ -349,13 +349,13 @@ public interface NodeDAO extends NodeBulkLoader /** * Pull the cm:modified up to the current time without changing any other * cm:auditable properties. The change may be done in the current transaction - * or in a later transaction. - * - * @param nodeId the node to change - * @param date the date to set for cm:modified - * @return Returns true if the cm:modified property was actually set - * @deprecated Use {@link #setModifiedProperties(Long, Date, String)} to also change the cm:modifier property - */ + * or in a later transaction. + * + * @param nodeId the node to change + * @param date the date to set for cm:modified + * @return Returns true if the cm:modified property was actually set + * @deprecated Use {@link #setModifiedProperties(Long, Date, String)} to also change the cm:modifier property + */ public boolean setModifiedDate(Long nodeId, Date date); /** @@ -419,15 +419,15 @@ public interface NodeDAO extends NodeBulkLoader */ public void setNodeAssocIndex(Long id, int assocIndex); - /** - * Remove a specific node association - * - * @param sourceNodeId the source node ID - * @param targetNodeId the target node id - * @param assocTypeQName the node association QName - * @return Returns the number of associations removed - */ - public int removeNodeAssoc(Long sourceNodeId, Long targetNodeId, QName assocTypeQName); + /** + * Remove a specific node association + * + * @param sourceNodeId the source node ID + * @param targetNodeId the target node id + * @param assocTypeQName the node association QName + * @return Returns the number of associations removed + */ + public int removeNodeAssoc(Long sourceNodeId, Long targetNodeId, QName assocTypeQName); /** * Remove all node associations of given IDs @@ -532,13 +532,13 @@ public interface NodeDAO extends NodeBulkLoader * Sets the association index ordering. * * @param parentNodeId the parent node ID - * @param childNodeId the child node ID - * @param assocTypeQName the association type - * @param assocQName the association path qualified name - * @param index the new index - * @return Returns the number of associations modified - */ - public int setChildAssocIndex( + * @param childNodeId the child node ID + * @param assocTypeQName the association type + * @param assocQName the association path qualified name + * @param index the new index + * @return Returns the number of associations modified + */ + public int setChildAssocIndex( Long parentNodeId, Long childNodeId, QName assocTypeQName, @@ -615,7 +615,6 @@ public interface NodeDAO extends NodeBulkLoader * @param maxResults the maximum number of results to return. The query will be terminated efficiently * after that number of results * @param resultsCallback the callback that will be called with the results - * @return a list of child associations */ public void getChildAssocs( Long parentNodeId, @@ -723,13 +722,13 @@ public interface NodeDAO extends NodeBulkLoader /** * Build the paths for a node. * - * When searching for primaryOnly == true, checks that there is exactly - * one path. - * - * @param nodePair the leave or child node to start with - * @param primaryOnly true to follow only primary parent associations - */ - public List getPaths(Pair nodePair, boolean primaryOnly) throws InvalidNodeRefException; + * When searching for primaryOnly == true, checks that there is exactly + * one path. + * + * @param nodePair the leave or child node to start with + * @param primaryOnly true to follow only primary parent associations + */ + public List getPaths(Pair nodePair, boolean primaryOnly) throws InvalidNodeRefException; /** * Perform a check for cyclic relationships @@ -808,7 +807,7 @@ public interface NodeDAO extends NodeBulkLoader * @param fromCommitTime delete unused transactions from commit time * @param toCommitTime delete unused transactions to commit time * - * @return + * @return int */ public int deleteTxnsUnused(long fromCommitTime, long toCommitTime); diff --git a/source/java/org/alfresco/repo/domain/node/NodePropertyKey.java b/source/java/org/alfresco/repo/domain/node/NodePropertyKey.java index 472df81c38..b517d62bcc 100644 --- a/source/java/org/alfresco/repo/domain/node/NodePropertyKey.java +++ b/source/java/org/alfresco/repo/domain/node/NodePropertyKey.java @@ -23,7 +23,7 @@ import java.io.Serializable; import org.alfresco.util.EqualsHelper; /** - * Compound key for persistence of {@link org.alfresco.repo.domain.Node} + * Compound key for persistence of {@link org.alfresco.repo.domain.node.Node} * * @author Derek Hulley * @since 3.4 diff --git a/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java b/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java index 5623a8a788..a4041ed2e9 100644 --- a/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java +++ b/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java @@ -244,13 +244,13 @@ public class NodePropertyValue implements Cloneable, Serializable public Integer getOrdinalNumber() { return Integer.valueOf(6); - } - - /** - * Strings longer than the maximum of {@link org.alfresco.repo.domain.schema.SchemaBootstrap#DEFAULT_MAX_STRING_LENGTH} - * characters will be serialized. - */ - @Override + } + + /** + * Strings longer than the maximum of {@link org.alfresco.repo.domain.schema.SchemaBootstrap#DEFAULT_MAX_STRING_LENGTH} + * characters will be serialized. + */ + @Override protected ValueType getPersistedType(Serializable value) { if (value instanceof String) @@ -640,7 +640,6 @@ public class NodePropertyValue implements Cloneable, Serializable * Converts a value to this type. The implementation must be able to cope with any legitimate * source value. * - * @see DefaultTypeConverter.INSTANCE#convert(Class, Object) */ abstract Serializable convert(Serializable value); } @@ -977,7 +976,7 @@ public class NodePropertyValue implements Cloneable, Serializable * No conversion is done. * * @param persistedType the value type - * @param value the value - it may only be null if the persisted type is {@link ValueType#NULL} + * @param value the value - it may only be null if the persisted type is {@code ValueType#NULL} */ public void setPersistedValue(ValueType persistedType, Serializable value) { diff --git a/source/java/org/alfresco/repo/domain/patch/PatchDAO.java b/source/java/org/alfresco/repo/domain/patch/PatchDAO.java index 1a4443688f..c41c779c89 100644 --- a/source/java/org/alfresco/repo/domain/patch/PatchDAO.java +++ b/source/java/org/alfresco/repo/domain/patch/PatchDAO.java @@ -104,7 +104,7 @@ public interface PatchDAO * @param aspectQNameId - the id of the aspect qname * @param minNodeId - min node id in the result set - inclusive * @param maxNodeId - max node id in the result set - exclusive - * @return + * @return List */ public List getNodesByTypeQNameAndAspectQNameId(long typeQNameId, long aspectQNameId, long minNodeId, long maxNodeId); diff --git a/source/java/org/alfresco/repo/domain/permissions/ADMPermissionsDaoComponentImpl.java b/source/java/org/alfresco/repo/domain/permissions/ADMPermissionsDaoComponentImpl.java index 2002974b83..0e15318bd0 100644 --- a/source/java/org/alfresco/repo/domain/permissions/ADMPermissionsDaoComponentImpl.java +++ b/source/java/org/alfresco/repo/domain/permissions/ADMPermissionsDaoComponentImpl.java @@ -152,8 +152,8 @@ public class ADMPermissionsDaoComponentImpl extends AbstractPermissionsDaoCompon /** - * @param nodeRef - * @param acl + * @param nodeRef NodeRef + * @param acl Acl */ private void replaceWithCleanDefiningAcl(NodeRef nodeRef, Acl acl) { diff --git a/source/java/org/alfresco/repo/domain/permissions/AbstractAclCrudDAOImpl.java b/source/java/org/alfresco/repo/domain/permissions/AbstractAclCrudDAOImpl.java index 0f6f638775..315c7872e0 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AbstractAclCrudDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/permissions/AbstractAclCrudDAOImpl.java @@ -1049,7 +1049,7 @@ public abstract class AbstractAclCrudDAOImpl implements AclCrudDAO /** - * @return + * @return Long */ protected abstract Long selectMaxChangeSetCommitTime(); @@ -1065,8 +1065,8 @@ public abstract class AbstractAclCrudDAOImpl implements AclCrudDAO } /** - * @param maxCommitTime - * @return + * @param maxCommitTime long + * @return Long */ protected abstract Long selectMaxChangeSetIdBeforeCommitTime(long maxCommitTime); } diff --git a/source/java/org/alfresco/repo/domain/permissions/AbstractPermissionsDaoComponentImpl.java b/source/java/org/alfresco/repo/domain/permissions/AbstractPermissionsDaoComponentImpl.java index 7d7b243a51..4ad4e69323 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AbstractPermissionsDaoComponentImpl.java +++ b/source/java/org/alfresco/repo/domain/permissions/AbstractPermissionsDaoComponentImpl.java @@ -81,7 +81,7 @@ public abstract class AbstractPermissionsDaoComponentImpl implements Permissions /** * Set the ACL DAO component - * @param aclDaoComponent + * @param aclDaoComponent AclDAO */ public void setAclDAO(AclDAO aclDaoComponent) { @@ -115,7 +115,7 @@ public abstract class AbstractPermissionsDaoComponentImpl implements Permissions /** * Set the mapping of protocol to DAO - * @param map + * @param map Map */ public void setProtocolToACLDAO(Map map) { @@ -124,7 +124,7 @@ public abstract class AbstractPermissionsDaoComponentImpl implements Permissions /** * Set the default DAO - * @param defaultACLDAO + * @param defaultACLDAO AccessControlListDAO */ public void setDefaultACLDAO(AccessControlListDAO defaultACLDAO) { @@ -650,7 +650,7 @@ public abstract class AbstractPermissionsDaoComponentImpl implements Permissions /** * Set the change list * - * @param changes + * @param changes List */ public void setChanges(List changes) { @@ -659,7 +659,7 @@ public abstract class AbstractPermissionsDaoComponentImpl implements Permissions /** * Set the ACL that was created - * @param created + * @param created Acl */ public void setCreated(Acl created) { diff --git a/source/java/org/alfresco/repo/domain/permissions/Acl.java b/source/java/org/alfresco/repo/domain/permissions/Acl.java index 76358e33ae..aee80178ad 100644 --- a/source/java/org/alfresco/repo/domain/permissions/Acl.java +++ b/source/java/org/alfresco/repo/domain/permissions/Acl.java @@ -32,25 +32,25 @@ public interface Acl extends AccessControlListProperties { /** * Get the long key - * @return + * @return Long */ public Long getId(); /** * Get the ACL ID - * @return + * @return String */ public String getAclId(); /** * Get the ACL version - * @return + * @return Long */ public Long getAclVersion(); /** * Is this the latest version of the acl identified by the acl id string? - * @return + * @return Boolean */ public Boolean isLatest(); @@ -63,21 +63,21 @@ public interface Acl extends AccessControlListProperties /** * Get the ACL from which this one inherits * - * @return + * @return Long */ public Long getInheritsFrom(); /** * Get the type for this ACL * - * @return + * @return ACLType */ public ACLType getAclType(); /** * Get the ACL inherited from nodes which have this ACL * - * @return + * @return Long */ public Long getInheritedAcl(); @@ -87,7 +87,7 @@ public interface Acl extends AccessControlListProperties * * If an acl is versioned it can not be updated - a new copy has to be created, * - * @return + * @return Boolean */ public Boolean isVersioned(); diff --git a/source/java/org/alfresco/repo/domain/permissions/AclCrudDAO.java b/source/java/org/alfresco/repo/domain/permissions/AclCrudDAO.java index 27c7f98207..53bb1cb6be 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AclCrudDAO.java +++ b/source/java/org/alfresco/repo/domain/permissions/AclCrudDAO.java @@ -118,12 +118,12 @@ public interface AclCrudDAO public void renameAuthority(String authorityNameBefore, String authorityAfter); public void deleteAuthority(long authorityEntityId); /** - * @return + * @return Long */ public Long getMaxChangeSetCommitTime(); /** - * @param maxCommitTime - * @return + * @param maxCommitTime long + * @return Long */ public Long getMaxChangeSetIdByCommitTime(long maxCommitTime); diff --git a/source/java/org/alfresco/repo/domain/permissions/AclDAO.java b/source/java/org/alfresco/repo/domain/permissions/AclDAO.java index 9ef43fde0e..73b9ee1b80 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AclDAO.java +++ b/source/java/org/alfresco/repo/domain/permissions/AclDAO.java @@ -157,22 +157,22 @@ public interface AclDAO public void renameAuthority(String before, String after); - public void deleteAclForNode(long aclId); - - /** - * @param shared - * @param defining - */ - public void fixSharedAcl(Long shared, Long defining); - + public void deleteAclForNode(long aclId); + /** - * @return + * @param shared Long + * @param defining Long + */ + public void fixSharedAcl(Long shared, Long defining); + + /** + * @return Long */ public Long getMaxChangeSetCommitTime(); /** - * @param maxCommitTime - * @return + * @param maxCommitTime long + * @return Long */ public Long getMaxChangeSetIdByCommitTime(long maxCommitTime); } diff --git a/source/java/org/alfresco/repo/domain/permissions/AclDAOImpl.java b/source/java/org/alfresco/repo/domain/permissions/AclDAOImpl.java index d71357fa39..69fff8a31f 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AclDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/permissions/AclDAOImpl.java @@ -129,7 +129,7 @@ public class AclDAOImpl implements AclDAO /** * Set the ACL cache * - * @param aclCache + * @param aclCache SimpleCache */ public void setAclCache(SimpleCache aclCache) { @@ -1802,7 +1802,7 @@ public class AclDAOImpl implements AclDAO } /** - * @param after + * @param after Long */ public void setAfter(Long after) { @@ -1810,7 +1810,7 @@ public class AclDAOImpl implements AclDAO } /** - * @param before + * @param before Long */ public void setBefore(Long before) { @@ -1823,7 +1823,7 @@ public class AclDAOImpl implements AclDAO } /** - * @param typeAfter + * @param typeAfter ACLType */ public void setTypeAfter(ACLType typeAfter) { @@ -1836,7 +1836,7 @@ public class AclDAOImpl implements AclDAO } /** - * @param typeBefore + * @param typeBefore ACLType */ public void setTypeBefore(ACLType typeBefore) { diff --git a/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java b/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java index 9d198c3464..5151fd7d92 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java +++ b/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java @@ -138,13 +138,13 @@ public class AclMemberEntity implements AclMember return pos; } - /** - * Set the position for the ACL-ACE relationship - * - * @param pos - */ - public void setPos(Integer pos) - { + /** + * Set the position for the ACL-ACE relationship + * + * @param pos Integer + */ + public void setPos(Integer pos) + { this.pos = pos; } diff --git a/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java b/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java index cc9d433d5d..67a75f97c5 100644 --- a/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java +++ b/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java @@ -196,13 +196,12 @@ public interface PropertyValueDAO * alf_prop_value accessor: find or create a property based on the value. * Note: This method will not recurse into maps or collections. Use the * dedicated methods if you want recursion; otherwise maps and collections will - * be serialized and probably stored as BLOB values. - *

    - * All collections and maps will be opened up to any depth. To limit this behaviour, - * use {@link #getOrCreatePropertyValue(Serializable)}. - * - * @param value the value to find the ID for (may be null) - */ + * be serialized and probably stored as BLOB values. + *

    + * All collections and maps will be opened up to any depth. + * + * @param value the value to find the ID for (may be null) + */ Pair getOrCreatePropertyValue(Serializable value); //================================ @@ -290,15 +289,15 @@ public interface PropertyValueDAO Serializable propertyValue1); /** * Get the unique context ID and associated shared property ID, or null if no - * such context exists. The associated property may be null even if the unique - * context exists. - * - * @param value1 first value - * @param value2 second value - * @param value3 third value - * @return Returns the ID-valueId pair or null if the context - * doesn't exist. - * + * such context exists. The associated property may be null even if the unique + * context exists. + * + * @param value1 first value + * @param value2 second value + * @param value3 third value + * @return Returns the ID-valueId pair or null if the context + * doesn't exist. + * * @see #createPropertyUniqueContext(Serializable, Serializable, Serializable, Serializable) */ Pair getPropertyUniqueContext(Serializable value1, Serializable value2, Serializable value3); diff --git a/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java b/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java index 126b5218c2..644e4b3b36 100644 --- a/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java +++ b/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java @@ -57,13 +57,13 @@ public interface CannedQueryDAO * * @param the return value's type * @param sqlNamespace the query namespace (defined by config file) e.g. alfresco.query.usage - * @param queryName the name of the query e.g. select_userCount - * @param parameterObj the values to drive the selection (may be null if not required) - * @return the unique result (never null) - * @throws IllegalArgumentException concurrency-related exception if a single object was not found - */ - R executeQueryUnique(String sqlNamespace, String queryName, Object parameterObj); - + * @param queryName the name of the query e.g. select_userCount + * @param parameterObj the values to drive the selection (may be null if not required) + * @return the unique result (never null) + * @throws IllegalArgumentException concurrency-related exception if a single object was not found + */ + R executeQueryUnique(String sqlNamespace, String queryName, Object parameterObj); + /** * Execute a query that returns one or more results. * @@ -90,7 +90,6 @@ public interface CannedQueryDAO * @param offset the number of results to skip * @param limit the maximum number of results to retrieve or Integer.MAX_VALUE * for no limit - * @return the list of results */ void executeQuery( String sqlNamespace, diff --git a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java index 21f528952b..ffaf163cc4 100644 --- a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java +++ b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java @@ -234,7 +234,7 @@ public class SchemaBootstrap extends AbstractLifecycleBean /** * Defines the DatabaseMetaDataHelper to be used * - * @param databaseMetaDataHelper + * @param databaseMetaDataHelper DatabaseMetaDataHelper */ public void setDatabaseMetaDataHelper(DatabaseMetaDataHelper databaseMetaDataHelper) { @@ -1839,7 +1839,8 @@ public class SchemaBootstrap extends AbstractLifecycleBean * Collate differences and validation problems with the schema with respect to an appropriate * reference schema. * - * @param outputFileNameTemplate + * @param outputFileNameTemplate String + * @param out PrintWriter * @return the number of potential problems found. */ public synchronized int validateSchema(String outputFileNameTemplate, PrintWriter out) @@ -2038,7 +2039,7 @@ public class SchemaBootstrap extends AbstractLifecycleBean * If dbPrefixes is null, then the default list is used (see {@link MultiFileDumper#DEFAULT_PREFIXES}) * The dump files' paths are logged at info level. * - * @param whenDumped + * @param whenDumped String * @param dbPrefixes Array of database object prefixes to filter by, e.g. "alf_" * @return List of output files. */ @@ -2066,8 +2067,8 @@ public class SchemaBootstrap extends AbstractLifecycleBean * of database object prefixes is used for filtering. * * @see #dumpSchema(String, String[]) - * @param whenDumped - * @return + * @param whenDumped String + * @return List */ private List dumpSchema(String whenDumped) { diff --git a/source/java/org/alfresco/repo/domain/schema/script/ScriptExecutorImpl.java b/source/java/org/alfresco/repo/domain/schema/script/ScriptExecutorImpl.java index 585af1f058..3cb26b9a0f 100644 --- a/source/java/org/alfresco/repo/domain/schema/script/ScriptExecutorImpl.java +++ b/source/java/org/alfresco/repo/domain/schema/script/ScriptExecutorImpl.java @@ -244,9 +244,9 @@ public class ScriptExecutorImpl implements ScriptExecutor * classpath:alfresco/db/org.hibernate.dialect.MySQLInnoDBDialect/myfile.xml * * - * @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

    - * @param behaviour - * @param definition - * @param policyInterface - * @param method - * @param args + * @param

    P extends Policy + * @param behaviour Behaviour + * @param definition PolicyDefinition

    + * @param policyInterface P + * @param method Method + * @param args Object[] */ @SuppressWarnings("unchecked") public

    void queue(Behaviour behaviour, PolicyDefinition

    definition, P policyInterface, Method method, Object[] args) @@ -234,7 +234,7 @@ public class TransactionBehaviourQueue implements TransactionListener /** * Execute behaviour as described in execution context * - * @param context + * @param context ExecutionContext */ private void execute(ExecutionContext context) { diff --git a/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java b/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java index a7d8e62719..ef76f641e2 100644 --- a/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java +++ b/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java @@ -53,11 +53,11 @@ public class TransactionInvocationHandlerFactory /** * Create Invocation Handler - * - * @param

    - * @param behaviour - * @param definition - * @param policyInterface + * + * @param

    P extends Policy + * @param behaviour Behaviour + * @param definition PolicyDefinition

    + * @param policyInterface P * @return invocation handler */ public

    InvocationHandler createHandler(Behaviour behaviour, PolicyDefinition

    definition, P policyInterface) diff --git a/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java b/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java index 38fe125bc3..6753efd4b7 100644 --- a/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java +++ b/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java @@ -220,13 +220,13 @@ public class AnnotatedBehaviourPostProcessor implements BeanPostProcessor return policy; } - /** - * - * @param behaviourBean - * @param behaviour - * @return - */ - private QName resolveType(BehaviourBean behaviourBean, Behaviour behaviour) + /** + * + * @param behaviourBean BehaviourBean + * @param behaviour Behaviour + * @return QName + */ + private QName resolveType(BehaviourBean behaviourBean, Behaviour behaviour) { QName type = null; if (!behaviour.isService()) @@ -247,8 +247,8 @@ public class AnnotatedBehaviourPostProcessor implements BeanPostProcessor /** * - * @param name - * @return + * @param name String + * @return QName */ private QName toQName(String name) { diff --git a/source/java/org/alfresco/repo/preference/PreferenceServiceImpl.java b/source/java/org/alfresco/repo/preference/PreferenceServiceImpl.java index 853f1fd1ed..dd994446de 100644 --- a/source/java/org/alfresco/repo/preference/PreferenceServiceImpl.java +++ b/source/java/org/alfresco/repo/preference/PreferenceServiceImpl.java @@ -188,9 +188,6 @@ public class PreferenceServiceImpl implements PreferenceService return preferenceValue; } - /** - * @see org.alfresco.repo.person.PersonService#getPreferences(java.lang.String, java.lang.String) - */ @SuppressWarnings({ "unchecked" }) public Map getPreferences(String userName, String preferenceFilter) { @@ -357,10 +354,6 @@ public class PreferenceServiceImpl implements PreferenceService return result; } - /** - * @see org.alfresco.repo.person.PersonService#setPreferences(java.lang.String, - * java.util.HashMap) - */ public void setPreferences(final String userName, final Map preferences) { // Get the user node reference @@ -469,10 +462,6 @@ public class PreferenceServiceImpl implements PreferenceService clearPreferences(userName, null); } - /** - * @see org.alfresco.repo.person.PersonService#clearPreferences(java.lang.String, - * java.lang.String) - */ public void clearPreferences(final String userName, final String preferenceFilter) { // Get the user node reference diff --git a/source/java/org/alfresco/repo/preference/script/ScriptPreferenceService.java b/source/java/org/alfresco/repo/preference/script/ScriptPreferenceService.java index 92b5e849c5..18310847a5 100644 --- a/source/java/org/alfresco/repo/preference/script/ScriptPreferenceService.java +++ b/source/java/org/alfresco/repo/preference/script/ScriptPreferenceService.java @@ -168,8 +168,8 @@ public class ScriptPreferenceService extends BaseScopableProcessorExtension /** * Clear the preference values * - * @param userName - * @param preferenceFilter + * @param userName String + * @param preferenceFilter String */ public void clearPreferences(String userName, String preferenceFilter) { diff --git a/source/java/org/alfresco/repo/publishing/AbstractOAuth1ChannelType.java b/source/java/org/alfresco/repo/publishing/AbstractOAuth1ChannelType.java index 33afaccc55..8cf4514bb7 100644 --- a/source/java/org/alfresco/repo/publishing/AbstractOAuth1ChannelType.java +++ b/source/java/org/alfresco/repo/publishing/AbstractOAuth1ChannelType.java @@ -125,7 +125,7 @@ public abstract class AbstractOAuth1ChannelType extends AbstractChannelType * Override this method to add additonal parameters onto the URL that the user is redirected to * to authorise access to their account. By default, no parameters are added, but this may be useful to * specify things such as the permissions being sought, and so on. - * @param callbackUrl + * @param callbackUrl String * @return Do not return null. If no parameters are to be added, return {@link OAuth1Parameters#NONE} */ protected OAuth1Parameters getOAuth1Parameters(String callbackUrl) diff --git a/source/java/org/alfresco/repo/publishing/ChannelHelper.java b/source/java/org/alfresco/repo/publishing/ChannelHelper.java index 87fb692111..9d9781b388 100644 --- a/source/java/org/alfresco/repo/publishing/ChannelHelper.java +++ b/source/java/org/alfresco/repo/publishing/ChannelHelper.java @@ -114,9 +114,9 @@ public class ChannelHelper /** * Given a noderef from the editorial space (e.g. the doclib), this returns the corresponding noderef published to the specified channel. - * @param source - * @param channelNode - * @return + * @param source NodeRef + * @param channelNode NodeRef + * @return NodeRef */ public NodeRef mapSourceToEnvironment(NodeRef source, final NodeRef channelNode) { @@ -125,10 +125,10 @@ public class ChannelHelper /** * Given a noderef from the editorial space (e.g. the doclib), this returns the corresponding noderef published to the specified channel. - * @param source - * @param channelNode - * @param nodeService - * @return + * @param source NodeRef + * @param channelNode NodeRef + * @param nodeService NodeService + * @return NodeRef */ public static NodeRef mapSourceToEnvironment(NodeRef source, final NodeRef channelNode, final NodeService nodeService) { @@ -152,8 +152,8 @@ public class ChannelHelper /** * Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib). - * @param publishedNode - * @return + * @param publishedNode NodeRef + * @return NodeRef */ public NodeRef mapEnvironmentToSource(NodeRef publishedNode) { @@ -162,8 +162,9 @@ public class ChannelHelper /** * Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib). - * @param publishedNode - * @return + * @param publishedNode NodeRef + * @param nodeService NodeService + * @return NodeRef */ public static NodeRef mapEnvironmentToSource(NodeRef publishedNode, NodeService nodeService) { @@ -173,7 +174,7 @@ public class ChannelHelper /** * Finds the {@link Channel} NodeRef and {@link ChannelType} id for a given node, if such a Channel exists. - * @param node + * @param node NodeRef * @return a {@link Pair} containing the Channel {@link NodeRef} and ChannelType Id. */ public Pair findChannelAndType(NodeRef node) diff --git a/source/java/org/alfresco/repo/publishing/ChannelImpl.java b/source/java/org/alfresco/repo/publishing/ChannelImpl.java index 62c23510e8..f230be8fc4 100644 --- a/source/java/org/alfresco/repo/publishing/ChannelImpl.java +++ b/source/java/org/alfresco/repo/publishing/ChannelImpl.java @@ -201,8 +201,8 @@ public class ChannelImpl implements Channel * aspects and properties of the node are determined by the supplied * snapshot. * - * @param channel - * @param snapshot + * @param channel NodeRef + * @param snapshot NodeSnapshot * @return the newly published node. */ private NodeRef publishNewNode(NodeRef channel, NodeSnapshot snapshot) @@ -242,8 +242,8 @@ public class ChannelImpl implements Channel } /** - * @param publishedNode - * @param snapshotProps + * @param publishedNode NodeRef + * @param snapshotProps Map */ private void removeUnwantedProperties(NodeRef publishedNode, Map snapshotProps) { @@ -264,8 +264,8 @@ public class ChannelImpl implements Channel } /** - * @param publishedNode - * @param newAspects + * @param publishedNode NodeRef + * @param newAspects Set */ private void removeUnwantedAspects(NodeRef publishedNode, Set newAspects) { diff --git a/source/java/org/alfresco/repo/publishing/ChannelServiceImpl.java b/source/java/org/alfresco/repo/publishing/ChannelServiceImpl.java index 919f17e6fe..26cb5192dd 100644 --- a/source/java/org/alfresco/repo/publishing/ChannelServiceImpl.java +++ b/source/java/org/alfresco/repo/publishing/ChannelServiceImpl.java @@ -240,9 +240,6 @@ public class ChannelServiceImpl implements ChannelService return Collections.emptyList(); } - /** - * {@inheritDoc} - */ public List getAuthorisedStatusUpdateChannels() { return channelHelper.filterAuthorisedChannels(getStatusUpdateChannels(false)); diff --git a/source/java/org/alfresco/repo/publishing/Environment.java b/source/java/org/alfresco/repo/publishing/Environment.java index 1c3c1a2c82..1c36a61c6d 100644 --- a/source/java/org/alfresco/repo/publishing/Environment.java +++ b/source/java/org/alfresco/repo/publishing/Environment.java @@ -39,9 +39,6 @@ public class Environment this.channelsContainer = channelsContainer; } - /** - * {@inheritDoc} - */ public PublishingQueueImpl getPublishingQueue() { return queue; diff --git a/source/java/org/alfresco/repo/publishing/MockChannelType.java b/source/java/org/alfresco/repo/publishing/MockChannelType.java index 1d026c4646..0d98e659fc 100644 --- a/source/java/org/alfresco/repo/publishing/MockChannelType.java +++ b/source/java/org/alfresco/repo/publishing/MockChannelType.java @@ -46,25 +46,16 @@ public class MockChannelType extends AbstractChannelType return ID; } - /** - * {@inheritDoc} - */ public Map getCapabilities() { return null; } - /** - * {@inheritDoc} - */ public QName getChannelNodeType() { return PublishingModel.TYPE_DELIVERY_CHANNEL; } - /** - * {@inheritDoc} - */ public QName getContentRootNodeType() { return ContentModel.TYPE_FOLDER; diff --git a/source/java/org/alfresco/repo/publishing/NodeSnapshotTransferImpl.java b/source/java/org/alfresco/repo/publishing/NodeSnapshotTransferImpl.java index b48150e368..e2ddf10924 100644 --- a/source/java/org/alfresco/repo/publishing/NodeSnapshotTransferImpl.java +++ b/source/java/org/alfresco/repo/publishing/NodeSnapshotTransferImpl.java @@ -44,7 +44,7 @@ public class NodeSnapshotTransferImpl implements NodeSnapshot private final TransferManifestNormalNode transferNode; /** - * @param transferNode + * @param transferNode TransferManifestNormalNode */ public NodeSnapshotTransferImpl(TransferManifestNormalNode transferNode) { @@ -85,7 +85,7 @@ public class NodeSnapshotTransferImpl implements NodeSnapshot } /** - * @return + * @return List */ public List getOutboundPeerAssociations() { @@ -97,7 +97,7 @@ public class NodeSnapshotTransferImpl implements NodeSnapshot } /** - * @return + * @return ChildAssociationRef */ public ChildAssociationRef getPrimaryParentAssoc() { @@ -109,7 +109,7 @@ public class NodeSnapshotTransferImpl implements NodeSnapshot } /** - * @return + * @return Path */ public Path getPrimaryPath() { diff --git a/source/java/org/alfresco/repo/publishing/PublishContentActionExecuter.java b/source/java/org/alfresco/repo/publishing/PublishContentActionExecuter.java index 7650b693ad..5d842cb7f3 100644 --- a/source/java/org/alfresco/repo/publishing/PublishContentActionExecuter.java +++ b/source/java/org/alfresco/repo/publishing/PublishContentActionExecuter.java @@ -264,9 +264,9 @@ public class PublishContentActionExecuter extends ActionExecuterAbstractBase /** * This method sets the node(s) to publish or unpublish on the supplied publishing details. * If the actionedUponNode is a folder then it will include all content nodes within that folder. - * @param actionedUponNodeRef - * @param unpublish - * @param details + * @param actionedUponNodeRef NodeRef + * @param unpublish boolean + * @param details PublishingDetails */ private List setNodes(NodeRef actionedUponNodeRef, boolean unpublish, PublishingDetails details) { diff --git a/source/java/org/alfresco/repo/publishing/PublishServiceImpl.java b/source/java/org/alfresco/repo/publishing/PublishServiceImpl.java index fcb5f50552..05d830e668 100644 --- a/source/java/org/alfresco/repo/publishing/PublishServiceImpl.java +++ b/source/java/org/alfresco/repo/publishing/PublishServiceImpl.java @@ -101,9 +101,6 @@ public class PublishServiceImpl implements PublishingService return rootObject.getPublishingQueue(); } - /** - * {@inheritDoc} - */ public Map checkPublishStatus(String channelId, Collection nodes) { // Map results = new HashMap(); @@ -119,9 +116,6 @@ public class PublishServiceImpl implements PublishingService return null; } - /** - * {@inheritDoc} - */ public Map checkPublishStatus(String channelId, NodeRef... nodes) { // return checkPublishStatus(channelId, Arrays.asList(nodes)); diff --git a/source/java/org/alfresco/repo/publishing/PublishingEventHelper.java b/source/java/org/alfresco/repo/publishing/PublishingEventHelper.java index 1dd89c6e10..33d234f050 100644 --- a/source/java/org/alfresco/repo/publishing/PublishingEventHelper.java +++ b/source/java/org/alfresco/repo/publishing/PublishingEventHelper.java @@ -352,9 +352,9 @@ public class PublishingEventHelper /** * Returns a {@link List} of the {@link NodeRef}s representing PublishingEvents that were scheduled to publish at least one of the specified publishedNodes. - * @param queue - * @param publishedNodes - * @return + * @param queue NodeRef + * @param publishedNodes NodeRef.. + * @return List */ public List getEventNodesForPublishedNodes(final NodeRef queue, NodeRef... publishedNodes) { @@ -363,9 +363,9 @@ public class PublishingEventHelper /** * Returns a {@link List} of the {@link NodeRef}s representing PublishingEvents that were scheduled to publish at least one of the specified publishedNodes. - * @param queue - * @param publishedNodes - * @return + * @param queue NodeRef + * @param publishedNodes Collection + * @return List */ public List getEventNodesForPublishedNodes(final NodeRef queue, Collection publishedNodes) { @@ -374,9 +374,9 @@ public class PublishingEventHelper /** * Returns a {@link List} of the {@link NodeRef}s representing PublishingEvents that were scheduled to unpublish at least one of the specified unpublishedNodes. - * @param queue - * @param unpublishedNodes - * @return + * @param queue NodeRef + * @param unpublishedNodes Collection + * @return List */ public List getEventNodesForUnpublishedNodes(final NodeRef queue, Collection unpublishedNodes) { @@ -385,9 +385,9 @@ public class PublishingEventHelper /** * Returns a {@link List} of the {@link NodeRef}s representing PublishingEvents that were scheduled to publish the specified publishedNode. - * @param queue - * @param publishedNode - * @return + * @param queue NodeRef + * @param publishedNode NodeRef + * @return List */ public List getEventNodesForPublishedNode(final NodeRef queue, NodeRef publishedNode) { @@ -397,9 +397,9 @@ public class PublishingEventHelper /** * Returns a {@link List} of the {@link NodeRef}s representing PublishingEvents that were scheduled to unpublish the specified unpublishedNode. - * @param queue - * @param unpublishedNode - * @return + * @param queue NodeRef + * @param unpublishedNode NodeRef + * @return List */ public List getEventNodesForUnpublishedNode(final NodeRef queue, NodeRef unpublishedNode) { @@ -679,7 +679,7 @@ public class PublishingEventHelper /** * Sets a list of excluded aspects, assumes the fully qualified name. Replaces any exising excluded aspects. - * @param excludedAspects + * @param excludedAspects Collection */ public void setExcludedAspects(Collection excludedAspects) { diff --git a/source/java/org/alfresco/repo/publishing/PublishingEventImpl.java b/source/java/org/alfresco/repo/publishing/PublishingEventImpl.java index 486115a37c..4617b12948 100644 --- a/source/java/org/alfresco/repo/publishing/PublishingEventImpl.java +++ b/source/java/org/alfresco/repo/publishing/PublishingEventImpl.java @@ -164,9 +164,6 @@ public class PublishingEventImpl implements PublishingEvent return statusUpdate; } - /** - * {@inheritDoc} - */ public MutablePublishingEvent edit() { return new MutablePublishingEventImpl(this); diff --git a/source/java/org/alfresco/repo/publishing/PublishingEventProcessor.java b/source/java/org/alfresco/repo/publishing/PublishingEventProcessor.java index 91dabc4a11..6810fd5052 100644 --- a/source/java/org/alfresco/repo/publishing/PublishingEventProcessor.java +++ b/source/java/org/alfresco/repo/publishing/PublishingEventProcessor.java @@ -114,9 +114,9 @@ public class PublishingEventProcessor } /** - * @param publishChannel - * @param update - * @return + * @param publishChannel Channel + * @param update StatusUpdate + * @return String */ private String getNodeUrl(Channel publishChannel, StatusUpdate update) { diff --git a/source/java/org/alfresco/repo/publishing/PublishingQueueImpl.java b/source/java/org/alfresco/repo/publishing/PublishingQueueImpl.java index 3bdfaf605e..1e426ebf48 100644 --- a/source/java/org/alfresco/repo/publishing/PublishingQueueImpl.java +++ b/source/java/org/alfresco/repo/publishing/PublishingQueueImpl.java @@ -56,41 +56,26 @@ public class PublishingQueueImpl implements PublishingQueue return publishingEventHelper.createPublishingDetails(); } - /** - * {@inheritDoc} - */ public StatusUpdate createStatusUpdate(String message, NodeRef nodeToLinkTo, String... channelNames) { return createStatusUpdate(message, nodeToLinkTo, Arrays.asList(channelNames)); } - /** - * {@inheritDoc} - */ public StatusUpdate createStatusUpdate(String message, NodeRef nodeToLinkTo, Collection channelNames) { return new StatusUpdateImpl(message, nodeToLinkTo, channelNames); } - /** - * {@inheritDoc} - */ public List getPublishingEvents(PublishingEventFilter filter) { return publishingEventHelper.findPublishingEvents(nodeRef, filter); } - /** - * {@inheritDoc} - */ public PublishingEventFilter createPublishingEventFilter() { return new PublishingEventFilterImpl(); } - /** - * {@inheritDoc} - */ public String scheduleNewEvent(PublishingDetails publishingDetails) { try diff --git a/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java b/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java index cff69b131b..97a361edb7 100644 --- a/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java +++ b/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java @@ -28,13 +28,13 @@ import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.namespace.NamespaceService; import org.springframework.beans.factory.InitializingBean; -/** - * This class provides the basic implementation of a rating property rollup. - * By providing an implementation of this class (or reusing an existing one), - * injecting the object into the {@link org.alfresco.service.cmr.rating.RatingScheme} and following the content - * model naming conventions described in {@link RatingRollupNamingConventionsUtil}, it - * should be possible to have new rating property rollups automatically calculated - * and persisted into the Alfresco content model, thereby enabling indexing, searching +/** + * This class provides the basic implementation of a rating property rollup. + * By providing an implementation of this class (or reusing an existing one), + * injecting the object into the {@link org.alfresco.service.cmr.rating.RatingScheme} and following the content + * model naming conventions, it + * should be possible to have new rating property rollups automatically calculated + * and persisted into the Alfresco content model, thereby enabling indexing, searching * and sorting of rating-related properties. * * @author Neil McErlean @@ -88,8 +88,8 @@ public abstract class AbstractRatingRollupAlgorithm implements InitializingBean /** * This method returns the rollup name, for example "Total" or "Count". * This rollup name is used as part of the convention-based naming of content model - * property names see {@link RatingRollupNamingConventionsUtil}. - * @return + * property names. + * @return String */ public String getRollupName() { diff --git a/source/java/org/alfresco/repo/rating/RateableAspect.java b/source/java/org/alfresco/repo/rating/RateableAspect.java index 1fd0b19099..35d71d3440 100644 --- a/source/java/org/alfresco/repo/rating/RateableAspect.java +++ b/source/java/org/alfresco/repo/rating/RateableAspect.java @@ -74,7 +74,7 @@ public class RateableAspect implements CopyServicePolicies.OnCopyNodePolicy /** * Set the rating naming conventions service. * - * @param + * @param ratingNamingConventions RatingNamingConventionsUtil */ public void setRatingNamingConventions(RatingNamingConventionsUtil ratingNamingConventions) { @@ -107,7 +107,7 @@ public class RateableAspect implements CopyServicePolicies.OnCopyNodePolicy } /** - * @return Returns {@link RateableAspectCopyBehaviourCallback} + * @return Returns CopyBehaviourCallback */ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/rating/RatingNamingConventionsUtil.java b/source/java/org/alfresco/repo/rating/RatingNamingConventionsUtil.java index 74c54e3432..d17c12245d 100644 --- a/source/java/org/alfresco/repo/rating/RatingNamingConventionsUtil.java +++ b/source/java/org/alfresco/repo/rating/RatingNamingConventionsUtil.java @@ -44,7 +44,7 @@ import org.alfresco.service.namespace.RegexQNamePattern; * the rollup name as defined in the algorithm class e.g. {@link RatingCountRollupAlgorithm#ROLLUP_NAME}. *

    * Since Alfresco 4.1.5, the "cm:" prefix is no longer required and any namespace can be used. These are provided - * via injection with {@link RatingSchemeImpl#setModelPrefix(String))} + * via injection with {@link RatingSchemeImpl#setModelPrefix(String)} * * @author Neil McErlean * @since 3.5 @@ -79,7 +79,7 @@ public class RatingNamingConventionsUtil * * @param username the username to match against or null for all usernames. * @param ratingSchemeName the ratingSchemeName to match against or null for all ratingSchemes. - * @return + * @return QNamePattern */ public QNamePattern getRatingAssocPatternForUser(String username, String ratingSchemeName) { diff --git a/source/java/org/alfresco/repo/rating/RatingSchemeRegistry.java b/source/java/org/alfresco/repo/rating/RatingSchemeRegistry.java index 3e75aa0db3..93a186ed9d 100644 --- a/source/java/org/alfresco/repo/rating/RatingSchemeRegistry.java +++ b/source/java/org/alfresco/repo/rating/RatingSchemeRegistry.java @@ -53,7 +53,7 @@ public class RatingSchemeRegistry /** * This method returns an unmodifiable map of the registered rating schemes. - * @return + * @return Map */ public Map getRatingSchemes() { diff --git a/source/java/org/alfresco/repo/rating/RatingServiceImpl.java b/source/java/org/alfresco/repo/rating/RatingServiceImpl.java index 1efb1a1ddc..80576f42ae 100644 --- a/source/java/org/alfresco/repo/rating/RatingServiceImpl.java +++ b/source/java/org/alfresco/repo/rating/RatingServiceImpl.java @@ -320,12 +320,12 @@ public class RatingServiceImpl implements RatingService return convertNodeRefToRating(user, ratingNodeAssoc.getChildRef()); } - /** - * This method converts a NodeRef (which must be an instance of a cm:rating node) - * into a {@link Rating} object. - * @param user - * @param ratingNode - * @return + /** + * This method converts a NodeRef (which must be an instance of a cm:rating node) + * into a {@link Rating} object. + * @param user String + * @param ratingNode NodeRef + * @return Rating */ private Rating convertNodeRefToRating(String user, NodeRef ratingNode) { @@ -449,7 +449,7 @@ public class RatingServiceImpl implements RatingService * @param user the user name of the user whose ratings are sought, null * for all users. * @param ratingSchemeName the name of the rating scheme, null for all schemes. - * @return + * @return List */ List getRatingNodeChildren(NodeRef targetNode, String ratingSchemeName, String user) @@ -462,8 +462,8 @@ public class RatingServiceImpl implements RatingService /** * This method returns a {@link Rating} object for the specified cm:rating node. - * @param ratingNode - * @return + * @param ratingNode NodeRef + * @return Rating */ Rating getRatingFrom(NodeRef ratingNode) { diff --git a/source/java/org/alfresco/repo/rating/RatingsRelatedAspectBehaviours.java b/source/java/org/alfresco/repo/rating/RatingsRelatedAspectBehaviours.java index b8615843ec..52490cd8be 100644 --- a/source/java/org/alfresco/repo/rating/RatingsRelatedAspectBehaviours.java +++ b/source/java/org/alfresco/repo/rating/RatingsRelatedAspectBehaviours.java @@ -70,7 +70,7 @@ public class RatingsRelatedAspectBehaviours implements CopyServicePolicies.OnCop } /** - * @return Returns {@link RatingRelatedAspectsCopyBehaviourCallback} + * @return Returns CopyBehaviourCallback */ @Override public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/rating/script/ScriptRatingService.java b/source/java/org/alfresco/repo/rating/script/ScriptRatingService.java index 042f02f5ac..f7d3e091ae 100644 --- a/source/java/org/alfresco/repo/rating/script/ScriptRatingService.java +++ b/source/java/org/alfresco/repo/rating/script/ScriptRatingService.java @@ -57,7 +57,7 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the names for rating schemes currently in the system. - * @return + * @return String[] */ public String[] getRatingSchemeNames() { @@ -70,8 +70,8 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the minimum allowed rating for the specified rating scheme. * - * @param ratingSchemeName - * @return + * @param ratingSchemeName String + * @return float */ public float getMin(String ratingSchemeName) { @@ -81,8 +81,8 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the maximum allowed rating for the specified rating scheme. * - * @param ratingSchemeName - * @return + * @param ratingSchemeName String + * @return float */ public float getMax(String ratingSchemeName) { @@ -109,9 +109,9 @@ public class ScriptRatingService extends BaseScopableProcessorExtension *

    Furthermore, only one rating scheme per user per target node is supported. Any attempt * by one user to apply a second rating in a different scheme will result in a {@link RatingServiceException}. * - * @param node - * @param rating - * @param ratingSchemeName + * @param node ScriptNode + * @param rating float + * @param ratingSchemeName String * @throws RatingServiceException * @see ScriptRatingService#getMin(String) * @see ScriptRatingService#getMax(String) @@ -124,8 +124,8 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Removes any rating by the current user in the specified scheme from the specified * noderef. - * @param node - * @param ratingSchemeName + * @param node ScriptNode + * @param ratingSchemeName String */ public void removeRating(ScriptNode node, String ratingSchemeName) { @@ -135,8 +135,8 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the rating applied to the specified node in the specified scheme by * the currently authenticated user. - * @param node - * @param ratingSchemeName + * @param node ScriptNode + * @param ratingSchemeName String * @return rating if there is one, else -1. * TODO -1 could be a valid rating. */ @@ -149,8 +149,8 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the rating applied date for the specified node in the specified scheme by * the currently authenticated user. - * @param node - * @param ratingSchemeName + * @param node ScriptNode + * @param ratingSchemeName String * @return rating applied date if there is one, else null */ public Date getRatingAppliedAt(ScriptNode node, String ratingSchemeName) @@ -162,9 +162,9 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the number of ratings applied to the specified node by all users in the specified * scheme. - * @param node - * @param ratingSchemeName - * @return + * @param node ScriptNode + * @param ratingSchemeName String + * @return int */ public int getRatingsCount(ScriptNode node, String ratingSchemeName) { @@ -173,9 +173,9 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the total (sum) rating by all users on the specified node in the specified scheme. - * @param node - * @param ratingSchemeName - * @return + * @param node ScriptNode + * @param ratingSchemeName String + * @return float */ public float getTotalRating(ScriptNode node, String ratingSchemeName) { @@ -184,9 +184,10 @@ public class ScriptRatingService extends BaseScopableProcessorExtension /** * Gets the average (mean) rating by all users on the specified node in the specified scheme. - * @param node - * @param ratingSchemeName - * @return + * @param node ScriptNode + * @param ratingSchemeName * @param ratingSchemeName String + + * @return float */ public float getAverageRating(ScriptNode node, String ratingSchemeName) { diff --git a/source/java/org/alfresco/repo/remoteconnector/RemoteConnectorServiceImpl.java b/source/java/org/alfresco/repo/remoteconnector/RemoteConnectorServiceImpl.java index 1e142c9579..c0c3924029 100644 --- a/source/java/org/alfresco/repo/remoteconnector/RemoteConnectorServiceImpl.java +++ b/source/java/org/alfresco/repo/remoteconnector/RemoteConnectorServiceImpl.java @@ -405,9 +405,9 @@ public class RemoteConnectorServiceImpl implements RemoteConnectorService * Create proxy host for the given system host and port properties. * If the properties are not set, no proxy will be created. * - * @param hostProperty - * @param portProperty - * @param defaultPort + * @param hostProperty String + * @param portProperty String + * @param defaultPort int * * @return ProxyHost if appropriate properties have been set, null otherwise */ @@ -435,8 +435,8 @@ public class RemoteConnectorServiceImpl implements RemoteConnectorService /** * Create the proxy credentials for the given proxy user and password properties. * If the properties are not set, not credentials will be created. - * @param proxyUserProperty - * @param proxyPasswordProperty + * @param proxyUserProperty String + * @param proxyPasswordProperty String * @return Credentials if appropriate properties have been set, null otherwise */ private static Credentials createProxyCredentials(final String proxyUserProperty, final String proxyPasswordProperty) @@ -454,7 +454,7 @@ public class RemoteConnectorServiceImpl implements RemoteConnectorService /** * Create suitable AuthScope for ProxyHost. * If the ProxyHost is null, no AuthsScope will be created. - * @param proxyHost + * @param proxyHost ProxyHost * @return Authscope for provided ProxyHost, null otherwise. */ private static AuthScope createProxyAuthScope(final ProxyHost proxyHost) diff --git a/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java b/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java index 8c96a43873..18b8d5f684 100644 --- a/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java +++ b/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java @@ -40,14 +40,14 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im */ private static final long serialVersionUID = -770880495976834168L; - private final ActionList actions = new ActionListImpl(); - - /** - * @param id - the action id - * @param renditionName - a unique name for the rendering action - */ - public CompositeRenditionDefinitionImpl(String id, QName renditionName) - { + private final ActionList actions = new ActionListImpl(); + + /** + * @param id - the action id + * @param renditionName - a unique name for the rendering action + */ + public CompositeRenditionDefinitionImpl(String id, QName renditionName) + { super(id, renditionName, CompositeRenderingEngine.NAME); } @@ -71,8 +71,8 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param index - * @param action + * @param index int + * @param action RenditionDefinition * @see org.alfresco.service.cmr.action.ActionList#addAction(int, * org.alfresco.service.cmr.action.Action) */ @@ -82,7 +82,7 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param action + * @param action RenditionDefinition * @see org.alfresco.service.cmr.action.ActionList#addAction(org.alfresco.service.cmr.action.Action) */ public void addAction(RenditionDefinition action) @@ -91,8 +91,8 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param index - * @return + * @param index int + * @return RenditionDefinition * @see org.alfresco.service.cmr.action.ActionList#getAction(int) */ public RenditionDefinition getAction(int index) @@ -101,7 +101,7 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @return + * @return List * @see org.alfresco.service.cmr.action.ActionList#getActions() */ public List getActions() @@ -110,7 +110,7 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @return + * @return boolean * @see org.alfresco.service.cmr.action.ActionList#hasActions() */ public boolean hasActions() @@ -119,8 +119,8 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param action - * @return + * @param action RenditionDefinition + * @return int * @see org.alfresco.service.cmr.action.ActionList#indexOfAction(org.alfresco.service.cmr.action.Action) */ public int indexOfAction(RenditionDefinition action) @@ -129,7 +129,7 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param action + * @param action RenditionDefinition * @see org.alfresco.service.cmr.action.ActionList#removeAction(org.alfresco.service.cmr.action.Action) */ public void removeAction(RenditionDefinition action) @@ -146,8 +146,8 @@ public class CompositeRenditionDefinitionImpl extends RenditionDefinitionImpl im } /** - * @param index - * @param action + * @param index int + * @param action RenditionDefinition * @see org.alfresco.service.cmr.action.ActionList#setAction(int, * org.alfresco.service.cmr.action.Action) */ diff --git a/source/java/org/alfresco/repo/rendition/PerformRenditionActionExecuter.java b/source/java/org/alfresco/repo/rendition/PerformRenditionActionExecuter.java index b75fbd535e..90a3ab870c 100644 --- a/source/java/org/alfresco/repo/rendition/PerformRenditionActionExecuter.java +++ b/source/java/org/alfresco/repo/rendition/PerformRenditionActionExecuter.java @@ -116,8 +116,8 @@ public class PerformRenditionActionExecuter extends ActionExecuterAbstractBase /** * This method delegates to the action service for the execution of the rendition. - * @param sourceNode - * @param definition + * @param sourceNode NodeRef + * @param definition RenditionDefinition * @return the ChildAssociationRef result. */ private ChildAssociationRef executeRendition(NodeRef sourceNode, RenditionDefinition definition) diff --git a/source/java/org/alfresco/repo/rendition/RenditionLocation.java b/source/java/org/alfresco/repo/rendition/RenditionLocation.java index 7907e2b689..3e9e7a17db 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionLocation.java +++ b/source/java/org/alfresco/repo/rendition/RenditionLocation.java @@ -28,19 +28,19 @@ public interface RenditionLocation { /** * Gets the parent node of the rendition. - * @return + * @return NodeRef */ NodeRef getParentRef(); /** * Gets the rendition node itself. - * @return + * @return NodeRef */ NodeRef getChildRef(); /** * Gets the name of the rendition. - * @return + * @return String */ String getChildName(); } diff --git a/source/java/org/alfresco/repo/rendition/RenditionLocationResolver.java b/source/java/org/alfresco/repo/rendition/RenditionLocationResolver.java index 9fca60dfee..b08a0be4ea 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionLocationResolver.java +++ b/source/java/org/alfresco/repo/rendition/RenditionLocationResolver.java @@ -30,10 +30,10 @@ public interface RenditionLocationResolver /** * - * @param sourceNode - * @param definition - * @param tempRenditionLocation - * @return + * @param sourceNode NodeRef + * @param definition RenditionDefinition + * @param tempRenditionLocation NodeRef + * @return RenditionLocation */ RenditionLocation getRenditionLocation(NodeRef sourceNode, RenditionDefinition definition, NodeRef tempRenditionLocation); } \ No newline at end of file diff --git a/source/java/org/alfresco/repo/rendition/RenditionNodeManager.java b/source/java/org/alfresco/repo/rendition/RenditionNodeManager.java index 91d24b5556..321e4d85b6 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionNodeManager.java +++ b/source/java/org/alfresco/repo/rendition/RenditionNodeManager.java @@ -84,9 +84,10 @@ public class RenditionNodeManager * @param sourceNode the source node which is being rendered. * @param tempRenditionNode the temporary rendition * @param location the proposed location of the rendition node. - * @param renditionDefinition - * @param nodeService - * @param renditionService + * @param renditionDefinition RenditionDefinition + * @param nodeService NodeService + * @param renditionService RenditionService + * @param behaviourFilter BehaviourFilter */ public RenditionNodeManager(NodeRef sourceNode, NodeRef tempRenditionNode, RenditionLocation location, RenditionDefinition renditionDefinition, NodeService nodeService, RenditionService renditionService, @@ -381,8 +382,8 @@ public class RenditionNodeManager * the primary parent of the newly created rendition node, the rendition node is added as * a child of the source node. * - * @param renditionName - * @param nodeTypeQName + * @param renditionName QName + * @param nodeTypeQName QName * @return the primary parent association of the newly created rendition node. */ private ChildAssociationRef createNewRendition(QName renditionName, QName nodeTypeQName) @@ -449,9 +450,9 @@ public class RenditionNodeManager } /** - * @param parentIsSource - * @param renditionName - * @return + * @param parentIsSource boolean + * @param renditionName QName + * @return QName */ private QName getAssociationName(boolean parentIsSource, QName renditionName) { @@ -495,7 +496,7 @@ public class RenditionNodeManager /** * This method copies properties from the temporary rendition node onto the targetNode. It also sets the node type. * {@link #unchangedProperties Some properties} are not copied. - * @param finalRenditionAssoc + * @param finalRenditionAssoc ChildAssociationRef */ private void transferNodeProperties(ChildAssociationRef finalRenditionAssoc) { diff --git a/source/java/org/alfresco/repo/rendition/RenditionServiceImpl.java b/source/java/org/alfresco/repo/rendition/RenditionServiceImpl.java index 2b4f31b4b6..d80e10527a 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionServiceImpl.java +++ b/source/java/org/alfresco/repo/rendition/RenditionServiceImpl.java @@ -93,7 +93,7 @@ public class RenditionServiceImpl implements /** * Injects the RenditionDefinitionPersister bean. - * @param renditionDefinitionPersister + * @param renditionDefinitionPersister RenditionDefinitionPersister */ public void setRenditionDefinitionPersister(RenditionDefinitionPersister renditionDefinitionPersister) { @@ -110,7 +110,7 @@ public class RenditionServiceImpl implements /** * Injects the ServiceRegistry bean. - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { @@ -120,7 +120,7 @@ public class RenditionServiceImpl implements /** * Injects the ActionService bean. - * @param actionService + * @param actionService ActionService */ public void setActionService(ActionService actionService) { @@ -129,7 +129,7 @@ public class RenditionServiceImpl implements /** * Injects the ActionTrackingService bean. - * @param actionTrackingService + * @param actionTrackingService ActionTrackingService */ public void setActionTrackingService(ActionTrackingService actionTrackingService) { @@ -138,7 +138,7 @@ public class RenditionServiceImpl implements /** * Injects the DictionaryService bean. - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -147,7 +147,7 @@ public class RenditionServiceImpl implements /** * Injects the PolicyComponent bean. - * @param policyComponent + * @param policyComponent PolicyComponent */ public void setPolicyComponent(PolicyComponent policyComponent) { @@ -156,7 +156,7 @@ public class RenditionServiceImpl implements /** * Sets the list of known cancellable actions used by {@link #cancelRenditions(NodeRef)}. - * @param knownCancellableActionTypes + * @param knownCancellableActionTypes List * @since 4.1.6 */ public void setKnownCancellableActionTypes(List knownCancellableActionTypes) diff --git a/source/java/org/alfresco/repo/rendition/RenditionedAspect.java b/source/java/org/alfresco/repo/rendition/RenditionedAspect.java index 58dbde36fe..749ea24eba 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionedAspect.java +++ b/source/java/org/alfresco/repo/rendition/RenditionedAspect.java @@ -309,7 +309,7 @@ public class RenditionedAspect implements NodeServicePolicies.OnUpdateProperties } /** - * @return Returns {@link RenditionedAspectCopyBehaviourCallback} + * @return Returns CopyBehaviourCallback */ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/rendition/StandardRenditionLocationResolverImpl.java b/source/java/org/alfresco/repo/rendition/StandardRenditionLocationResolverImpl.java index 27a5078b58..c5f8b181a6 100644 --- a/source/java/org/alfresco/repo/rendition/StandardRenditionLocationResolverImpl.java +++ b/source/java/org/alfresco/repo/rendition/StandardRenditionLocationResolverImpl.java @@ -123,8 +123,8 @@ public class StandardRenditionLocationResolverImpl implements RenditionLocationR * This method creates a {@link RenditionLocation} object from the specified destination node. * This is formed from the specified destination NodeRef, its cm:name and its primary parent. * - * @param destination - * @return + * @param destination NodeRef + * @return RenditionLocationImpl * @throws RenditionServiceException if the destination node does not exist. */ private RenditionLocationImpl createNodeLocation(NodeRef destination) diff --git a/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java b/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java index 407056696c..2bb2fc7adf 100644 --- a/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java +++ b/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java @@ -223,7 +223,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase /** * Injects the renditionService bean. * - * @param renditionService + * @param renditionService RenditionService */ public void setRenditionService(RenditionService renditionService) { @@ -262,7 +262,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase /** * Sets the default rendition-node type. * - * @param type + * @param type String */ public void setDefaultRenditionNodeType(String type) { @@ -311,7 +311,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase /** * Sets the default rendition content property. * - * @param prop + * @param prop String */ public void setDefaultRenditionContentProp(String prop) { @@ -491,8 +491,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase * the main part of a composite rendition. * This only returns true if we're currently processing a * component of a composite rendition. - * @param action - * @return + * @param action Action + * @return boolean */ private boolean isComponentRendition(Action action) { Serializable s = action.getParameterValue(PARAM_IS_COMPONENT_RENDITION); @@ -538,8 +538,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase } /** - * @param renditionDefinition - * @return + * @param renditionDefinition RenditionDefinition + * @return QName */ protected QName getRenditionContentProperty(RenditionDefinition renditionDefinition) { @@ -549,7 +549,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase protected abstract void render(RenderingContext context); /** - * @param actionedUponNodeRef + * @param actionedUponNodeRef NodeRef */ protected void checkSourceNodeExists(NodeRef actionedUponNodeRef) { @@ -562,7 +562,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase } /** - * @param action + * @param action Action */ protected RenditionDefinition checkActionIsRenditionDefinition(Action action) { @@ -579,8 +579,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase /** * If no rendition node type is specified, then the default is used * - * @param renditionDefinition - * @return + * @param renditionDefinition RenditionDefinition + * @return QName */ private QName getRenditionNodeType(RenditionDefinition renditionDefinition) { @@ -620,7 +620,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase /** * Supplies the list of parameters required by this rendering engine. * - * @return + * @return Collection */ protected Collection getParameterDefinitions() { @@ -735,12 +735,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase * is the same as the type of defaultValue and throws a * {@link RenditionServiceException} if it isn't. Returns * defaultValue if the parameter value is null - * - * @param - * @param paramName - * @param defaultValue - * @param definition - * @return + * + * @param paramName String + * @param defaultValue T + * @param definition RenditionDefinition + * @param T + * @return T */ @SuppressWarnings("unchecked") public static T getParamWithDefault(String paramName, T defaultValue, RenditionDefinition definition) @@ -761,12 +761,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase private final QName renditionContentProperty; private ChildAssociationRef caNodeRef; - - /** - * @param sourceNode - * @param definition - * @param renditionContentProperty - */ + + /** + * @param sourceNode NodeRef + * @param definition RenditionDefinition + * @param renditionContentProperty QName + */ public RenderingContext(NodeRef sourceNode,// RenditionDefinition definition,// QName renditionContentProperty) @@ -934,7 +934,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase * This method sets the temporary rendition parent node and the rendition assocType on the * rendition definition. * - * @param sourceNode + * @param sourceNode NodeRef * @param definition the rendition definition. */ private void setTemporaryRenditionProperties(NodeRef sourceNode, RenditionDefinition definition) @@ -961,7 +961,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase * @param renditionDefinition The definition of the rendition that has just been performed. * In the case of a composite rendition, this parameter refers * to that CompositeRendition and not to any of its component renditions. - * @return + * @return ChildAssociationRef */ private ChildAssociationRef createOrUpdateRendition(NodeRef sourceNode, ChildAssociationRef tempRendition, RenditionDefinition renditionDefinition) diff --git a/source/java/org/alfresco/repo/rendition/executer/BaseTemplateRenderingEngine.java b/source/java/org/alfresco/repo/rendition/executer/BaseTemplateRenderingEngine.java index 02ade8eea5..5f3543a5ed 100644 --- a/source/java/org/alfresco/repo/rendition/executer/BaseTemplateRenderingEngine.java +++ b/source/java/org/alfresco/repo/rendition/executer/BaseTemplateRenderingEngine.java @@ -204,7 +204,7 @@ public abstract class BaseTemplateRenderingEngine extends AbstractRenderingEngin /** * Get the type of template that is to be used. This identifies the name of the template * processor that should be used, such as "freemarker" or "xslt". - * @return + * @return String */ protected abstract String getTemplateType(); diff --git a/source/java/org/alfresco/repo/rendition/executer/ImageRenderingEngine.java b/source/java/org/alfresco/repo/rendition/executer/ImageRenderingEngine.java index f3ec9b5530..42b3a9eee9 100644 --- a/source/java/org/alfresco/repo/rendition/executer/ImageRenderingEngine.java +++ b/source/java/org/alfresco/repo/rendition/executer/ImageRenderingEngine.java @@ -226,7 +226,7 @@ public class ImageRenderingEngine extends AbstractTransformationRenderingEngine * This method checks that if the specified parameter is non-null, that it has a * positive numerical value. That is it is non-zero and positive. * - * @param action + * @param action Action * @param numericalParamName must be an instance of java.lang.Number or null. */ private void checkNumericalParameterIsPositive(Action action, String numericalParamName) @@ -243,7 +243,7 @@ public class ImageRenderingEngine extends AbstractTransformationRenderingEngine /** * Check mimeType of target. - * @param context + * @param context RenderingContext */ private void checkTargetMimeType(RenderingContext context) { diff --git a/source/java/org/alfresco/repo/rendition/executer/XSLTFunctions.java b/source/java/org/alfresco/repo/rendition/executer/XSLTFunctions.java index b5fbc481f0..ec6f2b9b58 100644 --- a/source/java/org/alfresco/repo/rendition/executer/XSLTFunctions.java +++ b/source/java/org/alfresco/repo/rendition/executer/XSLTFunctions.java @@ -104,8 +104,8 @@ public class XSLTFunctions } /** - * @param repoPath - * @return + * @param repoPath String + * @return String[] */ private String[] breakDownPath(String repoPath) { @@ -121,7 +121,7 @@ public class XSLTFunctions * Encodes invalid HTML characters. (Fix for ETWOTWO-504 issue) This code was adopted from WebDAVHelper.encodeHTML() * method with some restrictions. * - * @see press-release.xsl for pattern. + * @see "press-release.xsl" for pattern * * @param text * to encode diff --git a/source/java/org/alfresco/repo/rendition/executer/XSLTRenderingEngine.java b/source/java/org/alfresco/repo/rendition/executer/XSLTRenderingEngine.java index 8f920eb044..384236ba49 100644 --- a/source/java/org/alfresco/repo/rendition/executer/XSLTRenderingEngine.java +++ b/source/java/org/alfresco/repo/rendition/executer/XSLTRenderingEngine.java @@ -242,9 +242,8 @@ public class XSLTRenderingEngine extends BaseTemplateRenderingEngine } /** - * @param nodeRef - * @return - * @throws FileNotFoundException + * @param nodeRef NodeRef + * @return String */ private String getPath(NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/rendition/script/ScriptRenditionDefinition.java b/source/java/org/alfresco/repo/rendition/script/ScriptRenditionDefinition.java index 64f8d9c2c7..d8f28837b9 100644 --- a/source/java/org/alfresco/repo/rendition/script/ScriptRenditionDefinition.java +++ b/source/java/org/alfresco/repo/rendition/script/ScriptRenditionDefinition.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.rendition.script; @@ -56,7 +56,7 @@ public final class ScriptRenditionDefinition extends ScriptAction /** * Returns the name of the Rendering Engine used by this definition. - * @return + * @return String */ public String getRenderingEngineName() { diff --git a/source/java/org/alfresco/repo/replication/ReplicationActionExecutor.java b/source/java/org/alfresco/repo/replication/ReplicationActionExecutor.java index 83834655fb..f76430a5bb 100644 --- a/source/java/org/alfresco/repo/replication/ReplicationActionExecutor.java +++ b/source/java/org/alfresco/repo/replication/ReplicationActionExecutor.java @@ -155,7 +155,7 @@ public class ReplicationActionExecutor extends ActionExecuterAbstractBase { /** * Injects the ReplicationDefinitionPersister bean. - * @param replicationDefinitionPersister + * @param replicationDefinitionPersister ReplicationDefinitionPersisterImpl */ public void setReplicationDefinitionPersister(ReplicationDefinitionPersisterImpl replicationDefinitionPersister) { @@ -542,7 +542,7 @@ public class ReplicationActionExecutor extends ActionExecuterAbstractBase { /** * Job Lock Refresh - * @return + * @return boolean */ @Override public boolean isActive() diff --git a/source/java/org/alfresco/repo/replication/ReplicationServiceImpl.java b/source/java/org/alfresco/repo/replication/ReplicationServiceImpl.java index 9edb1e3241..19233b245b 100644 --- a/source/java/org/alfresco/repo/replication/ReplicationServiceImpl.java +++ b/source/java/org/alfresco/repo/replication/ReplicationServiceImpl.java @@ -47,7 +47,7 @@ public class ReplicationServiceImpl implements ReplicationService, ReplicationDe /** * Injects the ReplicationDefinitionPersister bean. - * @param replicationDefinitionPersister + * @param replicationDefinitionPersister ReplicationDefinitionPersisterImpl */ public void setReplicationDefinitionPersister(ReplicationDefinitionPersisterImpl replicationDefinitionPersister) { @@ -56,7 +56,7 @@ public class ReplicationServiceImpl implements ReplicationService, ReplicationDe /** * Injects the ActionService bean. - * @param actionService + * @param actionService ActionService */ public void setActionService(ActionService actionService) { @@ -65,7 +65,7 @@ public class ReplicationServiceImpl implements ReplicationService, ReplicationDe /** * Injects the Scheduled Persisted Action Service bean - * @param scheduledPersistedActionService + * @param scheduledPersistedActionService ScheduledPersistedActionService */ public void setScheduledPersistedActionService(ScheduledPersistedActionService scheduledPersistedActionService) { diff --git a/source/java/org/alfresco/repo/rule/RuleTransactionListener.java b/source/java/org/alfresco/repo/rule/RuleTransactionListener.java index 40cafb229a..705c1032e0 100644 --- a/source/java/org/alfresco/repo/rule/RuleTransactionListener.java +++ b/source/java/org/alfresco/repo/rule/RuleTransactionListener.java @@ -41,7 +41,7 @@ public class RuleTransactionListener extends TransactionListenerAdapter /** * Constructor * - * @param + * @param ruleService RuntimeRuleService */ public RuleTransactionListener(RuntimeRuleService ruleService) { diff --git a/source/java/org/alfresco/repo/rule/RulesAspect.java b/source/java/org/alfresco/repo/rule/RulesAspect.java index d8265ffa9f..cf6f15de86 100644 --- a/source/java/org/alfresco/repo/rule/RulesAspect.java +++ b/source/java/org/alfresco/repo/rule/RulesAspect.java @@ -184,8 +184,8 @@ public class RulesAspect implements } /** + *
    author Neil McErlean * @since 3.4.11 - * @author Neil McErlean */ @Override public void beforeDeleteNode(NodeRef nodeRef) @@ -196,7 +196,7 @@ public class RulesAspect implements } /** - * @return Returns {@link RulesAspectCopyBehaviourCallback} + * @return Returns CopyBehaviourCallback */ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { diff --git a/source/java/org/alfresco/repo/rule/ruletrigger/BeforeDeleteChildAssociationRuleTrigger.java b/source/java/org/alfresco/repo/rule/ruletrigger/BeforeDeleteChildAssociationRuleTrigger.java index b2d880e9fc..af450174dc 100644 --- a/source/java/org/alfresco/repo/rule/ruletrigger/BeforeDeleteChildAssociationRuleTrigger.java +++ b/source/java/org/alfresco/repo/rule/ruletrigger/BeforeDeleteChildAssociationRuleTrigger.java @@ -35,7 +35,7 @@ import org.apache.commons.logging.LogFactory; *

    * Policy names supported are: *

    * * @author Roy Wetherall diff --git a/source/java/org/alfresco/repo/rule/ruletrigger/CreateNodeRuleTrigger.java b/source/java/org/alfresco/repo/rule/ruletrigger/CreateNodeRuleTrigger.java index 6e0dead3f5..e737be8f94 100644 --- a/source/java/org/alfresco/repo/rule/ruletrigger/CreateNodeRuleTrigger.java +++ b/source/java/org/alfresco/repo/rule/ruletrigger/CreateNodeRuleTrigger.java @@ -40,9 +40,9 @@ import org.apache.commons.logging.LogFactory; *

    * Policy names supported are: *

      - *
    • {@linkplain NodeServicePolicies.OnCreateChildAssociationPolicy}
    • - *
    • {@linkplain NodeServicePolicies.BeforeDeleteChildAssociationPolicy}
    • - *
    • {@linkplain NodeServicePolicies.OnCreateNodePolicy}
    • + *
    • {@linkplain org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy}
    • + *
    • {@linkplain org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteChildAssociationPolicy}
    • + *
    • {@linkplain org.alfresco.repo.node.NodeServicePolicies.OnCreateNodePolicy}
    • *
    * * @author Roy Wetherall diff --git a/source/java/org/alfresco/repo/rule/ruletrigger/OnCreateChildAssociationRuleTrigger.java b/source/java/org/alfresco/repo/rule/ruletrigger/OnCreateChildAssociationRuleTrigger.java index 9e8ca9d365..aea07db0df 100644 --- a/source/java/org/alfresco/repo/rule/ruletrigger/OnCreateChildAssociationRuleTrigger.java +++ b/source/java/org/alfresco/repo/rule/ruletrigger/OnCreateChildAssociationRuleTrigger.java @@ -35,7 +35,7 @@ import org.apache.commons.logging.LogFactory; *

    * Policy names supported are: *

      - *
    • {@linkplain NodeServicePolicies.OnCreateChildAssociationPolicy}
    • + *
    • {@linkplain org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy}
    • *
    * * @author Roy Wetherall diff --git a/source/java/org/alfresco/repo/rule/ruletrigger/OnPropertyUpdateRuleTrigger.java b/source/java/org/alfresco/repo/rule/ruletrigger/OnPropertyUpdateRuleTrigger.java index 8708ee73e6..309414c690 100644 --- a/source/java/org/alfresco/repo/rule/ruletrigger/OnPropertyUpdateRuleTrigger.java +++ b/source/java/org/alfresco/repo/rule/ruletrigger/OnPropertyUpdateRuleTrigger.java @@ -79,7 +79,7 @@ public class OnPropertyUpdateRuleTrigger extends RuleTriggerAbstractBase /** * If set to true, then we consider zero byte content to be equivalent to no content. * - * @param ignoreEmptyContent + * @param ignoreEmptyContent boolean */ public void setIgnoreEmptyContent(boolean ignoreEmptyContent) { @@ -302,7 +302,7 @@ public class OnPropertyUpdateRuleTrigger extends RuleTriggerAbstractBase } /** - * @param nodeRef + * @param nodeRef NodeRef */ private void triggerRules(NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/search/AbstractResultSet.java b/source/java/org/alfresco/repo/search/AbstractResultSet.java index 941b1c4b9d..15c497df3a 100644 --- a/source/java/org/alfresco/repo/search/AbstractResultSet.java +++ b/source/java/org/alfresco/repo/search/AbstractResultSet.java @@ -80,7 +80,7 @@ public abstract class AbstractResultSet implements ResultSet /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ public boolean setBulkFetch(boolean bulkFetch) { @@ -100,7 +100,7 @@ public abstract class AbstractResultSet implements ResultSet /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ public int setBulkFetchSize(int bulkFetchSize) { diff --git a/source/java/org/alfresco/repo/search/AbstractResultSetRow.java b/source/java/org/alfresco/repo/search/AbstractResultSetRow.java index 40f0c9422c..1cce191966 100644 --- a/source/java/org/alfresco/repo/search/AbstractResultSetRow.java +++ b/source/java/org/alfresco/repo/search/AbstractResultSetRow.java @@ -56,8 +56,8 @@ public abstract class AbstractResultSetRow implements ResultSetRow /** * The row needs the result set and the index for lookup. * - * @param resultSet - * @param index + * @param resultSet ResultSet + * @param index int */ public AbstractResultSetRow(ResultSet resultSet, int index) { diff --git a/source/java/org/alfresco/repo/search/AbstractResultSetRowIterator.java b/source/java/org/alfresco/repo/search/AbstractResultSetRowIterator.java index 08d39a5f2b..129659f92c 100644 --- a/source/java/org/alfresco/repo/search/AbstractResultSetRowIterator.java +++ b/source/java/org/alfresco/repo/search/AbstractResultSetRowIterator.java @@ -49,7 +49,7 @@ public abstract class AbstractResultSetRowIterator implements ResultSetRowIterat * Create an iterator over the result set. Follows stadard ListIterator * conventions * - * @param resultSet + * @param resultSet ResultSet */ public AbstractResultSetRowIterator(ResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/search/BackgroundIndexerAware.java b/source/java/org/alfresco/repo/search/BackgroundIndexerAware.java index 04091fd301..32aacc51e7 100644 --- a/source/java/org/alfresco/repo/search/BackgroundIndexerAware.java +++ b/source/java/org/alfresco/repo/search/BackgroundIndexerAware.java @@ -30,14 +30,14 @@ public interface BackgroundIndexerAware extends SupportsBackgroundIndexing /** * Register call back handler when the indexing chunk is done * - * @param callBack + * @param callBack FTSIndexerAware */ public void registerCallBack(FTSIndexerAware callBack); /** * Peform a chunk of background FTS (and other non atomic property) indexing * - * @param i + * @param i int * @return - the number of docs updates */ public int updateFullTextSearch(int i); diff --git a/source/java/org/alfresco/repo/search/CannedQueryDef.java b/source/java/org/alfresco/repo/search/CannedQueryDef.java index 61c328a438..70df5c85fb 100644 --- a/source/java/org/alfresco/repo/search/CannedQueryDef.java +++ b/source/java/org/alfresco/repo/search/CannedQueryDef.java @@ -36,28 +36,28 @@ public interface CannedQueryDef /** * Get the unique name for the query * - * @return + * @return QName */ public QName getQname(); /** * Get the language in which the query is defined. * - * @return + * @return String */ public String getLanguage(); /** * Get the definitions for any query parameters. * - * @return + * @return Collection */ public Collection getQueryParameterDefs(); /** * Get the query string. * - * @return + * @return String */ public String getQuery(); @@ -66,14 +66,14 @@ public interface CannedQueryDef * prefixes to URIs. A query may use a predefined set of prefixes for known * URIs. I would be unwise to rely on the defaults. * - * @return + * @return NamespacePrefixResolver */ public NamespacePrefixResolver getNamespacePrefixResolver(); /** * Get a map to look up definitions by Qname * - * @return + * @return Map */ public Map getQueryParameterMap(); } diff --git a/source/java/org/alfresco/repo/search/EmptyResultSet.java b/source/java/org/alfresco/repo/search/EmptyResultSet.java index 2313a4d8c2..92e23ee20b 100644 --- a/source/java/org/alfresco/repo/search/EmptyResultSet.java +++ b/source/java/org/alfresco/repo/search/EmptyResultSet.java @@ -54,7 +54,7 @@ public class EmptyResultSet implements ResultSet /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ public boolean setBulkFetch(boolean bulkFetch) { @@ -74,7 +74,7 @@ public class EmptyResultSet implements ResultSet /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ public int setBulkFetchSize(int bulkFetchSize) { diff --git a/source/java/org/alfresco/repo/search/Indexer.java b/source/java/org/alfresco/repo/search/Indexer.java index 6068a2983d..e5ed5a4ec3 100644 --- a/source/java/org/alfresco/repo/search/Indexer.java +++ b/source/java/org/alfresco/repo/search/Indexer.java @@ -43,15 +43,15 @@ public interface Indexer * created with a name in a given parent and so a relationship ref is * required. * - * @param relationshipRef + * @param relationshipRef ChildAssociationRef */ public void createNode(ChildAssociationRef relationshipRef); /** * Update an index entry due to property changes on a node. There are no * strucural impications from such a change. - * - * @param nodeRef + * + * @param nodeRef NodeRef */ public void updateNode(NodeRef nodeRef); @@ -61,7 +61,7 @@ public interface Indexer * refernces to the node from the index. The index has no idea of the * primary link. * - * @param relationshipRef + * @param relationshipRef ChildAssociationRef */ public void deleteNode(ChildAssociationRef relationshipRef); @@ -69,7 +69,7 @@ public interface Indexer * Create a refernce link between a parent and child. Implies only * (potential) structural changes * - * @param relationshipRef + * @param relationshipRef ChildAssociationRef */ public void createChildRelationship(ChildAssociationRef relationshipRef); @@ -87,8 +87,8 @@ public interface Indexer * This could be implemented as a delete and add but some implementations * may be able to optimise this operation. * - * @param relationshipBeforeRef - * @param relationshipAfterRef + * @param relationshipBeforeRef ChildAssociationRef + * @param relationshipAfterRef ChildAssociationRef */ public void updateChildRelationship(ChildAssociationRef relationshipBeforeRef, ChildAssociationRef relationshipAfterRef); @@ -103,7 +103,7 @@ public interface Indexer * sure you are doing an unlink (remove a hard link in the unix file system * world). * - * @param relationshipRef + * @param relationshipRef ChildAssociationRef */ public void deleteChildRelationship(ChildAssociationRef relationshipRef); @@ -130,7 +130,7 @@ public interface Indexer /** * Delete the index for a store - * @param storeRef + * @param storeRef StoreRef */ public void deleteIndex(StoreRef storeRef); @@ -142,7 +142,7 @@ public interface Indexer * (potentially old) transaction, it will use a discrete read only transaction for each node it indexes. This avoids * 'stale' nodes building up in the caches during long reindex runs. * - * @param isReadThrough + * @param isReadThrough boolean */ public void setReadThrough(boolean isReadThrough); } diff --git a/source/java/org/alfresco/repo/search/IndexerAndSearcher.java b/source/java/org/alfresco/repo/search/IndexerAndSearcher.java index 6f7a7260d4..f839eff45a 100644 --- a/source/java/org/alfresco/repo/search/IndexerAndSearcher.java +++ b/source/java/org/alfresco/repo/search/IndexerAndSearcher.java @@ -35,8 +35,8 @@ public interface IndexerAndSearcher /** * Get an indexer for a store * - * @param storeRef - * @return + * @param storeRef StoreRef + * @return Indexer * @throws IndexerException */ public abstract Indexer getIndexer(StoreRef storeRef) throws IndexerException; @@ -44,11 +44,11 @@ public interface IndexerAndSearcher /** * Get a searcher for a store * - * @param storeRef + * @param storeRef StoreRef * @param searchDelta - * serach the in progress transaction as well as the main index * (this is ignored for searches that do full text) - * @return + * @return SearchService * @throws SearcherException */ public abstract SearchService getSearcher(StoreRef storeRef, boolean searchDelta) throws SearcherException; @@ -58,15 +58,15 @@ public interface IndexerAndSearcher * Do any indexing that may be pending on behalf of the current transaction. * */ - public abstract void flush(); - - /** - * @param luceneQueryLanguageSPI - */ - public abstract void registerQueryLanguage(LuceneQueryLanguageSPI luceneQueryLanguageSPI); - + public abstract void flush(); + /** - * @return + * @param luceneQueryLanguageSPI LuceneQueryLanguageSPI + */ + public abstract void registerQueryLanguage(LuceneQueryLanguageSPI luceneQueryLanguageSPI); + + /** + * @return Map */ public abstract Map getQueryLanguages(); } diff --git a/source/java/org/alfresco/repo/search/QueryCollection.java b/source/java/org/alfresco/repo/search/QueryCollection.java index d76bb3e3fe..d4f5477ebb 100644 --- a/source/java/org/alfresco/repo/search/QueryCollection.java +++ b/source/java/org/alfresco/repo/search/QueryCollection.java @@ -27,35 +27,35 @@ public interface QueryCollection /** * The name of the query collection * - * @return + * @return String */ public String getName(); /** * Does this collection contain a query for the given QName? - * @param qName - * @return + * @param qName QName + * @return boolean */ public boolean containsQueryDefinition(QName qName); /** * Get a query definition by QName. - * @param qName - * @return + * @param qName QName + * @return CannedQueryDef */ public CannedQueryDef getQueryDefinition(QName qName); /** * Does this collection contain a query for the given QName? - * @param qName - * @return + * @param qName QName + * @return boolean */ public boolean containsParameterDefinition(QName qName); /** * Get a query definition by QName. - * @param qName - * @return + * @param qName QName + * @return QueryParameterDefinition */ public QueryParameterDefinition getParameterDefinition(QName qName); @@ -64,7 +64,7 @@ public interface QueryCollection * A query may use a predefined set of prefixes for known URIs. * I would be unwise to rely on the defaults. * - * @return + * @return NamespacePrefixResolver */ public NamespacePrefixResolver getNamespacePrefixResolver(); diff --git a/source/java/org/alfresco/repo/search/QueryParameterDefImpl.java b/source/java/org/alfresco/repo/search/QueryParameterDefImpl.java index 857a405f86..964870e8c6 100644 --- a/source/java/org/alfresco/repo/search/QueryParameterDefImpl.java +++ b/source/java/org/alfresco/repo/search/QueryParameterDefImpl.java @@ -55,10 +55,10 @@ public class QueryParameterDefImpl implements QueryParameterDefinition /** * QueryParameterDefImpl * - * @param qName - * @param propertyDefinition - * @param hasDefaultValue - * @param defaultValue + * @param qName QName + * @param propertyDefinition PropertyDefinition + * @param hasDefaultValue boolean + * @param defaultValue String */ public QueryParameterDefImpl(QName qName, PropertyDefinition propertyDefinition, boolean hasDefaultValue, String defaultValue) { @@ -69,9 +69,9 @@ public class QueryParameterDefImpl implements QueryParameterDefinition /** * - * @param qName - * @param hasDefaultValue - * @param defaultValue + * @param qName QName + * @param hasDefaultValue boolean + * @param defaultValue String */ private QueryParameterDefImpl(QName qName, boolean hasDefaultValue, String defaultValue) { @@ -83,10 +83,10 @@ public class QueryParameterDefImpl implements QueryParameterDefinition /** * - * @param qName - * @param dataTypeDefintion - * @param hasDefaultValue - * @param defaultValue + * @param qName QName + * @param dataTypeDefintion DataTypeDefinition + * @param hasDefaultValue boolean + * @param defaultValue String */ public QueryParameterDefImpl(QName qName, DataTypeDefinition dataTypeDefintion, boolean hasDefaultValue, String defaultValue) { diff --git a/source/java/org/alfresco/repo/search/QueryRegisterComponent.java b/source/java/org/alfresco/repo/search/QueryRegisterComponent.java index a7d70b8fdd..1da8db6e3b 100644 --- a/source/java/org/alfresco/repo/search/QueryRegisterComponent.java +++ b/source/java/org/alfresco/repo/search/QueryRegisterComponent.java @@ -26,32 +26,32 @@ public interface QueryRegisterComponent /** * Get a query defintion by Qname * - * @param qName - * @return + * @param qName QName + * @return CannedQueryDef */ public CannedQueryDef getQueryDefinition(QName qName); /** * Get the name of the collection containing a query * - * @param qName - * @return + * @param qName QName + * @return String */ public String getCollectionNameforQueryDefinition(QName qName); /** * Get a parameter definition * - * @param qName - * @return + * @param qName QName + * @return QueryParameterDefinition */ public QueryParameterDefinition getParameterDefinition(QName qName); /** * Get the name of the collection containing a parameter definition * - * @param qName - * @return + * @param qName QName + * @return String */ public String getCollectionNameforParameterDefinition(QName qName); @@ -59,16 +59,16 @@ public interface QueryRegisterComponent /** * Get a query collection by name * - * @param name - * @return + * @param name String + * @return QueryCollection */ public QueryCollection getQueryCollection(String name); /** * Load a query collection - * - * @param location + * + * @param location String */ public void loadQueryCollection(String location); } diff --git a/source/java/org/alfresco/repo/search/SimpleResultSetMetaData.java b/source/java/org/alfresco/repo/search/SimpleResultSetMetaData.java index 7532121700..a178954f07 100644 --- a/source/java/org/alfresco/repo/search/SimpleResultSetMetaData.java +++ b/source/java/org/alfresco/repo/search/SimpleResultSetMetaData.java @@ -43,9 +43,9 @@ public class SimpleResultSetMetaData implements ResultSetMetaData /** * Default properties. * - * @param limitedBy - * @param permissoinEvaluationMode - * @param searchParameters + * @param limitedBy LimitBy + * @param permissoinEvaluationMode PermissionEvaluationMode + * @param searchParameters SearchParameters */ public SimpleResultSetMetaData(LimitBy limitedBy, PermissionEvaluationMode permissoinEvaluationMode, SearchParameters searchParameters) { diff --git a/source/java/org/alfresco/repo/search/SupportsBackgroundIndexing.java b/source/java/org/alfresco/repo/search/SupportsBackgroundIndexing.java index 7719bee999..0a0dabc6f1 100644 --- a/source/java/org/alfresco/repo/search/SupportsBackgroundIndexing.java +++ b/source/java/org/alfresco/repo/search/SupportsBackgroundIndexing.java @@ -31,7 +31,7 @@ public interface SupportsBackgroundIndexing /** * Set the back ground indexer manager * - * @param fullTextSearchIndexer + * @param fullTextSearchIndexer FullTextSearchIndexer */ public void setFullTextSearchIndexer(FullTextSearchIndexer fullTextSearchIndexer); } diff --git a/source/java/org/alfresco/repo/search/impl/SearchServiceSubSystemDelegator.java b/source/java/org/alfresco/repo/search/impl/SearchServiceSubSystemDelegator.java index 3dba397c7a..688b6cbe89 100644 --- a/source/java/org/alfresco/repo/search/impl/SearchServiceSubSystemDelegator.java +++ b/source/java/org/alfresco/repo/search/impl/SearchServiceSubSystemDelegator.java @@ -80,10 +80,10 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param store - * @param language - * @param query - * @return + * @param store StoreRef + * @param language String + * @param query String + * @return ResultSet * @see org.alfresco.service.cmr.search.SearchService#query(org.alfresco.service.cmr.repository.StoreRef, java.lang.String, java.lang.String) */ public ResultSet query(StoreRef store, String language, String query) @@ -92,11 +92,11 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param store - * @param language - * @param query - * @param queryParameterDefinitions - * @return + * @param store StoreRef + * @param language String + * @param query String + * @param queryParameterDefinitions QueryParameterDefinition[] + * @return ResultSet * @see org.alfresco.service.cmr.search.SearchService#query(org.alfresco.service.cmr.repository.StoreRef, java.lang.String, java.lang.String, org.alfresco.service.cmr.search.QueryParameterDefinition[]) */ public ResultSet query(StoreRef store, String language, String query, QueryParameterDefinition[] queryParameterDefinitions) @@ -105,10 +105,10 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param store - * @param queryId - * @param queryParameters - * @return + * @param store StoreRef + * @param queryId QName + * @param queryParameters QueryParameter[] + * @return ResultSet * @see org.alfresco.service.cmr.search.SearchService#query(org.alfresco.service.cmr.repository.StoreRef, org.alfresco.service.namespace.QName, org.alfresco.service.cmr.search.QueryParameter[]) */ public ResultSet query(StoreRef store, QName queryId, QueryParameter[] queryParameters) @@ -117,8 +117,8 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param searchParameters - * @return + * @param searchParameters SearchParameters + * @return ResultSet * @see org.alfresco.service.cmr.search.SearchService#query(org.alfresco.service.cmr.search.SearchParameters) */ public ResultSet query(SearchParameters searchParameters) @@ -127,12 +127,12 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param contextNodeRef - * @param xpath - * @param parameters - * @param namespacePrefixResolver - * @param followAllParentLinks - * @return + * @param contextNodeRef NodeRef + * @param xpath String + * @param parameters QueryParameterDefinition[] + * @param namespacePrefixResolver NamespacePrefixResolver + * @param followAllParentLinks boolean + * @return List * @throws InvalidNodeRefException * @throws XPathException * @see org.alfresco.service.cmr.search.SearchService#selectNodes(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.search.QueryParameterDefinition[], org.alfresco.service.namespace.NamespacePrefixResolver, boolean) @@ -144,13 +144,13 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param contextNodeRef - * @param xpath - * @param parameters - * @param namespacePrefixResolver - * @param followAllParentLinks - * @param language - * @return + * @param contextNodeRef NodeRef + * @param xpath String + * @param parameters QueryParameterDefinition[] + * @param namespacePrefixResolver NamespacePrefixResolver + * @param followAllParentLinks boolean + * @param language String + * @return List * @throws InvalidNodeRefException * @throws XPathException * @see org.alfresco.service.cmr.search.SearchService#selectNodes(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.search.QueryParameterDefinition[], org.alfresco.service.namespace.NamespacePrefixResolver, boolean, java.lang.String) @@ -163,12 +163,12 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param contextNodeRef - * @param xpath - * @param parameters - * @param namespacePrefixResolver - * @param followAllParentLinks - * @return + * @param contextNodeRef NodeRef + * @param xpath String + * @param parameters QueryParameterDefinition[] + * @param namespacePrefixResolver NamespacePrefixResolver + * @param followAllParentLinks boolean + * @return List * @throws InvalidNodeRefException * @throws XPathException * @see org.alfresco.service.cmr.search.SearchService#selectProperties(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.search.QueryParameterDefinition[], org.alfresco.service.namespace.NamespacePrefixResolver, boolean) @@ -180,13 +180,13 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param contextNodeRef - * @param xpath - * @param parameters - * @param namespacePrefixResolver - * @param followAllParentLinks - * @param language - * @return + * @param contextNodeRef NodeRef + * @param xpath String + * @param parameters QueryParameterDefinition[] + * @param namespacePrefixResolver NamespacePrefixResolver + * @param followAllParentLinks boolean + * @param language String + * @return List * @throws InvalidNodeRefException * @throws XPathException * @see org.alfresco.service.cmr.search.SearchService#selectProperties(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.search.QueryParameterDefinition[], org.alfresco.service.namespace.NamespacePrefixResolver, boolean, java.lang.String) @@ -199,10 +199,10 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param nodeRef - * @param propertyQName - * @param googleLikePattern - * @return + * @param nodeRef NodeRef + * @param propertyQName QName + * @param googleLikePattern String + * @return boolean * @throws InvalidNodeRefException * @see org.alfresco.service.cmr.search.SearchService#contains(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String) */ @@ -212,11 +212,11 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param nodeRef - * @param propertyQName - * @param googleLikePattern - * @param defaultOperator - * @return + * @param nodeRef NodeRef + * @param propertyQName QName + * @param googleLikePattern String + * @param defaultOperator Operator + * @return boolean * @throws InvalidNodeRefException * @see org.alfresco.service.cmr.search.SearchService#contains(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String, org.alfresco.service.cmr.search.SearchParameters.Operator) */ @@ -226,11 +226,11 @@ public class SearchServiceSubSystemDelegator implements SearchService } /** - * @param nodeRef - * @param propertyQName - * @param sqlLikePattern - * @param includeFTS - * @return + * @param nodeRef NodeRef + * @param propertyQName QName + * @param sqlLikePattern String + * @param includeFTS boolean + * @return boolean * @throws InvalidNodeRefException * @see org.alfresco.service.cmr.search.SearchService#like(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String, boolean) */ diff --git a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerAndSearcherFactory.java b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerAndSearcherFactory.java index 37ecf6baae..89fb972f30 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerAndSearcherFactory.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerAndSearcherFactory.java @@ -90,7 +90,7 @@ public class ADMLuceneIndexerAndSearcherFactory extends AbstractLuceneIndexerAnd /** * Sets the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerImpl.java index c96eba807e..42214a4fc8 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneIndexerImpl.java @@ -180,7 +180,7 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * IOC setting of the node service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -190,7 +190,7 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * IOC setting of the tenant service * - * @param tenantService + * @param tenantService TenantService */ public void setTenantService(TenantService tenantService) { @@ -200,7 +200,7 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * IOC setting of the content service * - * @param contentService + * @param contentService ContentService */ public void setContentService(ContentService contentService) { @@ -209,7 +209,7 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * Setter of the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { @@ -475,9 +475,9 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * Generate an indexer * - * @param storeRef - * @param deltaId - * @param config + * @param storeRef StoreRef + * @param deltaId String + * @param config LuceneConfig * @return - the indexer instance * @throws LuceneIndexException */ @@ -613,8 +613,8 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * Helper class to hold two related objects * - * @param first - * @param second + * @param first F + * @param second S */ public Pair(F first, S second) { @@ -1970,7 +1970,7 @@ public class ADMLuceneIndexerImpl extends AbstractLuceneIndexerImpl imp /** * Does the node type or any applied aspect allow this node to have child associations? * - * @param nodeRef + * @param nodeRef NodeRef * @return true if the node may have children */ private boolean mayHaveChildren(NodeRef nodeRef) diff --git a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneSearcherImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneSearcherImpl.java index 3d347ef737..5023994954 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneSearcherImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/ADMLuceneSearcherImpl.java @@ -89,9 +89,9 @@ public class ADMLuceneSearcherImpl extends AbstractLuceneBase implements LuceneS * Get an initialised searcher for the store and transaction Normally we do not search against a a store and delta. * Currently only gets the searcher against the main index. * - * @param storeRef - * @param indexer - * @param config + * @param storeRef StoreRef + * @param indexer LuceneIndexer + * @param config LuceneConfig * @return - the searcher implementation */ public static ADMLuceneSearcherImpl getSearcher(StoreRef storeRef, LuceneIndexer indexer, LuceneConfig config) @@ -113,8 +113,8 @@ public class ADMLuceneSearcherImpl extends AbstractLuceneBase implements LuceneS /** * Get an intialised searcher for the store. No transactional ammendsmends are searched. * - * @param storeRef - * @param config + * @param storeRef StoreRef + * @param config LuceneConfig * @return the searcher */ public static ADMLuceneSearcherImpl getSearcher(StoreRef storeRef, LuceneConfig config) @@ -125,7 +125,7 @@ public class ADMLuceneSearcherImpl extends AbstractLuceneBase implements LuceneS /** * Get a select-node-based searcher * - * @return + * @return ADMLuceneSearcherImpl */ public static ADMLuceneSearcherImpl getNodeSearcher() { @@ -176,7 +176,7 @@ public class ADMLuceneSearcherImpl extends AbstractLuceneBase implements LuceneS /** * Set the query register * - * @param queryRegister + * @param queryRegister QueryRegisterComponent */ public void setQueryRegister(QueryRegisterComponent queryRegister) { @@ -325,8 +325,8 @@ public class ADMLuceneSearcherImpl extends AbstractLuceneBase implements LuceneS /** * The definitions must provide a default value, or of not there must be a parameter to provide the value * - * @param definition - * @param queryParameters + * @param definition CannedQueryDef + * @param queryParameters QueryParameter[] * @throws QueryParameterisationException */ private void checkParameters(CannedQueryDef definition, QueryParameter[] queryParameters) throws QueryParameterisationException diff --git a/source/java/org/alfresco/repo/search/impl/lucene/AbstractAlfrescoFtsQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/lucene/AbstractAlfrescoFtsQueryLanguage.java index a50523d5a0..00aac0565a 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/AbstractAlfrescoFtsQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/AbstractAlfrescoFtsQueryLanguage.java @@ -58,7 +58,7 @@ public abstract class AbstractAlfrescoFtsQueryLanguage extends AbstractLuceneQue /** * Set the query engine * - * @param queryEngine + * @param queryEngine QueryEngine */ public void setQueryEngine(QueryEngine queryEngine) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneBase.java b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneBase.java index c6e61eade7..a5f6149023 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneBase.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneBase.java @@ -86,9 +86,9 @@ public abstract class AbstractLuceneBase /** * Initialise the configuration elements of the lucene store indexers and searchers. * - * @param store - * @param deltaId - * @throws IOException + * @param store StoreRef + * @param deltaId String + * @throws LuceneIndexException */ protected void initialise(StoreRef store, String deltaId) throws LuceneIndexException @@ -142,7 +142,7 @@ public abstract class AbstractLuceneBase * Get a searcher for the main index TODO: Split out support for the main index. We really only need this if we want to search over the changing index before it is committed * * @return - the searcher - * @throws IOException + * @throws LuceneIndexException */ protected IndexSearcher getSearcher() throws LuceneIndexException @@ -280,7 +280,7 @@ public abstract class AbstractLuceneBase /** * Set the dictionary service - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -300,7 +300,7 @@ public abstract class AbstractLuceneBase /** * Set the lucene configuration options * - * @param config + * @param config LuceneConfig */ public void setLuceneConfig(LuceneConfig config) { @@ -330,9 +330,9 @@ public abstract class AbstractLuceneBase /** * Execute actions against a read only index (all write ops will block) - * - * @param - * @param lockWork + * + * @param lockWork LockWork + * @param R * @return - the result returned by the action. */ public R doReadOnly(LockWork lockWork) diff --git a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java index db3ebd76b2..796a6d3884 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java @@ -240,7 +240,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the directory that contains the indexes * - * @param indexRootLocation + * @param indexRootLocation String */ public void setIndexRootLocation(String indexRootLocation) @@ -251,7 +251,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the tenant service * - * @param tenantService + * @param tenantService TenantService */ public void setTenantService(TenantService tenantService) { @@ -261,7 +261,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the query register * - * @param queryRegister + * @param queryRegister QueryRegisterComponent */ public void setQueryRegister(QueryRegisterComponent queryRegister) { @@ -431,7 +431,8 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Get the transaction identifier used to store it in the transaction map. * - * @param tx + * @param tx Transaction + * @param storeRef StoreRef * @return - the transaction id */ @SuppressWarnings("unchecked") @@ -460,8 +461,8 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Encapsulate creating an indexer * - * @param storeRef - * @param deltaId + * @param storeRef StoreRef + * @param deltaId String * @return - the indexer made by the concrete implemntation */ protected abstract LuceneIndexer createIndexer(StoreRef storeRef, String deltaId); @@ -493,13 +494,13 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn protected abstract SearchService getNodeSearcher() throws SearcherException; /** - * Get a searcher over the index and the current delta - * - * @param storeRef - * @param indexer - * @return - the searcher made by the concrete implementation. - * @throws SearcherException - */ + * Get a searcher over the index and the current delta + * + * @param storeRef StoreRef + * @param indexer LuceneIndexer + * @return - the searcher made by the concrete implementation. + * @throws SearcherException + */ protected abstract LuceneSearcher getSearcher(StoreRef storeRef, LuceneIndexer indexer) throws SearcherException; @@ -901,7 +902,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the batch six to use for background indexing * - * @param indexerBatchSize + * @param indexerBatchSize int */ @Override public void setIndexerBatchSize(int indexerBatchSize) @@ -959,7 +960,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the max number of queries in a llucen boolean query * - * @param queryMaxClauses + * @param queryMaxClauses int */ @Override public void setQueryMaxClauses(int queryMaxClauses) @@ -971,7 +972,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the lucene write lock timeout * - * @param timeout + * @param timeout long */ @Override public void setWriteLockTimeout(long timeout) @@ -982,7 +983,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the lucene commit lock timeout (no longer used with lucene 2.1) * - * @param timeout + * @param timeout long */ @Override public void setCommitLockTimeout(long timeout) @@ -1015,7 +1016,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the lock poll interval in ms * - * @param time + * @param time long */ @Override public void setLockPollInterval(long time) @@ -1037,7 +1038,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the max field length. * - * @param indexerMaxFieldLength + * @param indexerMaxFieldLength int */ @Override public void setIndexerMaxFieldLength(int indexerMaxFieldLength) @@ -1123,7 +1124,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * If false do not check the index configuration. * - * @param checkConfiguration + * @param checkConfiguration boolean */ public void setCheckConfiguration(boolean checkConfiguration) { @@ -1133,7 +1134,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Provides transactions in which to perform the work * - * @param transactionService + * @param transactionService TransactionService */ public void setTransactionService(TransactionService transactionService) { @@ -1339,9 +1340,9 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Note files can alter due to background processes so file not found is Ok * - * @param srcDir - * @param destDir - * @param preserveFileDate + * @param srcDir File + * @param destDir File + * @param preserveFileDate boolean * @throws IOException */ private void copyDirectory(File srcDir, File destDir, boolean preserveFileDate) throws IOException @@ -1636,7 +1637,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the ML analysis mode at index time. * - * @param mode + * @param mode MLAnalysisMode */ @Override public void setDefaultMLIndexAnalysisMode(MLAnalysisMode mode) @@ -1654,7 +1655,7 @@ public abstract class AbstractLuceneIndexerAndSearcherFactory extends AbstractIn /** * Set the ML analysis mode at search time * - * @param mode + * @param mode MLAnalysisMode */ @Override public void setDefaultMLSearchAnalysisMode(MLAnalysisMode mode) diff --git a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerImpl.java index 9d938dc431..7b6f362986 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerImpl.java @@ -342,8 +342,8 @@ public abstract class AbstractLuceneIndexerImpl extends AbstractLuceneBase im /** * Set the max time allowed to transform content atomically - * - * @param maxAtomicTransformationTime + * + * @param maxAtomicTransformationTime long */ public void setMaxAtomicTransformationTime(long maxAtomicTransformationTime) { @@ -353,7 +353,8 @@ public abstract class AbstractLuceneIndexerImpl extends AbstractLuceneBase im /** * Utility method to check we are in the correct state to do work Also keeps track of the dirty flag. * - * @throws IOException + * @throws IndexerException + * @throws LuceneIndexException */ protected void checkAbleToDoWork(IndexUpdateStatus indexUpdateStatus) diff --git a/source/java/org/alfresco/repo/search/impl/lucene/DebugXPathHandler.java b/source/java/org/alfresco/repo/search/impl/lucene/DebugXPathHandler.java index 0a6092a291..92cac91a83 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/DebugXPathHandler.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/DebugXPathHandler.java @@ -255,7 +255,7 @@ public class DebugXPathHandler implements XPathHandler } /** - * @param args + * @param args String[] * @throws SAXPathException */ public static void main(String[] args) throws SAXPathException diff --git a/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java b/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java index d7acf68774..51a286adca 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java @@ -62,10 +62,11 @@ public class FilterIndexReaderByStringId extends FilterIndexReader /** * Apply the filter * - * @param id - * @param reader - * @param deletions - * @param deleteNodesOnly + * @param id String + * @param reader IndexReader + * @param deletions Set + * @param containerDeletions Set + * @param deleteNodesOnly boolean */ public FilterIndexReaderByStringId(String id, IndexReader reader, Set deletions, Set containerDeletions, boolean deleteNodesOnly) { @@ -195,12 +196,12 @@ public class FilterIndexReaderByStringId extends FilterIndexReader String id; - /** - * @param id - * @param in - */ - public FilterTermDocs(String id, TermDocs in) - { + /** + * @param id String + * @param in TermDocs + */ + public FilterTermDocs(String id, TermDocs in) + { this.in = in; } @@ -332,18 +333,18 @@ public class FilterIndexReaderByStringId extends FilterIndexReader } } - /** Base class for filtering {@link TermPositions} implementations. */ + /** Base class for filtering {@code TermPositions} implementations. */ public class FilterTermPositions extends FilterTermDocs implements TermPositions { TermPositions tp; - /** - * @param id - * @param in - */ - public FilterTermPositions(String id, TermPositions in) - { + /** + * @param id String + * @param in TermPositions + */ + public FilterTermPositions(String id, TermPositions in) + { super(id, in); tp = in; } diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneAlfrescoSqlQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneAlfrescoSqlQueryLanguage.java index 16749c9482..e26139bc90 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneAlfrescoSqlQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneAlfrescoSqlQueryLanguage.java @@ -45,7 +45,7 @@ public class LuceneAlfrescoSqlQueryLanguage extends AbstractLuceneQueryLanguage /** * Set the search service * - * @param cmisQueryService + * @param cmisQueryService CMISQueryService */ public void setCmisQueryService(CMISQueryService cmisQueryService) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java index 798b848ebc..66a929f222 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java @@ -89,27 +89,27 @@ public class LuceneCategoryServiceImpl implements CategoryService /** * Set the node service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; } - /** - * Set the public node service - * - * @param publicNodeService - */ - public void setPublicNodeService(NodeService publicNodeService) - { + /** + * Set the public node service + * + * @param publicNodeService NodeService + */ + public void setPublicNodeService(NodeService publicNodeService) + { this.publicNodeService = publicNodeService; } /** * Set the tenant service * - * @param tenantService + * @param tenantService TenantService */ public void setTenantService(TenantService tenantService) { @@ -119,7 +119,7 @@ public class LuceneCategoryServiceImpl implements CategoryService /** * Set the service to map prefixes to uris * - * @param namespacePrefixResolver + * @param namespacePrefixResolver NamespacePrefixResolver */ public void setNamespacePrefixResolver(NamespacePrefixResolver namespacePrefixResolver) { @@ -129,7 +129,7 @@ public class LuceneCategoryServiceImpl implements CategoryService /** * Set the dictionary service * - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -139,7 +139,7 @@ public class LuceneCategoryServiceImpl implements CategoryService /** * Set the indexer and searcher * - * @param indexerAndSearcher + * @param indexerAndSearcher IndexerAndSearcher */ public void setIndexerAndSearcher(IndexerAndSearcher indexerAndSearcher) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneCmisStrictSqlQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneCmisStrictSqlQueryLanguage.java index 9f61505578..a3d7d34cdd 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneCmisStrictSqlQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneCmisStrictSqlQueryLanguage.java @@ -45,7 +45,7 @@ public class LuceneCmisStrictSqlQueryLanguage extends AbstractLuceneQueryLanguag /** * Set the search service * - * @param cmisQueryService + * @param cmisQueryService CMISQueryService */ public void setCmisQueryService(CMISQueryService cmisQueryService) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneConfig.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneConfig.java index 9e835131fe..6c7ad56775 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneConfig.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneConfig.java @@ -29,56 +29,56 @@ public interface LuceneConfig /** * Set the lock dir - just to make sure - this should no longer be used. * - * @param lockDirectory + * @param lockDirectory String */ public void setLockDirectory(String lockDirectory); /** * The path to the index location * - * @return + * @return String */ public String getIndexRootLocation(); /** * The batch size in which to group flushes of the index. * - * @return + * @return int */ public int getIndexerBatchSize(); /** * The maximum numbr of sub-queries the can be generated out of wild card expansion etc * - * @return + * @return int */ public int getQueryMaxClauses(); /** * The default mode for analysing ML text during index. * - * @return + * @return MLAnalysisMode */ public MLAnalysisMode getDefaultMLIndexAnalysisMode(); /** * The default mode for analysis of ML text during search. * - * @return + * @return MLAnalysisMode */ public MLAnalysisMode getDefaultMLSearchAnalysisMode(); /** * Get the max field length that determine how many tokens are put into the index * - * @return + * @return int */ public int getIndexerMaxFieldLength(); /** * Get the thread pool for index merging etc * - * @return + * @return ThreadPoolExecutor */ public ThreadPoolExecutor getThreadPoolExecutor(); @@ -89,56 +89,56 @@ public interface LuceneConfig /** * Use the nio memory mapping (work arounf for bugs with some JVMs) - * @return + * @return boolean */ public boolean getUseNioMemoryMapping(); /** * Max doc number that will merged in memory (and not on disk) * - * @return + * @return int */ public int getMaxDocsForInMemoryMerge(); /** * Lucene writer config - * @return + * @return int */ public int getWriterMaxBufferedDocs(); /** * Lucene writer config - * @return + * @return int */ public int getWriterMergeFactor(); /** * Lucene writer config - * @return + * @return int */ public int getWriterMaxMergeDocs(); /** * Lucene merger config - * @return + * @return int */ public int getMergerMaxBufferedDocs(); /** * Lucene merger config - * @return + * @return int */ public int getMergerMergeFactor(); /** * Lucene merger config - * @return + * @return int */ public int getMergerMaxMergeDocs(); /** * Target overlays (will apply deletions and create indexes if over this limit) - * @return + * @return int */ public int getMergerTargetOverlayCount(); @@ -153,61 +153,61 @@ public interface LuceneConfig /** * Target index count. Over this indexes will be merged together. - * @return + * @return int */ public int getMergerTargetIndexCount(); /** * Lucene term index interval - * @return + * @return int */ public int getTermIndexInterval(); /** * Is caching enabled for each index fragment? - * @return + * @return boolean */ public boolean isCacheEnabled(); /** * How many categories to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxIsCategoryCacheSize(); /** * How many documents to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxDocumentCacheSize(); /** * How many document ids to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxDocIdCacheSize(); /** * How many paths to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxPathCacheSize(); /** * How many types to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxTypeCacheSize(); /** * How many parents to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxParentCacheSize(); /** * How many link aspects to cache (-ve => unbounded) - * @return + * @return int */ public int getMaxLinkAspectCacheSize(); @@ -220,43 +220,43 @@ public interface LuceneConfig * * In the future, this behaviour may also be set per query on the SearchParameters object. * - * @return + * @return boolean */ public boolean getPostSortDateTime(); /** * Gets the application context through which events can be broadcast - * @return + * @return ConfigurableApplicationContext */ public ConfigurableApplicationContext getApplicationContext(); /** * Ram based limit for in memory merges - * @return + * @return double */ public double getMaxRamInMbForInMemoryMerge(); /** * Ram based limit for in memory portion of writer index. - * @return + * @return double */ public double getWriterRamBufferSizeMb(); /** * Ram based limit for in memory portion of merger index. - * @return + * @return double */ public double getMergerRamBufferSizeMb(); /** * Max docs to allow for in memory indexes (does no apply to merges) - * @return + * @return int */ public int getMaxDocsForInMemoryIndex(); /** * Max Ram to allow for in memory indexes (does not apply to merges) - * @return + * @return double */ public double getMaxRamInMbForInMemoryIndex(); @@ -269,207 +269,207 @@ public interface LuceneConfig public boolean getFairLocking(); /** - * @param maxAtomicTransformationTime + * @param maxAtomicTransformationTime long */ void setMaxAtomicTransformationTime(long maxAtomicTransformationTime); /** - * @return + * @return long */ long getMaxTransformationTime(); /** - * @return + * @return boolean */ public boolean getUseInMemorySort(); /** - * @param indexerBatchSize + * @param indexerBatchSize int */ void setIndexerBatchSize(int indexerBatchSize); /** - * @param queryMaxClauses + * @param queryMaxClauses int */ void setQueryMaxClauses(int queryMaxClauses); /** - * @param timeout + * @param timeout long */ void setWriteLockTimeout(long timeout); /** - * @param timeout + * @param timeout long */ void setCommitLockTimeout(long timeout); /** - * @return + * @return long */ long getCommitLockTimeout(); /** - * @return + * @return long */ long getWriteLockTimeout(); /** - * @param time + * @param time long */ void setLockPollInterval(long time); /** - * @param indexerMaxFieldLength + * @param indexerMaxFieldLength int */ void setIndexerMaxFieldLength(int indexerMaxFieldLength); /** - * @param mode + * @param mode MLAnalysisMode */ void setDefaultMLIndexAnalysisMode(MLAnalysisMode mode); /** - * @param mode + * @param mode MLAnalysisMode */ void setDefaultMLSearchAnalysisMode(MLAnalysisMode mode); /** - * @param maxDocIdCacheSize + * @param maxDocIdCacheSize int */ void setMaxDocIdCacheSize(int maxDocIdCacheSize); /** - * @param maxDocsForInMemoryMerge + * @param maxDocsForInMemoryMerge int */ void setMaxDocsForInMemoryMerge(int maxDocsForInMemoryMerge); /** - * @param maxDocumentCacheSize + * @param maxDocumentCacheSize int */ void setMaxDocumentCacheSize(int maxDocumentCacheSize); /** - * @param maxIsCategoryCacheSize + * @param maxIsCategoryCacheSize int */ void setMaxIsCategoryCacheSize(int maxIsCategoryCacheSize); /** - * @param maxLinkAspectCacheSize + * @param maxLinkAspectCacheSize int */ void setMaxLinkAspectCacheSize(int maxLinkAspectCacheSize); /** - * @param maxParentCacheSize + * @param maxParentCacheSize int */ void setMaxParentCacheSize(int maxParentCacheSize); /** - * @param maxPathCacheSize + * @param maxPathCacheSize int */ void setMaxPathCacheSize(int maxPathCacheSize); /** - * @param maxTypeCacheSize + * @param maxTypeCacheSize int */ void setMaxTypeCacheSize(int maxTypeCacheSize); /** - * @param mergerMaxMergeDocs + * @param mergerMaxMergeDocs int */ void setMergerMaxMergeDocs(int mergerMaxMergeDocs); /** - * @param mergerMergeFactor + * @param mergerMergeFactor int */ void setMergerMergeFactor(int mergerMergeFactor); /** - * @param mergerMaxBufferedDocs + * @param mergerMaxBufferedDocs int */ void setMergerMaxBufferedDocs(int mergerMaxBufferedDocs); /** - * @param mergerTargetIndexCount + * @param mergerTargetIndexCount int */ void setMergerTargetIndexCount(int mergerTargetIndexCount); /** - * @param mergerTargetOverlayCount + * @param mergerTargetOverlayCount int */ void setMergerTargetOverlayCount(int mergerTargetOverlayCount); /** - * @param mergerTargetOverlaysBlockingFactor + * @param mergerTargetOverlaysBlockingFactor int */ void setMergerTargetOverlaysBlockingFactor(int mergerTargetOverlaysBlockingFactor); /** - * @param fairLocking + * @param fairLocking boolean */ void setFairLocking(boolean fairLocking); /** - * @param termIndexInterval + * @param termIndexInterval int */ void setTermIndexInterval(int termIndexInterval); /** - * @param useNioMemoryMapping + * @param useNioMemoryMapping boolean */ void setUseNioMemoryMapping(boolean useNioMemoryMapping); /** - * @param writerMaxMergeDocs + * @param writerMaxMergeDocs int */ void setWriterMaxMergeDocs(int writerMaxMergeDocs); /** - * @param writerMergeFactor + * @param writerMergeFactor int */ void setWriterMergeFactor(int writerMergeFactor); /** - * @return + * @return int */ public int getMaxRawResultSetSizeForInMemorySort(); /** - * @param writerMaxBufferedDocs + * @param writerMaxBufferedDocs int */ void setWriterMaxBufferedDocs(int writerMaxBufferedDocs); /** - * @param cacheEnabled + * @param cacheEnabled boolean */ void setCacheEnabled(boolean cacheEnabled); /** - * @param postSortDateTime + * @param postSortDateTime boolean */ void setPostSortDateTime(boolean postSortDateTime); /** - * @param maxDocsForInMemoryIndex + * @param maxDocsForInMemoryIndex int */ void setMaxDocsForInMemoryIndex(int maxDocsForInMemoryIndex); /** - * @param maxRamInMbForInMemoryMerge + * @param maxRamInMbForInMemoryMerge double */ void setMaxRamInMbForInMemoryMerge(double maxRamInMbForInMemoryMerge); /** - * @param maxRamInMbForInMemoryIndex + * @param maxRamInMbForInMemoryIndex double */ void setMaxRamInMbForInMemoryIndex(double maxRamInMbForInMemoryIndex); /** - * @param mergerRamBufferSizeMb + * @param mergerRamBufferSizeMb double */ void setMergerRamBufferSizeMb(double mergerRamBufferSizeMb); /** - * @param writerRamBufferSizeMb + * @param writerRamBufferSizeMb double */ void setWriterRamBufferSizeMb(double writerRamBufferSizeMb); @@ -485,7 +485,7 @@ public interface LuceneConfig * Content is not indexed and FTS disabled * When disabled, documents are marked as requiring FTS indexing. * When enabled the normal FTS process will catch up with content that was not indexed. - * @param contentIndexingEnabled + * @param contentIndexingEnabled boolean */ void setContentIndexingEnabled(boolean contentIndexingEnabled); diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISAlfrescoSqlQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISAlfrescoSqlQueryLanguage.java index 17a7ad2c0a..5a645ae9f1 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISAlfrescoSqlQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISAlfrescoSqlQueryLanguage.java @@ -45,7 +45,7 @@ public class LuceneOpenCMISAlfrescoSqlQueryLanguage extends AbstractLuceneQueryL /** * Set the search service * - * @param cmisQueryService + * @param cmisQueryService CMISQueryService */ public void setCmisQueryService(CMISQueryService cmisQueryService) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISStrictSqlQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISStrictSqlQueryLanguage.java index 385f360572..fda7a1e2ad 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISStrictSqlQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneOpenCMISStrictSqlQueryLanguage.java @@ -50,7 +50,7 @@ public class LuceneOpenCMISStrictSqlQueryLanguage extends AbstractLuceneQueryLan /** * Set the search service * - * @param cmisQueryService + * @param cmisQueryService CMISQueryService */ public void setCmisQueryService(CMISQueryService cmisQueryService) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneQueryLanguageSPI.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneQueryLanguageSPI.java index 4b1a026f38..5cefb75977 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneQueryLanguageSPI.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneQueryLanguageSPI.java @@ -40,8 +40,8 @@ public interface LuceneQueryLanguageSPI /** * Execute the query - * @param searchParameters - * @param admLuceneSearcher + * @param searchParameters SearchParameters + * @param admLuceneSearcher ADMLuceneSearcherImpl * @return - the query results */ public ResultSet executeQuery(SearchParameters searchParameters, ADMLuceneSearcherImpl admLuceneSearcher); diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java index 9e34a51bb6..2a6a9063d3 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java @@ -74,18 +74,18 @@ public class LuceneResultSet extends AbstractResultSet private int bulkFetchSize = DEFAULT_BULK_FETCH_SIZE; - /** - * Wrap a lucene seach result with node support - * - * @param hits - * @param searcher - * @param nodeService nodeService - * @param tenantService tenant service - * @param searchParameters - * @param config - lucene config - */ - public LuceneResultSet(Hits hits, Searcher searcher, NodeService nodeService, TenantService tenantService, SearchParameters searchParameters, - LuceneConfig config) + /** + * Wrap a lucene seach result with node support + * + * @param hits Hits + * @param searcher Searcher + * @param nodeService nodeService + * @param tenantService tenant service + * @param searchParameters SearchParameters + * @param config - lucene config + */ + public LuceneResultSet(Hits hits, Searcher searcher, NodeService nodeService, TenantService tenantService, SearchParameters searchParameters, + LuceneConfig config) { super(); this.hits = hits; @@ -275,7 +275,7 @@ public class LuceneResultSet extends AbstractResultSet /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ @Override public boolean setBulkFetch(boolean bulkFetch) @@ -299,7 +299,7 @@ public class LuceneResultSet extends AbstractResultSet /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ @Override public int setBulkFetchSize(int bulkFetchSize) @@ -321,8 +321,8 @@ public class LuceneResultSet extends AbstractResultSet } /** - * @param index - * @return + * @param index int + * @return int */ public int doc(int index) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRow.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRow.java index 182e45ec4e..84f01b7fd9 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRow.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRow.java @@ -46,13 +46,13 @@ public class LuceneResultSetRow extends AbstractResultSetRow private TenantService tenantService; /** - * Wrap a position in a lucene Hits class with node support - * - * @param resultSet - * @param index - */ - public LuceneResultSetRow(LuceneResultSet resultSet, int index) - { + * Wrap a position in a lucene Hits class with node support + * + * @param resultSet LuceneResultSet + * @param index int + */ + public LuceneResultSetRow(LuceneResultSet resultSet, int index) + { super(resultSet, index); tenantService = resultSet.getTenantService(); @@ -61,7 +61,7 @@ public class LuceneResultSetRow extends AbstractResultSetRow /** * Support to cache the document for this row * - * @return + * @return Document */ public Document getDocument() { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRowIterator.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRowIterator.java index bf36587bcc..b29a827de4 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRowIterator.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSetRowIterator.java @@ -33,7 +33,7 @@ public class LuceneResultSetRowIterator extends AbstractResultSetRowIterator * Create an iterator over the result set. Follows standard ListIterator * conventions * - * @param resultSet + * @param resultSet LuceneResultSet */ public LuceneResultSetRowIterator(LuceneResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/LuceneSearcher.java b/source/java/org/alfresco/repo/search/impl/lucene/LuceneSearcher.java index 2a75149839..01faf2d9de 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneSearcher.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneSearcher.java @@ -39,27 +39,27 @@ public interface LuceneSearcher extends SearchService public boolean indexExists(); /** * Ste the node service - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService); /** * Set the name space service - * @param namespacePrefixResolver + * @param namespacePrefixResolver NamespacePrefixResolver */ public void setNamespacePrefixResolver(NamespacePrefixResolver namespacePrefixResolver); /** * Get top terms * - * @param field - * @param count - * @return + * @param field String + * @param count int + * @return List */ public List> getTopTerms(String field, int count); /** * Get a lucene searcher - * @return + * @return ClosingIndexSearcher */ public ClosingIndexSearcher getClosingIndexSearcher(); } diff --git a/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSet.java b/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSet.java index f1d8984ee2..f921ddb02e 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSet.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSet.java @@ -201,7 +201,7 @@ public class PagingLuceneResultSet implements ResultSet, Serializable /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ public boolean setBulkFetch(boolean bulkFetch) { @@ -221,7 +221,7 @@ public class PagingLuceneResultSet implements ResultSet, Serializable /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ public int setBulkFetchSize(int bulkFetchSize) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSetRowIteratorImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSetRowIteratorImpl.java index d55b5332cd..21ad640849 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSetRowIteratorImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/PagingLuceneResultSetRowIteratorImpl.java @@ -45,7 +45,7 @@ public class PagingLuceneResultSetRowIteratorImpl implements ListIterator * @throws IOException */ public Set getDeletions(String id) throws IOException @@ -1200,8 +1202,9 @@ public class IndexInfo implements IndexMonitor /** * Get the deletions for a given index (there is no check if they should be applied that is up to the calling layer) * - * @param id - * @return + * @param id String + * @param fileName String + * @return Set * @throws IOException */ private Set getDeletions(String id, String fileName) throws IOException @@ -1291,8 +1294,9 @@ public class IndexInfo implements IndexMonitor } /** - * @param id - * @param toDelete + * @param id String + * @param toDelete Set + * @param fileName String * @throws IOException * @throws FileNotFoundException */ @@ -1350,7 +1354,7 @@ public class IndexInfo implements IndexMonitor /** * Get the main reader for committed index data * - * @return + * @return IndexReader * @throws IOException */ public IndexReader getMainIndexReferenceCountingReadOnlyIndexReader() throws IOException @@ -1441,10 +1445,11 @@ public class IndexInfo implements IndexMonitor /** * Get the main index reader augmented with the specified TX data As above but we add the TX data * - * @param id - * @param deletions - * @param deleteOnlyNodes - * @return + * @param id String + * @param deletions Set + * @param containerDeletions Set + * @param deleteOnlyNodes boolean + * @return IndexReader * @throws IOException */ public IndexReader getMainIndexReferenceCountingReadOnlyIndexReader(String id, Set deletions, Set containerDeletions, boolean deleteOnlyNodes) throws IOException @@ -2147,12 +2152,12 @@ public class IndexInfo implements IndexMonitor } } - /** - * Check status must be called holding the file lock. - * - * @throws IOException - */ - private void setStatusFromFile() throws IOException + /** + * Check status must be called holding the file lock. + * + * @throws IOException + */ + private void setStatusFromFile() throws IOException { try { @@ -2875,7 +2880,7 @@ public class IndexInfo implements IndexMonitor /** * Helper to print out index information * - * @param args + * @param args String[] * @throws Throwable */ public static void main(String[] args) throws Throwable @@ -3358,12 +3363,12 @@ public class IndexInfo implements IndexMonitor if (s_logger.isDebugEnabled()) { dumpInfo(); - } - } - - private MergeAction decideMergeAction() - { - MergeAction action = MergeAction.NONE; + } + } + + private MergeAction decideMergeAction() + { + MergeAction action = MergeAction.NONE; int indexes = 0; boolean mergingIndexes = false; int deltas = 0; diff --git a/source/java/org/alfresco/repo/search/impl/lucene/index/ReferenceCounting.java b/source/java/org/alfresco/repo/search/impl/lucene/index/ReferenceCounting.java index 0985a2447b..cc76e50707 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/index/ReferenceCounting.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/index/ReferenceCounting.java @@ -38,7 +38,7 @@ public interface ReferenceCounting /** * Get the number of references - * @return + * @return int */ public int getReferenceCount(); @@ -50,13 +50,13 @@ public interface ReferenceCounting /** * Determine if valid for reuse - * @return + * @return boolean */ public boolean isInvalidForReuse(); /** * Get the id for this reader. - * @return + * @return String */ public String getId(); } \ No newline at end of file diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBColumn.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBColumn.java index 9df1d0ceb6..2c381fe2ea 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBColumn.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBColumn.java @@ -32,9 +32,9 @@ public class DBColumn extends BaseColumn { /** - * @param function - * @param functionArguments - * @param alias + * @param function Function + * @param functionArguments Map + * @param alias String */ public DBColumn(Function function, Map functionArguments, String alias) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBConjunction.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBConjunction.java index c77885177e..7f5e0a1de0 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBConjunction.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBConjunction.java @@ -42,7 +42,7 @@ public class DBConjunction extends BaseConjunction implements DBQueryBuilderComp { /** - * @param constraints + * @param constraints List */ public DBConjunction(List constraints) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBDisjunction.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBDisjunction.java index aea84082db..4d2f99db87 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBDisjunction.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBDisjunction.java @@ -42,7 +42,7 @@ public class DBDisjunction extends BaseDisjunction implements DBQueryBuilderComp { /** - * @param constraints + * @param constraints List */ public DBDisjunction(List constraints) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionArgument.java index 31c4c5af33..ebbd4fb74d 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionArgument.java @@ -32,9 +32,9 @@ public class DBFunctionArgument extends BaseFunctionArgument { /** - * @param name - * @param function - * @param arguments + * @param name String + * @param function Function + * @param arguments Map */ public DBFunctionArgument(String name, Function function, Map arguments) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionalConstraint.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionalConstraint.java index 42fd47420b..2616baf598 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionalConstraint.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBFunctionalConstraint.java @@ -41,8 +41,8 @@ public class DBFunctionalConstraint extends BaseFunctionalConstraint implements { /** - * @param function - * @param arguments + * @param function Function + * @param arguments Map */ public DBFunctionalConstraint(Function function, Map arguments) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBJoin.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBJoin.java index 4a3eedfacc..8fb97a3032 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBJoin.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBJoin.java @@ -31,10 +31,10 @@ public class DBJoin extends BaseJoin { /** - * @param left - * @param right - * @param joinType - * @param joinConstraint + * @param left Source + * @param right Source + * @param joinType JoinType + * @param joinConstraint Constraint */ public DBJoin(Source left, Source right, JoinType joinType, Constraint joinConstraint) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBListArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBListArgument.java index 8cb57d9957..59e15bd26b 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBListArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBListArgument.java @@ -31,8 +31,8 @@ public class DBListArgument extends BaseListArgument { /** - * @param name - * @param arguments + * @param name String + * @param arguments List */ public DBListArgument(String name, List arguments) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBLiteralArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBLiteralArgument.java index b6d75425bb..f1c7d23e95 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBLiteralArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBLiteralArgument.java @@ -31,9 +31,9 @@ public class DBLiteralArgument extends BaseLiteralArgument { /** - * @param name - * @param type - * @param value + * @param name String + * @param type QName + * @param value Serializable */ public DBLiteralArgument(String name, QName type, Serializable value) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBOrdering.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBOrdering.java index 636f60de7f..4a0f0214a1 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBOrdering.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBOrdering.java @@ -49,8 +49,8 @@ public class DBOrdering extends BaseOrdering implements DBQueryBuilderComponent DBQueryBuilderComponent builderSupport; /** - * @param column - * @param order + * @param column Column + * @param order Order */ public DBOrdering(Column column, Order order) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBParameterArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBParameterArgument.java index 10430f0f42..7e06039021 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBParameterArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBParameterArgument.java @@ -28,8 +28,8 @@ public class DBParameterArgument extends BaseParameterArgument { /** - * @param name - * @param parameterName + * @param name String + * @param parameterName String */ public DBParameterArgument(String name, String parameterName) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBPropertyArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBPropertyArgument.java index 5e72d52927..3a7584d210 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBPropertyArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBPropertyArgument.java @@ -28,11 +28,11 @@ public class DBPropertyArgument extends BasePropertyArgument { /** - * @param name - * @param queryable - * @param orderable - * @param selector - * @param propertyName + * @param name String + * @param queryable boolean + * @param orderable boolean + * @param selector String + * @param propertyName String */ public DBPropertyArgument(String name, boolean queryable, boolean orderable, String selector, String propertyName) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQuery.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQuery.java index e7cbabf062..586cca5324 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQuery.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQuery.java @@ -68,10 +68,10 @@ public class DBQuery extends BaseQuery implements DBQueryBuilderComponent Set selectorGroup; /** - * @param columns - * @param source - * @param constraint - * @param orderings + * @param columns List + * @param source Source + * @param constraint Constraint + * @param orderings List */ public DBQuery(List columns, Source source, Constraint constraint, List orderings) { @@ -715,8 +715,8 @@ public class DBQuery extends BaseQuery implements DBQueryBuilderComponent } /** - * @param propertyQName - * @return + * @param propertyQName QName + * @return DBQueryBuilderJoinCommandType */ public static DBQueryBuilderJoinCommandType getJoinCommandType(QName propertyQName) { @@ -740,9 +740,9 @@ public class DBQuery extends BaseQuery implements DBQueryBuilderComponent } /** - * @param dictionaryService - * @param propertyQName - * @return + * @param dictionaryService DictionaryService + * @param propertyQName QName + * @return String */ public static String getFieldName(DictionaryService dictionaryService, QName propertyQName) { @@ -840,9 +840,10 @@ public class DBQuery extends BaseQuery implements DBQueryBuilderComponent } /** - * @param stringValues - * @param nodeDAO - * @return + * @param stringValues String[] + * @param nodeDAO NodeDAO + * @param tenantService TenantService + * @return Long[] */ public static Long[] getDbids(String[] stringValues, NodeDAO nodeDAO, TenantService tenantService) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderComponent.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderComponent.java index 6b48bd5801..438324214a 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderComponent.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderComponent.java @@ -42,14 +42,21 @@ public interface DBQueryBuilderComponent { /** * Is this component supported in a DB query? - * @return + * @return boolean */ public boolean isSupported(); /** * Use the dictionary to expand any terms, deal with multi-valued properties, etc * Use the QNameDAO to look up any ids - * @param functionArgs + * @param namespaceService NamespaceService + * @param dictionaryService DictionaryService + * @param qnameDAO QNameDAO + * @param nodeDAO NodeDAO + * @param tenantService TenantService + * @param selectors Set + * @param functionArgs Map + * @param functionContext FunctionEvaluationContext */ public void prepare(NamespaceService namespaceService, DictionaryService dictionaryService, QNameDAO qnameDAO, NodeDAO nodeDAO, TenantService tenantService, Set selectors, Map functionArgs, FunctionEvaluationContext functionContext); diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommandType.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommandType.java index 5ea61d2489..09a4f384c9 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommandType.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommandType.java @@ -178,7 +178,7 @@ public enum DBQueryBuilderPredicatePartCommandType /** - * @return + * @return DBQueryBuilderPredicatePartCommandType */ public DBQueryBuilderPredicatePartCommandType propertyNotFound() { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRow.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRow.java index f2cf295199..95cdae47c7 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRow.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRow.java @@ -32,8 +32,8 @@ public class DBResultSetRow extends AbstractResultSetRow { /** - * @param resultSet - * @param index + * @param resultSet ResultSet + * @param index int */ public DBResultSetRow(ResultSet resultSet, int index) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRowIterator.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRowIterator.java index 763279cd91..c773466496 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRowIterator.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBResultSetRowIterator.java @@ -30,7 +30,7 @@ public class DBResultSetRowIterator extends AbstractResultSetRowIterator { /** - * @param resultSet + * @param resultSet ResultSet */ public DBResultSetRowIterator(ResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelector.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelector.java index 8b13a83e75..0b85a008a3 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelector.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelector.java @@ -47,8 +47,8 @@ public class DBSelector extends BaseSelector implements DBQueryBuilderComponent DBQueryBuilderComponent builderSupport; /** - * @param type - * @param alias + * @param type QName + * @param alias String */ public DBSelector(QName type, String alias) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelectorArgument.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelectorArgument.java index 838f4efc46..25fb6b3b7c 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelectorArgument.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBSelectorArgument.java @@ -28,8 +28,8 @@ public class DBSelectorArgument extends BaseSelectorArgument { /** - * @param name - * @param selector + * @param name String + * @param selector String */ public DBSelectorArgument(String name, String selector) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/ParentSupport.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/ParentSupport.java index c9826803b0..7cf4296eaf 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/ParentSupport.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/ParentSupport.java @@ -132,7 +132,7 @@ public class ParentSupport implements DBQueryBuilderComponent } /** - * @param leftOuter + * @param leftOuter boolean */ public void setLeftOuter(boolean leftOuter) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/PropertySupport.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/PropertySupport.java index 608f4266ba..124b8c6c9b 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/PropertySupport.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/PropertySupport.java @@ -344,7 +344,7 @@ public class PropertySupport implements DBQueryBuilderComponent /** - * @param luceneFunction + * @param luceneFunction LuceneFunction */ public void setLuceneFunction(LuceneFunction luceneFunction) { @@ -352,7 +352,7 @@ public class PropertySupport implements DBQueryBuilderComponent } /** - * @param leftOuter + * @param leftOuter boolean */ public void setLeftOuter(boolean leftOuter) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/TypeSupport.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/TypeSupport.java index 6c8f55f71b..a8f409d928 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/TypeSupport.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/TypeSupport.java @@ -121,7 +121,7 @@ public class TypeSupport implements DBQueryBuilderComponent } /** - * @param leftOuter + * @param leftOuter boolean */ public void setLeftOuter(boolean leftOuter) { diff --git a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/UUIDSupport.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/UUIDSupport.java index 2ec07657fa..1a23e9f3a7 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/UUIDSupport.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/UUIDSupport.java @@ -134,7 +134,7 @@ public class UUIDSupport implements DBQueryBuilderComponent } /** - * @param leftOuter + * @param leftOuter boolean */ public void setLeftOuter(boolean leftOuter) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/DbCmisQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/solr/DbCmisQueryLanguage.java index 288f88d65f..25adf78c44 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/DbCmisQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/solr/DbCmisQueryLanguage.java @@ -64,7 +64,7 @@ public class DbCmisQueryLanguage extends AbstractLuceneQueryLanguage /** * Set the query engine * - * @param queryEngine + * @param queryEngine QueryEngine */ public void setQueryEngine(QueryEngine queryEngine) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/SolrBackupClient.java b/source/java/org/alfresco/repo/search/impl/solr/SolrBackupClient.java index f984566dbb..2ca30100bf 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/SolrBackupClient.java +++ b/source/java/org/alfresco/repo/search/impl/solr/SolrBackupClient.java @@ -136,7 +136,7 @@ public class SolrBackupClient implements InitializingBean } /** - * @param running + * @param running AtomicBoolean */ private void executeImpl(AtomicBoolean running) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java b/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java index b701dec997..64ecd59abd 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java +++ b/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java @@ -207,7 +207,7 @@ public class SolrQueryHTTPClient implements BeanFactoryAware * When set, a single DENIED ACL entry for any authority will result in * access being denied as a whole. See system property {@code security.anyDenyDenies} * - * @param anyDenyDenies + * @param anyDenyDenies boolean */ public void setAnyDenyDenies(boolean anyDenyDenies) { @@ -217,7 +217,7 @@ public class SolrQueryHTTPClient implements BeanFactoryAware /** * Executes a solr query for statistics * - * @param searchParameters + * @param searchParameters StatsParameters * @return SolrStatsResult */ public SolrStatsResult executeStatsQuery(final StatsParameters searchParameters) diff --git a/source/java/org/alfresco/repo/search/impl/solr/SolrQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/solr/SolrQueryLanguage.java index a48afe2cab..d7a8cd008b 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/SolrQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/solr/SolrQueryLanguage.java @@ -53,7 +53,7 @@ public class SolrQueryLanguage extends AbstractLuceneQueryLanguage /** * Executes a stats query using solr. - * @param searchParameters + * @param searchParameters StatsParameters * @return StatsResultSet */ public StatsResultSet executeStatsQuery(StatsParameters searchParameters) diff --git a/source/java/org/alfresco/repo/search/impl/solr/SolrSearchService.java b/source/java/org/alfresco/repo/search/impl/solr/SolrSearchService.java index c9dbf73756..4e86ce6308 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/SolrSearchService.java +++ b/source/java/org/alfresco/repo/search/impl/solr/SolrSearchService.java @@ -182,8 +182,8 @@ public class SolrSearchService implements SearchService /** * The definitions must provide a default value, or of not there must be a parameter to provide the value * - * @param definition - * @param queryParameters + * @param definition CannedQueryDef + * @param queryParameters QueryParameter[] * @throws QueryParameterisationException */ private void checkParameters(CannedQueryDef definition, QueryParameter[] queryParameters) throws QueryParameterisationException diff --git a/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetHelper.java b/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetHelper.java index ee02462781..ccbac410b8 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetHelper.java +++ b/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetHelper.java @@ -51,7 +51,7 @@ public class SolrFacetHelper /** * Constructor * - * @param facetQueryProviders + * @param facetQueryProviders List */ public SolrFacetHelper(List facetQueryProviders) { @@ -93,7 +93,7 @@ public class SolrFacetHelper /** * Whether the specified field is defined as a facet.query or not * - * @param facetField + * @param facetField String * @return true if the facet is facet.query, false otherwise */ public boolean hasFacetQueries(String facetField) diff --git a/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetServiceImpl.java b/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetServiceImpl.java index c14da7b7a7..83faa78b4e 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetServiceImpl.java +++ b/source/java/org/alfresco/repo/search/impl/solr/facet/SolrFacetServiceImpl.java @@ -792,7 +792,7 @@ public class SolrFacetServiceImpl extends AbstractLifecycleBean /** * Gets a map containing the facet's custom properties * - * @return Map map containing the custom properties of the facet + * @return map containing the custom properties of the facet */ private Map getFacetCustomProperties(Map properties) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/facet/handler/FacetLabel.java b/source/java/org/alfresco/repo/search/impl/solr/facet/handler/FacetLabel.java index 06b2bdf29b..b815f9fd8a 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/facet/handler/FacetLabel.java +++ b/source/java/org/alfresco/repo/search/impl/solr/facet/handler/FacetLabel.java @@ -32,9 +32,9 @@ public class FacetLabel private final int labelIndex; /** - * @param value - * @param label - * @param labelIndex + * @param value String + * @param label String + * @param labelIndex int */ public FacetLabel(String value, String label, int labelIndex) { diff --git a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSet.java b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSet.java index f7f5351de8..495b1d3b61 100644 --- a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSet.java +++ b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSet.java @@ -52,8 +52,8 @@ public class ChildAssocRefResultSet extends AbstractResultSet /** * Normal constructor - * @param nodeService - * @param cars + * @param nodeService NodeService + * @param cars List */ public ChildAssocRefResultSet(NodeService nodeService, List cars) { @@ -64,9 +64,9 @@ public class ChildAssocRefResultSet extends AbstractResultSet /** * Constructor that may expand all child assoc parents provided - * @param nodeService - * @param nodeRefs - * @param resolveAllParents + * @param nodeService NodeService + * @param nodeRefs List nodeRefs + * @param resolveAllParents boolean */ public ChildAssocRefResultSet(NodeService nodeService, List nodeRefs, boolean resolveAllParents) { diff --git a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRow.java b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRow.java index 520d4d88d4..3a16c4799e 100644 --- a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRow.java +++ b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRow.java @@ -35,8 +35,8 @@ public class ChildAssocRefResultSetRow extends AbstractResultSetRow { /** * Row in child assoc ref result set - * @param resultSet - * @param index + * @param resultSet ChildAssocRefResultSet + * @param index int */ public ChildAssocRefResultSetRow(ChildAssocRefResultSet resultSet, int index) { diff --git a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRowIterator.java b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRowIterator.java index 417f4ea677..01aaaa508f 100644 --- a/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRowIterator.java +++ b/source/java/org/alfresco/repo/search/results/ChildAssocRefResultSetRowIterator.java @@ -32,7 +32,7 @@ public class ChildAssocRefResultSetRowIterator extends AbstractResultSetRowItera /** * Source result set - * @param resultSet + * @param resultSet ResultSet */ public ChildAssocRefResultSetRowIterator(ResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/search/results/DetachedResultSet.java b/source/java/org/alfresco/repo/search/results/DetachedResultSet.java index 681eddd096..545173bc7f 100644 --- a/source/java/org/alfresco/repo/search/results/DetachedResultSet.java +++ b/source/java/org/alfresco/repo/search/results/DetachedResultSet.java @@ -46,7 +46,7 @@ public class DetachedResultSet extends AbstractResultSet /** * Detached result set based on that provided - * @param resultSet + * @param resultSet ResultSet */ public DetachedResultSet(ResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/search/results/DetachedResultSetRow.java b/source/java/org/alfresco/repo/search/results/DetachedResultSetRow.java index a6ee38d3d9..d3307bb9e7 100644 --- a/source/java/org/alfresco/repo/search/results/DetachedResultSetRow.java +++ b/source/java/org/alfresco/repo/search/results/DetachedResultSetRow.java @@ -38,8 +38,8 @@ public class DetachedResultSetRow extends AbstractResultSetRow /** * Detached result set row - * @param resultSet - * @param row + * @param resultSet ResultSet + * @param row ResultSetRow */ public DetachedResultSetRow(ResultSet resultSet, ResultSetRow row) { diff --git a/source/java/org/alfresco/repo/search/results/ResultSetSPIWrapper.java b/source/java/org/alfresco/repo/search/results/ResultSetSPIWrapper.java index b17b2d3d44..7202864df5 100644 --- a/source/java/org/alfresco/repo/search/results/ResultSetSPIWrapper.java +++ b/source/java/org/alfresco/repo/search/results/ResultSetSPIWrapper.java @@ -45,7 +45,7 @@ public class ResultSetSPIWrapper */ public ResultSetSPIWrapper(ResultSetSPI wrapped) { @@ -115,7 +115,7 @@ public class ResultSetSPIWrapper + * @param namespacePrefixResolver NamespacePrefixResolver + * @param dictionaryService DictionaryService + * @param locale Locale */ public SortedResultSet(ResultSet resultSet, NodeService nodeService, List sortDefinitions, NamespacePrefixResolver namespacePrefixResolver, DictionaryService dictionaryService, Locale locale) @@ -885,7 +885,7 @@ public class SortedResultSet implements ResultSet /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ public boolean setBulkFetch(boolean bulkFetch) { @@ -905,7 +905,7 @@ public class SortedResultSet implements ResultSet /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ public int setBulkFetchSize(int bulkFetchSize) { diff --git a/source/java/org/alfresco/repo/search/results/SortedResultSetRow.java b/source/java/org/alfresco/repo/search/results/SortedResultSetRow.java index 6e09b69f6a..4dc04b3c0a 100644 --- a/source/java/org/alfresco/repo/search/results/SortedResultSetRow.java +++ b/source/java/org/alfresco/repo/search/results/SortedResultSetRow.java @@ -32,8 +32,8 @@ public class SortedResultSetRow extends AbstractResultSetRow implements ResultSe { /** - * @param resultSet - * @param index + * @param resultSet SortedResultSet + * @param index int */ public SortedResultSetRow(SortedResultSet resultSet, int index) { diff --git a/source/java/org/alfresco/repo/search/results/SortedResultSetRowIterator.java b/source/java/org/alfresco/repo/search/results/SortedResultSetRowIterator.java index ab3bbe4ea9..9df104916e 100644 --- a/source/java/org/alfresco/repo/search/results/SortedResultSetRowIterator.java +++ b/source/java/org/alfresco/repo/search/results/SortedResultSetRowIterator.java @@ -30,7 +30,7 @@ public class SortedResultSetRowIterator extends AbstractResultSetRowIterator { /** - * @param resultSet + * @param resultSet ResultSet */ public SortedResultSetRowIterator(ResultSet resultSet) { diff --git a/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java b/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java index ffd00a0543..4b4a988e14 100644 --- a/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java +++ b/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java @@ -84,7 +84,7 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC /** * Set if guest login is supported. * - * @param allowGuestLogin + * @param allowGuestLogin Boolean */ public void setAllowGuestLogin(Boolean allowGuestLogin) { @@ -183,8 +183,8 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC * authentication component as it will support guest login - prior to this direct over ride for authenticate(String , * char[]) was used. This will still work. * - * @param userName - * @param password + * @param userName String + * @param password char[] */ protected void authenticateImpl(String userName, char[] password) { @@ -292,8 +292,8 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC /** * Default implementation that makes an ACEGI object on the fly * - * @param userName - * @return + * @param userName String + * @return UserDetails */ protected UserDetails getUserDetails(String userName) { @@ -303,9 +303,6 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC return ud; } - /** - * {@inheritDoc} - */ public Authentication setCurrentAuthentication(Authentication authentication) { return this.authenticationContext.setCurrentAuthentication(authentication); @@ -593,7 +590,7 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC /** * Convenience method to allow the administrator user names to be specified as a comma separated list * - * @param defaultAdministratorUserNames + * @param defaultAdministratorUserNames String */ public void setDefaultAdministratorUserNameList(String defaultAdministratorUserNames) { @@ -605,32 +602,29 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC setDefaultAdministratorUserNames(nameSet); } - /** - * {@inheritDoc} - */ public Set getDefaultGuestUserNames() { return this.defaultGuestUserNames; } - /** - * Sets the user names who for this particular authentication system should be considered administrators by default. - * - * @param defaultGuestUserNames - * a set of user names - */ - public void setDefaultGuestUserNames(Set defaultGuestUserNames) + /** + * Sets the user names who for this particular authentication system should be considered administrators by default. + * + * @param defaultGuestUserNames + * a set of user names + */ + public void setDefaultGuestUserNames(Set defaultGuestUserNames) { this.defaultGuestUserNames = defaultGuestUserNames; } - /** - * Convenience method to allow the administrator user names to be specified as a comma separated list - * - * @param defaultGuestUserNames - */ - public void setDefaultGuestUserNameList(String defaultGuestUserNames) - { + /** + * Convenience method to allow the administrator user names to be specified as a comma separated list + * + * @param defaultGuestUserNames String + */ + public void setDefaultGuestUserNameList(String defaultGuestUserNames) + { Set nameSet = new TreeSet(); if (defaultGuestUserNames.length() > 0) { diff --git a/source/java/org/alfresco/repo/security/authentication/AbstractChainingAuthenticationComponent.java b/source/java/org/alfresco/repo/security/authentication/AbstractChainingAuthenticationComponent.java index 6cb1e19bc9..b306c5047d 100644 --- a/source/java/org/alfresco/repo/security/authentication/AbstractChainingAuthenticationComponent.java +++ b/source/java/org/alfresco/repo/security/authentication/AbstractChainingAuthenticationComponent.java @@ -45,7 +45,7 @@ public abstract class AbstractChainingAuthenticationComponent extends AbstractAu /** * Get the authentication component with the specified name - * @param name + * @param name String * @return the authentication component or null if it does not exist */ protected abstract AuthenticationComponent getAuthenticationComponent(String name); diff --git a/source/java/org/alfresco/repo/security/authentication/AbstractChainingFtpAuthenticator.java b/source/java/org/alfresco/repo/security/authentication/AbstractChainingFtpAuthenticator.java index 4378711a32..5937e004f7 100644 --- a/source/java/org/alfresco/repo/security/authentication/AbstractChainingFtpAuthenticator.java +++ b/source/java/org/alfresco/repo/security/authentication/AbstractChainingFtpAuthenticator.java @@ -27,7 +27,7 @@ import java.util.List; /** * Base chaining FTP Authenticator class. Where appropriate, methods will 'chain' across multiple - * {@link #FTPAuthenticatorBase} instances, as returned by {@link #getUsableFtpAuthenticators()}. + * {@link FTPAuthenticatorBase} instances, as returned by {@link #getUsableFtpAuthenticators()}. * * @author alex.mukha * @since 4.2.1 diff --git a/source/java/org/alfresco/repo/security/authentication/AlfrescoSSLSocketFactory.java b/source/java/org/alfresco/repo/security/authentication/AlfrescoSSLSocketFactory.java index 72d2bb590b..c31a21e4d3 100644 --- a/source/java/org/alfresco/repo/security/authentication/AlfrescoSSLSocketFactory.java +++ b/source/java/org/alfresco/repo/security/authentication/AlfrescoSSLSocketFactory.java @@ -51,7 +51,7 @@ public class AlfrescoSSLSocketFactory extends SSLSocketFactory /** * Initialize the factory with custom trustStore - * @param trustStore + * @param trustStore KeyStore */ public static synchronized void initTrustedSSLSocketFactory(final KeyStore trustStore) { diff --git a/source/java/org/alfresco/repo/security/authentication/AuthenticationComponentImpl.java b/source/java/org/alfresco/repo/security/authentication/AuthenticationComponentImpl.java index 4794905162..983723d7bf 100644 --- a/source/java/org/alfresco/repo/security/authentication/AuthenticationComponentImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/AuthenticationComponentImpl.java @@ -52,7 +52,7 @@ public class AuthenticationComponentImpl extends AbstractAuthenticationComponent /** * IOC * - * @param authenticationManager + * @param authenticationManager AuthenticationManager */ public void setAuthenticationManager(AuthenticationManager authenticationManager) { @@ -62,7 +62,7 @@ public class AuthenticationComponentImpl extends AbstractAuthenticationComponent /** * IOC * - * @param authenticationDao + * @param authenticationDao MutableAuthenticationDao */ public void setAuthenticationDao(MutableAuthenticationDao authenticationDao) { diff --git a/source/java/org/alfresco/repo/security/authentication/AuthenticationServiceImpl.java b/source/java/org/alfresco/repo/security/authentication/AuthenticationServiceImpl.java index 680bd4473c..e44d08e80f 100644 --- a/source/java/org/alfresco/repo/security/authentication/AuthenticationServiceImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/AuthenticationServiceImpl.java @@ -140,11 +140,11 @@ public class AuthenticationServiceImpl extends AbstractAuthenticationService imp } /** - * This method is called from the {@#validate(String)} method. If this method returns null then + * This method is called from the {@link #validate(String)} method. If this method returns null then * the user's tenant will be obtained from the username. This is generally correct in the case where the user can be * associated with just one tenant. * Override this method in order to force the selection of a different tenant (for whatever reason). - * @return + * @return String */ protected String getPrevalidationTenantDomain() { diff --git a/source/java/org/alfresco/repo/security/authentication/Authorization.java b/source/java/org/alfresco/repo/security/authentication/Authorization.java index e7513ec64e..1a3481231a 100644 --- a/source/java/org/alfresco/repo/security/authentication/Authorization.java +++ b/source/java/org/alfresco/repo/security/authentication/Authorization.java @@ -42,7 +42,7 @@ public class Authorization /** * Construct * - * @param authorization + * @param authorization String */ public Authorization(String authorization) { @@ -67,8 +67,8 @@ public class Authorization /** * Construct * - * @param username - * @param password + * @param username String + * @param password String */ public Authorization(String username, String password) { diff --git a/source/java/org/alfresco/repo/security/authentication/ChainingAuthenticationComponentImpl.java b/source/java/org/alfresco/repo/security/authentication/ChainingAuthenticationComponentImpl.java index 80e13ede62..cd863a2d5e 100644 --- a/source/java/org/alfresco/repo/security/authentication/ChainingAuthenticationComponentImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/ChainingAuthenticationComponentImpl.java @@ -65,7 +65,7 @@ public class ChainingAuthenticationComponentImpl extends AbstractChainingAuthent /** * Set a list of authentication components * - * @param authenticationComponents + * @param authenticationComponents List */ public void setAuthenticationComponents(List authenticationComponents) { @@ -75,7 +75,7 @@ public class ChainingAuthenticationComponentImpl extends AbstractChainingAuthent /** * Get the authentication service thta must be at the top of the list (this may be null) * - * @return + * @return AuthenticationComponent */ public AuthenticationComponent getMutableAuthenticationComponent() { @@ -85,7 +85,7 @@ public class ChainingAuthenticationComponentImpl extends AbstractChainingAuthent /** * Set the authentication component at the top of the list. * - * @param mutableAuthenticationComponent + * @param mutableAuthenticationComponent AuthenticationComponent */ public void setMutableAuthenticationComponent(AuthenticationComponent mutableAuthenticationComponent) { @@ -286,7 +286,7 @@ public class ChainingAuthenticationComponentImpl extends AbstractChainingAuthent /** * Helper to get authentication components * - * @return + * @return Collection */ protected Collection getUsableAuthenticationComponents() { diff --git a/source/java/org/alfresco/repo/security/authentication/MD4PasswordEncoder.java b/source/java/org/alfresco/repo/security/authentication/MD4PasswordEncoder.java index fe8ef5dcc9..1d99432764 100644 --- a/source/java/org/alfresco/repo/security/authentication/MD4PasswordEncoder.java +++ b/source/java/org/alfresco/repo/security/authentication/MD4PasswordEncoder.java @@ -25,8 +25,8 @@ public interface MD4PasswordEncoder extends PasswordEncoder /** * Get the MD4 byte array * - * @param encodedHash - * @return + * @param encodedHash String + * @return byte[] */ public byte[] decodeHash(String encodedHash); } \ No newline at end of file diff --git a/source/java/org/alfresco/repo/security/authentication/MessageDigestPasswordEncoder.java b/source/java/org/alfresco/repo/security/authentication/MessageDigestPasswordEncoder.java index 5db4b93c07..28a2ef89f0 100644 --- a/source/java/org/alfresco/repo/security/authentication/MessageDigestPasswordEncoder.java +++ b/source/java/org/alfresco/repo/security/authentication/MessageDigestPasswordEncoder.java @@ -65,7 +65,7 @@ public class MessageDigestPasswordEncoder extends BaseDigestPasswordEncoder * "http://java.sun.com/j2se/1.4.2/docs/guide/security/CryptoSpec.html#AppA" * > Message Digest Algorithms
    in the Java environment. * - * @param algorithm + * @param algorithm String */ public MessageDigestPasswordEncoder(String algorithm) { @@ -75,9 +75,9 @@ public class MessageDigestPasswordEncoder extends BaseDigestPasswordEncoder /** * Convenience constructor for specifying the algorithm and whether or not * to enable base64 encoding - * - * @param algorithm - * @param encodeHashAsBase64 + * + * @param algorithm String + * @param encodeHashAsBase64 boolean * @throws IllegalArgumentException * if an unknown */ diff --git a/source/java/org/alfresco/repo/security/authentication/NameBasedUserNameGenerator.java b/source/java/org/alfresco/repo/security/authentication/NameBasedUserNameGenerator.java index 9ed2269050..1252151285 100644 --- a/source/java/org/alfresco/repo/security/authentication/NameBasedUserNameGenerator.java +++ b/source/java/org/alfresco/repo/security/authentication/NameBasedUserNameGenerator.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.security.authentication; @@ -49,7 +49,7 @@ public class NameBasedUserNameGenerator implements UserNameGenerator * %emailAddress% email address * %i% lower case first name inital * - * @param userNamePattern + * @param userNamePattern String */ public void setNamePattern(String userNamePattern) { diff --git a/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java b/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java index 236925872e..7a1fb1e94d 100644 --- a/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java +++ b/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java @@ -794,12 +794,12 @@ public class RepositoryAuthenticationDao implements MutableAuthenticationDao, In } } - /** - * Remove from the cache and lock the value for the transaction - * @param key - */ - private void removeAuthenticationFromCache(String key) - { + /** + * Remove from the cache and lock the value for the transaction + * @param key String + */ + private void removeAuthenticationFromCache(String key) + { authenticationCache.remove(key); if (authenticationCache instanceof TransactionalCache) { diff --git a/source/java/org/alfresco/repo/security/authentication/ldap/LDAPAuthenticationComponentImpl.java b/source/java/org/alfresco/repo/security/authentication/ldap/LDAPAuthenticationComponentImpl.java index 76ecf3b665..ebe3817795 100644 --- a/source/java/org/alfresco/repo/security/authentication/ldap/LDAPAuthenticationComponentImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/ldap/LDAPAuthenticationComponentImpl.java @@ -203,7 +203,7 @@ public class LDAPAuthenticationComponentImpl extends AbstractAuthenticationCompo /** * Set the unique name of this ldap authentication component e.g. "managed,ldap1" * - * @param id + * @param id String */ public void setId(String id) { diff --git a/source/java/org/alfresco/repo/security/authentication/ldap/LDAPInitialDirContextFactory.java b/source/java/org/alfresco/repo/security/authentication/ldap/LDAPInitialDirContextFactory.java index ede04265c6..0fd4db9544 100644 --- a/source/java/org/alfresco/repo/security/authentication/ldap/LDAPInitialDirContextFactory.java +++ b/source/java/org/alfresco/repo/security/authentication/ldap/LDAPInitialDirContextFactory.java @@ -36,7 +36,7 @@ public interface LDAPInitialDirContextFactory /** * Set the LDAP environment Hashtable properties used ot initialise the LDAP connection. * - * @param environment + * @param environment Map */ public void setInitialDirContextEnvironment(Map environment); @@ -47,7 +47,7 @@ public interface LDAPInitialDirContextFactory * @param pageSize * if a positive value, indicates that a LDAP v3 RFC 2696 paged results control should be used. The * results of a search operation should be returned by the LDAP server in batches of the specified size. - * @param diagnostic + * @param diagnostic AuthenticationDiagnostic * @return the default intial dir context * @throws AuthenticationException * the authentication exception @@ -71,7 +71,7 @@ public interface LDAPInitialDirContextFactory * Use the environment properties and connect to the LDAP server. * Used to obtain read only access to the LDAP server. * - * @return + * @return InitialDirContext * @throws AuthenticationException */ public InitialDirContext getDefaultIntialDirContext() throws AuthenticationException; @@ -80,7 +80,7 @@ public interface LDAPInitialDirContextFactory * Use the environment properties and connect to the LDAP server. * Used to obtain read only access to the LDAP server. * - * @return + * @return InitialDirContext * @throws AuthenticationException */ public InitialDirContext getDefaultIntialDirContext(AuthenticationDiagnostic diagnostic) throws AuthenticationException; @@ -102,9 +102,9 @@ public interface LDAPInitialDirContextFactory * Augment the connection environment with the identity and credentials and bind to the ldap server. * Mainly used to validate a user's credentials during authentication. * - * @param principal - * @param credentials - * @return + * @param principal String + * @param credentials String + * @return InitialDirContext * @throws AuthenticationException */ public InitialDirContext getInitialDirContext(String principal, String credentials) throws AuthenticationException; @@ -113,10 +113,10 @@ public interface LDAPInitialDirContextFactory * Augment the connection environment with the identity and credentials and bind to the ldap server. * Mainly used to validate a user's credentials during authentication. * - * @param principal - * @param credentials - * @param diagnostic - * @return + * @param principal String + * @param credentials String + * @param diagnostic AuthenticationDiagnostic + * @return InitialDirContext * @throws AuthenticationException */ public InitialDirContext getInitialDirContext(String principal, String credentials, AuthenticationDiagnostic diagnostic) throws AuthenticationException; diff --git a/source/java/org/alfresco/repo/security/authentication/ldap/Monitor.java b/source/java/org/alfresco/repo/security/authentication/ldap/Monitor.java index da4847df51..915ac85082 100644 --- a/source/java/org/alfresco/repo/security/authentication/ldap/Monitor.java +++ b/source/java/org/alfresco/repo/security/authentication/ldap/Monitor.java @@ -64,8 +64,8 @@ public class Monitor /** * test authenticate * - * @param userName - * @param credentials + * @param userName String + * @param credentials String * @throws AuthenticationException */ public CompositeData testAuthenticate(String userName, String credentials) diff --git a/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java b/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java index 6401e7f6d9..6e79211965 100644 --- a/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java +++ b/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java @@ -58,7 +58,7 @@ public class NTLMPassthruToken extends NTLMLocalToken /** * Class constructor * - * @params domain String + * @param domain String */ public NTLMPassthruToken( String domain) { @@ -152,13 +152,13 @@ public class NTLMPassthruToken extends NTLMLocalToken } /** - * Set the authentication expire time, this indicates that an authentication session is associated with this - * token and the session will be closed if the authentication is not completed by this time. - * - * @param expireTime long - */ - protected final void setAuthenticationExpireTime(long expireTime) - { + * Set the authentication expire time, this indicates that an authentication session is associated with this + * token and the session will be closed if the authentication is not completed by this time. + * + * @param expireTime long + */ + protected final void setAuthenticationExpireTime(long expireTime) + { m_authExpiresAt = expireTime; } diff --git a/source/java/org/alfresco/repo/security/authentication/subsystems/SubsystemChainingFtpAuthenticator.java b/source/java/org/alfresco/repo/security/authentication/subsystems/SubsystemChainingFtpAuthenticator.java index 8d2be3c903..06920feb15 100644 --- a/source/java/org/alfresco/repo/security/authentication/subsystems/SubsystemChainingFtpAuthenticator.java +++ b/source/java/org/alfresco/repo/security/authentication/subsystems/SubsystemChainingFtpAuthenticator.java @@ -29,7 +29,7 @@ import java.util.LinkedList; import java.util.List; /** - * This class wires up all the active {@link #FTPAuthenticatorBase} beans in a chain. + * This class wires up all the active {@link org.alfresco.filesys.auth.ftp.FTPAuthenticatorBase} beans in a chain. * * @author alex.mukha * @since 4.2.1 diff --git a/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java b/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java index dc5422b770..6f73d68993 100644 --- a/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java +++ b/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java @@ -158,21 +158,21 @@ public abstract class AbstractAuthorityBridgeDAO implements AuthorityBridgeDAO } /** - * @param authorityContainerTypeQNameId - * @param memberAssocQNameId - * @param authorityNameQNameId - * @param storeId - * @return - */ - protected abstract List selectDirectAuthoritiesForUser(Long authorityContainerTypeQNameId, Long memberAssocQNameId, Long authorityNameQNameId, Long storeId, + * @param authorityContainerTypeQNameId Long + * @param memberAssocQNameId Long + * @param authorityNameQNameId Long + * @param storeId Long + * @return List + */ + protected abstract List selectDirectAuthoritiesForUser(Long authorityContainerTypeQNameId, Long memberAssocQNameId, Long authorityNameQNameId, Long storeId, Long nodeId); /** - * @param authorityContainerTypeQNameId - * @param memberAssocQNameId - * @param authorityNameQNameId - * @param storeId - * @return + * @param authorityContainerTypeQNameId Long + * @param memberAssocQNameId Long + * @param authorityNameQNameId Long + * @param storeId Long + * @return List */ protected abstract List selectAuthorityBridgeLinks(Long authorityContainerTypeQNameId, Long memberAssocQNameId, Long authorityNameQNameId, Long storeId); diff --git a/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java b/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java index d74a1e7890..288bc00703 100644 --- a/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java +++ b/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java @@ -198,7 +198,7 @@ public class AuthorityServiceImpl implements AuthorityService, InitializingBean /** * Checks if the {@code authority} (normally a username) is the same as or is contained * within the {@code parentAuthority}. - * @param authority + * @param authority String * @param parentAuthority a normalized, case sensitive authority name * @return {@code true} if does, {@code false} otherwise. */ @@ -734,12 +734,12 @@ public class AuthorityServiceImpl implements AuthorityService, InitializingBean private Set positiveHits; private Set negativeHits; private boolean allAuthoritiesLoaded; - - /** - * @param username - */ - public UserAuthoritySet(String username) - { + + /** + * @param username String + */ + public UserAuthoritySet(String username) + { this.username = username; positiveHits = new TreeSet(); negativeHits = new TreeSet(); diff --git a/source/java/org/alfresco/repo/security/authority/script/ScriptAuthorityService.java b/source/java/org/alfresco/repo/security/authority/script/ScriptAuthorityService.java index 31e3165e2d..83960b349f 100644 --- a/source/java/org/alfresco/repo/security/authority/script/ScriptAuthorityService.java +++ b/source/java/org/alfresco/repo/security/authority/script/ScriptAuthorityService.java @@ -334,7 +334,7 @@ public class ScriptAuthorityService extends BaseScopableProcessorExtension /** * Get a group given its short name - * @param shortName, the shortName of the group + * @param shortName the shortName of the group * @return the authority or null if it can't be found */ public ScriptGroup getGroup(String shortName) @@ -352,7 +352,7 @@ public class ScriptAuthorityService extends BaseScopableProcessorExtension /** * Get a group given it full authority name (Which must begin with 'GROUP_' - * @param fullAuthorityName, the shortName of the group + * @param fullAuthorityName the shortName of the group * @return the authority or null if it can't be found */ public ScriptGroup getGroupForFullAuthorityName(String fullAuthorityName) @@ -462,7 +462,7 @@ public class ScriptAuthorityService extends BaseScopableProcessorExtension /** * Get a user given their username - * @param username, the username of the user + * @param username the username of the user * @return the user or null if they can't be found */ public ScriptUser getUser(String username) @@ -555,7 +555,7 @@ public class ScriptAuthorityService extends BaseScopableProcessorExtension *

    * "C-3PO" becomes null. * - * @param nameFilter + * @param nameFilter String * @return A Pair if the String is valid, else null. */ private Pair tokeniseName(String nameFilter) diff --git a/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java b/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java index 279880d6f4..a9954d979e 100644 --- a/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java +++ b/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java @@ -63,8 +63,10 @@ public class ScriptGroup implements Authority, Serializable /** * New script group - * @param fullName - * @param serviceRegistry + * @param fullName String + * @param displayName String + * @param serviceRegistry ServiceRegistry + * @param scope Scriptable */ public ScriptGroup(String fullName, String displayName, ServiceRegistry serviceRegistry, Scriptable scope) { @@ -73,8 +75,9 @@ public class ScriptGroup implements Authority, Serializable /** * New script group - * @param fullName - * @param serviceRegistry + * @param fullName String + * @param serviceRegistry ServiceRegistry + * @param scope Scriptable */ public ScriptGroup(String fullName, ServiceRegistry serviceRegistry, Scriptable scope) { @@ -83,9 +86,9 @@ public class ScriptGroup implements Authority, Serializable /** * New script group - * @param fullName - * @param authorityService - * @deprecated Use {@link #ScriptGroup(String, ServiceRegistry)} instead + * @param fullName String + * @param authorityService AuthorityService + * @deprecated Use {@link #ScriptGroup(String, ServiceRegistry, Scriptable)} instead */ public ScriptGroup(String fullName, AuthorityService authorityService) { @@ -94,9 +97,11 @@ public class ScriptGroup implements Authority, Serializable /** * New script group - * @param fullName - * @param displayName - * @param authorityService + * @param fullName String + * @param displayName String + * @param serviceRegistry ServiceRegistry + * @param authorityService AuthorityService + * @param scope Scriptable */ private ScriptGroup(String fullName, String displayName, ServiceRegistry serviceRegistry, AuthorityService authorityService, Scriptable scope) { @@ -155,7 +160,7 @@ public class ScriptGroup implements Authority, Serializable /** * Change the display name for this group. Need administrator permission to call this method to change a display name. - * @param displayName + * @param displayName String */ public void setDisplayName(String displayName) { @@ -178,7 +183,7 @@ public class ScriptGroup implements Authority, Serializable /** * Get all users contained in this group - * @return + * @return ScriptUser[] */ public ScriptUser[] getAllUsers() { @@ -635,8 +640,8 @@ public class ScriptGroup implements Authority, Serializable * @param paging Object representing the paging details * @param sortBy field for sorting * @param sortAsc sort ascending or not - * @param serviceRegistry - * @param scope + * @param serviceRegistry ServiceRegistry + * @param scope Scriptable * @return Array of ScriptGroup objects * * @since 4.1.4 @@ -668,8 +673,8 @@ public class ScriptGroup implements Authority, Serializable * * @param pagedGroups sorted paged results (the page of results get sorted again taking I18n into account) * @param paging Object representing the paging details - * @param serviceRegistry - * @param scope + * @param serviceRegistry ServiceRegistry + * @param scope Scriptable * @return Array of ScriptGroup objects * * @since 4.1.4 diff --git a/source/java/org/alfresco/repo/security/permissions/ACEType.java b/source/java/org/alfresco/repo/security/permissions/ACEType.java index 3bec805880..5f749e2616 100644 --- a/source/java/org/alfresco/repo/security/permissions/ACEType.java +++ b/source/java/org/alfresco/repo/security/permissions/ACEType.java @@ -58,15 +58,15 @@ public enum ACEType /** * Get the id for the ACEType stored in the DB. - * @return + * @return int */ public abstract int getId(); /** * Get the ACEType from the value stored in the DB. - * @param id - * @return + * @param id int + * @return ACEType */ public static ACEType getACETypeFromId(int id) { diff --git a/source/java/org/alfresco/repo/security/permissions/ACLType.java b/source/java/org/alfresco/repo/security/permissions/ACLType.java index 8708445b4f..7b4db1ab8a 100644 --- a/source/java/org/alfresco/repo/security/permissions/ACLType.java +++ b/source/java/org/alfresco/repo/security/permissions/ACLType.java @@ -97,14 +97,14 @@ public enum ACLType /** * Get the id for the ACLType stored in the DB * - * @return + * @return int */ public abstract int getId(); /** * Get the ACLType from the value stored in the DB - * @param id - * @return + * @param id int + * @return ACLType */ public static ACLType getACLTypeFromId(int id) { diff --git a/source/java/org/alfresco/repo/security/permissions/AccessControlEntryContext.java b/source/java/org/alfresco/repo/security/permissions/AccessControlEntryContext.java index e426c50a94..c5e6e9abe5 100644 --- a/source/java/org/alfresco/repo/security/permissions/AccessControlEntryContext.java +++ b/source/java/org/alfresco/repo/security/permissions/AccessControlEntryContext.java @@ -38,7 +38,7 @@ public interface AccessControlEntryContext extends Serializable * * Supports () for grouping * - * @return + * @return String */ public String getClassContext(); @@ -47,7 +47,7 @@ public interface AccessControlEntryContext extends Serializable * * QName QName Qname => property types to which it applies * - * @return + * @return String */ public String getPropertyContext(); @@ -56,6 +56,6 @@ public interface AccessControlEntryContext extends Serializable * * Serialized Map * - * @return + * @return String */ public String getKVPContext();} diff --git a/source/java/org/alfresco/repo/security/permissions/AccessControlList.java b/source/java/org/alfresco/repo/security/permissions/AccessControlList.java index a58e6ec869..a9d5de8c15 100644 --- a/source/java/org/alfresco/repo/security/permissions/AccessControlList.java +++ b/source/java/org/alfresco/repo/security/permissions/AccessControlList.java @@ -27,7 +27,7 @@ public interface AccessControlList extends Serializable { /** * Get the properties - * @return + * @return AccessControlListProperties */ public AccessControlListProperties getProperties(); @@ -41,7 +41,7 @@ public interface AccessControlList extends Serializable * * To make permission evaluation faster for the common cases * - * @return + * @return List */ public List getEntries(); diff --git a/source/java/org/alfresco/repo/security/permissions/DynamicAuthority.java b/source/java/org/alfresco/repo/security/permissions/DynamicAuthority.java index a0848f65d5..0cf70cd946 100644 --- a/source/java/org/alfresco/repo/security/permissions/DynamicAuthority.java +++ b/source/java/org/alfresco/repo/security/permissions/DynamicAuthority.java @@ -34,8 +34,8 @@ public interface DynamicAuthority /** * Is this authority granted to the given user for this node ref? * - * @param nodeRef - * @param userName + * @param nodeRef NodeRef + * @param userName String * @return true if the current user has the authority */ public boolean hasAuthority(NodeRef nodeRef, String userName); diff --git a/source/java/org/alfresco/repo/security/permissions/NodePermissionEntry.java b/source/java/org/alfresco/repo/security/permissions/NodePermissionEntry.java index 1c4d60978c..396e8cd664 100644 --- a/source/java/org/alfresco/repo/security/permissions/NodePermissionEntry.java +++ b/source/java/org/alfresco/repo/security/permissions/NodePermissionEntry.java @@ -34,14 +34,14 @@ public interface NodePermissionEntry /** * Get the node ref. * - * @return + * @return NodeRef */ public NodeRef getNodeRef(); /** * Does the node inherit permissions from its primary parent? * - * @return + * @return boolean */ public boolean inheritPermissions(); @@ -49,7 +49,7 @@ public interface NodePermissionEntry /** * Get the permission entries set for this node. * - * @return + * @return List */ public List getPermissionEntries(); } diff --git a/source/java/org/alfresco/repo/security/permissions/PermissionCheckedCollection.java b/source/java/org/alfresco/repo/security/permissions/PermissionCheckedCollection.java index 834f811b44..3fec5eab76 100644 --- a/source/java/org/alfresco/repo/security/permissions/PermissionCheckedCollection.java +++ b/source/java/org/alfresco/repo/security/permissions/PermissionCheckedCollection.java @@ -36,8 +36,7 @@ public interface PermissionCheckedCollection { /** * Check if the results have been truncated by permission check limits. - * This can only be called when {@link #isFiltered()} is true. - * + * * @return true - if the results (usually a collection) have been * cut off by permission check limits */ diff --git a/source/java/org/alfresco/repo/security/permissions/PermissionEntry.java b/source/java/org/alfresco/repo/security/permissions/PermissionEntry.java index 8baaf89cb6..51fa99d7c7 100644 --- a/source/java/org/alfresco/repo/security/permissions/PermissionEntry.java +++ b/source/java/org/alfresco/repo/security/permissions/PermissionEntry.java @@ -33,7 +33,7 @@ public interface PermissionEntry * * This may be null. Null implies that the settings apply to all permissions * - * @return + * @return PermissionReference */ public PermissionReference getPermissionReference(); @@ -44,7 +44,7 @@ public interface PermissionEntry * * If null then this applies to all. * - * @return + * @return String */ public String getAuthority(); @@ -53,7 +53,7 @@ public interface PermissionEntry * * This can only be null for a global permission * - * @return + * @return NodeRef */ public NodeRef getNodeRef(); @@ -72,19 +72,19 @@ public interface PermissionEntry /** * Get the Access enum value * - * @return + * @return AccessStatus */ public AccessStatus getAccessStatus(); /** * Is this permission inherited? - * @return + * @return boolean */ public boolean isInherited(); /** * Return the position in the inhertance chain (0 is not inherited and set on the object) - * @return + * @return int */ public int getPosition(); } diff --git a/source/java/org/alfresco/repo/security/permissions/PermissionServiceSPI.java b/source/java/org/alfresco/repo/security/permissions/PermissionServiceSPI.java index 8741492966..ef299b2c36 100644 --- a/source/java/org/alfresco/repo/security/permissions/PermissionServiceSPI.java +++ b/source/java/org/alfresco/repo/security/permissions/PermissionServiceSPI.java @@ -45,7 +45,7 @@ public interface PermissionServiceSPI extends PermissionService /** * Get the permissions that can be set for a given type * - * @param type + * @param type QName * @return the set of permissions */ public Set getSettablePermissionReferences(QName type); @@ -53,7 +53,7 @@ public interface PermissionServiceSPI extends PermissionService /** * Get the permissions that can be set for a given type * - * @param nodeRef + * @param nodeRef NodeRef * @return the set of permissions */ public Set getSettablePermissionReferences(NodeRef nodeRef); @@ -62,7 +62,7 @@ public interface PermissionServiceSPI extends PermissionService * Get the permissions that have been set on the given node (it knows * nothing of the parent permissions) * - * @param nodeRef + * @param nodeRef NodeRef * @return the node permission entry */ public NodePermissionEntry getSetPermissions(NodeRef nodeRef); @@ -71,8 +71,8 @@ public interface PermissionServiceSPI extends PermissionService * Check that the given authentication has a particular permission for the * given node. (The default behaviour is to inherit permissions) * - * @param nodeRef - * @param perm + * @param nodeRef NodeRef + * @param perm PermissionReference * @return the access status */ public AccessStatus hasPermission(NodeRef nodeRef, PermissionReference perm); @@ -81,35 +81,35 @@ public interface PermissionServiceSPI extends PermissionService * Where is the permission set that controls the behaviour for the given * permission for the given authentication to access the specified name. * - * @param nodeRef - * @param perm + * @param nodeRef NodeRef + * @param perm PermissionReference * @return the node permission entry */ public NodePermissionEntry explainPermission(NodeRef nodeRef, PermissionReference perm); /** * Delete the permissions defined by the nodePermissionEntry - * @param nodePermissionEntry + * @param nodePermissionEntry NodePermissionEntry */ public void deletePermissions(NodePermissionEntry nodePermissionEntry); /** * Delete a single permission entry - * @param permissionEntry + * @param permissionEntry PermissionEntry */ public void deletePermission(PermissionEntry permissionEntry); /** * Add or set a permission entry on a node. - * - * @param permissionEntry + * + * @param permissionEntry PermissionEntry */ public void setPermission(PermissionEntry permissionEntry); /** * Set the permissions on a node. * - * @param nodePermissionEntry + * @param nodePermissionEntry NodePermissionEntry */ public void setPermission(NodePermissionEntry nodePermissionEntry); @@ -117,7 +117,7 @@ public interface PermissionServiceSPI extends PermissionService * Get the permission reference for the given data type and permission name. * * @param qname - may be null if the permission name is unique - * @param permissionName + * @param permissionName String * @return the permission reference */ public PermissionReference getPermissionReference(QName qname, String permissionName); @@ -125,7 +125,7 @@ public interface PermissionServiceSPI extends PermissionService /** * Get the permission reference by permission name. * - * @param permissionName + * @param permissionName String * @return the permission reference */ public PermissionReference getPermissionReference(String permissionName); @@ -134,20 +134,20 @@ public interface PermissionServiceSPI extends PermissionService /** * Get the string that can be used to identify the given permission reference. * - * @param permissionReference + * @param permissionReference PermissionReference * @return the permission short name */ public String getPermission(PermissionReference permissionReference); /** * Delete permissions for the given recipient. - * @param recipient + * @param recipient String */ public void deletePermissions(String recipient); /** * Get the permissions set for the store - * @param storeRef + * @param storeRef StoreRef * @return - the node permission entry */ public NodePermissionEntry getSetPermissions(StoreRef storeRef); diff --git a/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlEntry.java b/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlEntry.java index c01c86f885..9714460be9 100644 --- a/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlEntry.java +++ b/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlEntry.java @@ -85,7 +85,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the status - * @param accessStatus + * @param accessStatus AccessStatus */ public void setAccessStatus(AccessStatus accessStatus) { @@ -95,7 +95,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the type - * @param aceType + * @param aceType ACEType */ public void setAceType(ACEType aceType) { @@ -104,7 +104,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the authority - * @param authority + * @param authority String */ public void setAuthority(String authority) { @@ -114,7 +114,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the context - * @param context + * @param context AccessControlEntryContext */ public void setContext(AccessControlEntryContext context) { @@ -123,7 +123,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the permission - * @param permission + * @param permission PermissionReference */ public void setPermission(PermissionReference permission) { @@ -132,7 +132,7 @@ public class SimpleAccessControlEntry implements AccessControlEntry /** * Set the position - * @param position + * @param position Integer */ public void setPosition(Integer position) { diff --git a/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlListProperties.java b/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlListProperties.java index 87eee436d1..f9e622adc6 100644 --- a/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlListProperties.java +++ b/source/java/org/alfresco/repo/security/permissions/SimpleAccessControlListProperties.java @@ -92,7 +92,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set the acl id * - * @param aclId + * @param aclId String */ public void setAclId(String aclId) { @@ -102,7 +102,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set the acl type * - * @param aclType + * @param aclType ACLType */ public void setAclType(ACLType aclType) { @@ -112,7 +112,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set the acl version * - * @param aclVersion + * @param aclVersion Long */ public void setAclVersion(Long aclVersion) { @@ -122,7 +122,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set inheritance * - * @param inherits + * @param inherits boolean */ public void setInherits(boolean inherits) { @@ -132,7 +132,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set latest * - * @param latest + * @param latest boolean */ public void setLatest(boolean latest) { @@ -142,7 +142,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set versioned * - * @param versioned + * @param versioned boolean */ public void setVersioned(boolean versioned) { @@ -157,7 +157,7 @@ public class SimpleAccessControlListProperties implements AccessControlListPrope /** * Set the id * - * @param id + * @param id Long */ public void setId(Long id) { diff --git a/source/java/org/alfresco/repo/security/permissions/dynamic/OwnerDynamicAuthority.java b/source/java/org/alfresco/repo/security/permissions/dynamic/OwnerDynamicAuthority.java index 032483a449..37c43a0484 100644 --- a/source/java/org/alfresco/repo/security/permissions/dynamic/OwnerDynamicAuthority.java +++ b/source/java/org/alfresco/repo/security/permissions/dynamic/OwnerDynamicAuthority.java @@ -49,7 +49,7 @@ public class OwnerDynamicAuthority implements DynamicAuthority, InitializingBean /** * Set the ownable service - * @param ownableService + * @param ownableService OwnableService */ public void setOwnableService(OwnableService ownableService) { diff --git a/source/java/org/alfresco/repo/security/permissions/impl/ModelDAO.java b/source/java/org/alfresco/repo/security/permissions/impl/ModelDAO.java index c099edfbb5..440bb71e70 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/ModelDAO.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/ModelDAO.java @@ -37,7 +37,7 @@ public interface ModelDAO * Get the permissions that can be set for the given type. * * @param type - the type in the data dictionary. - * @return + * @return Set */ public Set getAllPermissions(QName type); @@ -45,8 +45,8 @@ public interface ModelDAO * Get the permissions that can be set for the given type. * * @param type - the type in the data dictionary. - * @param aspects - * @return + * @param aspects Set + * @return Set */ public Set getAllPermissions(QName type, Set aspects); @@ -54,8 +54,8 @@ public interface ModelDAO * Get the permissions that can be set for the given node. * This is determined by the node type. * - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return Set */ public Set getAllPermissions(NodeRef nodeRef); @@ -63,7 +63,7 @@ public interface ModelDAO *Get the permissions that are exposed to be set for the given type. * * @param type - the type in the data dictionary. - * @return + * @return Set */ public Set getExposedPermissions(QName type); @@ -71,27 +71,27 @@ public interface ModelDAO * Get the permissions that are exposed to be set for the given node. * This is determined by the node type. * - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return Set */ public Set getExposedPermissions(NodeRef nodeRef); /** * Get all the permissions that grant this permission. * - * @param perm - * @return + * @param perm PermissionReference + * @return Set */ public Set getGrantingPermissions(PermissionReference perm); /** * Get the permissions that must also be present on the node for the required permission to apply. * - * @param required - * @param qName - * @param aspectQNames - * @param on - * @return + * @param required PermissionReference + * @param qName QName + * @param aspectQNames Set + * @param on RequiredPermission.On + * @return Set */ public Set getRequiredPermissions(PermissionReference required, QName qName, Set aspectQNames, RequiredPermission.On on); @@ -100,32 +100,32 @@ public interface ModelDAO /** * Get the permissions which are granted by the supplied permission. * - * @param permissionReference - * @return + * @param permissionReference PermissionReference + * @return Set */ public Set getGranteePermissions(PermissionReference permissionReference); /** * Get the permissions which are granted by the supplied permission. * - * @param permissionReference - * @return + * @param permissionReference PermissionReference + * @return Set */ public Set getImmediateGranteePermissions(PermissionReference permissionReference); /** * Is this permission refernece to a permission and not a permissoinSet? * - * @param required - * @return + * @param required PermissionReference + * @return boolean */ public boolean checkPermission(PermissionReference required); /** * Does the permission reference have a unique name? * - * @param permissionReference - * @return + * @param permissionReference PermissionReference + * @return boolean */ public boolean isUnique(PermissionReference permissionReference); @@ -133,9 +133,9 @@ public interface ModelDAO * Find a permission by name in the type context. * If the context is null and the permission name is unique it will be found. * - * @param qname - * @param permissionName - * @return + * @param qname QName + * @param permissionName String + * @return PermissionReference */ public PermissionReference getPermissionReference(QName qname, String permissionName); @@ -143,27 +143,27 @@ public interface ModelDAO * Get the global permissions for the model. * Permissions that apply to all nodes and take precedence over node specific permissions. * - * @return + * @return Set */ public Set getGlobalPermissionEntries(); /** * Get all exposed permissions (regardless of type exposure) - * @return + * @return Set */ public Set getAllExposedPermissions(); /** * Get all exposed permissions (regardless of type exposure) - * @return + * @return Set */ public Set getAllPermissions(); /** * Does this permission allow full control? - * @param permissionReference - * @return + * @param permissionReference PermissionReference + * @return boolean */ public boolean hasFull(PermissionReference permissionReference); diff --git a/source/java/org/alfresco/repo/security/permissions/impl/PermissionReferenceImpl.java b/source/java/org/alfresco/repo/security/permissions/impl/PermissionReferenceImpl.java index ab54551a41..d538dc8b8a 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/PermissionReferenceImpl.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/PermissionReferenceImpl.java @@ -47,8 +47,8 @@ public class PermissionReferenceImpl extends AbstractPermissionReference /** * Factory method to create permission references - * @param qName - * @param name + * @param qName QName + * @param name String * @return the permissions reference */ public static PermissionReferenceImpl getPermissionReference(QName qName, String name) diff --git a/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java b/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java index d493e2137d..bca415b651 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java @@ -158,7 +158,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the dictionary service - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -184,7 +184,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the permissions model dao * - * @param modelDAO + * @param modelDAO ModelDAO */ public void setModelDAO(ModelDAO modelDAO) { @@ -194,7 +194,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the node service. * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -204,7 +204,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the ownable service. * - * @param ownableService + * @param ownableService OwnableService */ public void setOwnableService(OwnableService ownableService) { @@ -213,7 +213,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the tenant service. - * @param tenantService + * @param tenantService TenantService */ public void setTenantService(TenantService tenantService) { @@ -223,7 +223,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the permissions dao component * - * @param permissionsDaoComponent + * @param permissionsDaoComponent PermissionsDaoComponent */ public void setPermissionsDaoComponent(PermissionsDaoComponent permissionsDaoComponent) { @@ -233,7 +233,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the authority service. * - * @param authorityService + * @param authorityService AuthorityService */ public void setAuthorityService(AuthorityService authorityService) { @@ -243,7 +243,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the dynamic authorities * - * @param dynamicAuthorities + * @param dynamicAuthorities List */ public void setDynamicAuthorities(List dynamicAuthorities) { @@ -253,7 +253,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the ACL DAO component. * - * @param aclDaoComponent + * @param aclDaoComponent AclDAO */ public void setAclDAO(AclDAO aclDaoComponent) { @@ -291,7 +291,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Set the policy component * - * @param policyComponent + * @param policyComponent PolicyComponent */ public void setPolicyComponent(PolicyComponent policyComponent) { @@ -301,8 +301,8 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Cache clear on move node * - * @param oldChildAssocRef - * @param newChildAssocRef + * @param oldChildAssocRef ChildAssociationRef + * @param newChildAssocRef ChildAssociationRef */ public void onMoveNode(ChildAssociationRef oldChildAssocRef, ChildAssociationRef newChildAssocRef) { @@ -312,7 +312,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Cache clear on create of a child association from an authority container. * - * @param childAssocRef + * @param childAssocRef ChildAssociationRef */ public void onCreateChildAssociation(ChildAssociationRef childAssocRef) { @@ -322,7 +322,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Cache clear on delete of a child association from an authority container. * - * @param childAssocRef + * @param childAssocRef ChildAssociationRef */ public void beforeDeleteChildAssociation(ChildAssociationRef childAssocRef) { @@ -609,13 +609,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } protected AccessStatus hasPermission(Long aclId, PermissionContext context, PermissionReference permission) - { - if (aclId == null) - { - // Enforce store ACLs if set - if (context.getStoreAcl() == null) - { - return AccessStatus.ALLOWED; + { + if (aclId == null) + { + // Enforce store ACLs if set + if (context.getStoreAcl() == null) + { + return AccessStatus.ALLOWED; } else { @@ -789,7 +789,9 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Get the authorisations for the currently authenticated user * - * @param auth + * @param auth Authentication + * @param nodeRef NodeRef + * @param required PermissionReference * @return the set of authorisations */ protected Set getAuthorisations(Authentication auth, NodeRef nodeRef, PermissionReference required) @@ -1191,7 +1193,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } /** - * @param aclId + * @param aclId Long * @return set of authorities denied permission on the ACL */ @Override @@ -1691,12 +1693,12 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param authorisations - - * the set of authorities - * @param denied - + * + * @param pe - + * the permissions entry to consider + * @param authorisations - + * the set of authorities + * @param denied - * the set of denied permissions/authority pais * @return true if granted */ @@ -1834,14 +1836,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } /** - * Internal hook point for recursion - * - * @param authorisations - * @param aclId - * @param context - * @return true if granted - */ - boolean evaluate(Set authorisations, Long aclId, PermissionContext context) + * Internal hook point for recursion + * + * @param authorisations Set + * @param aclId Long + * @param context PermissionContext + * @return true if granted + */ + boolean evaluate(Set authorisations, Long aclId, PermissionContext context) { // Start out true and "and" all other results boolean success = true; @@ -1891,7 +1893,7 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Check if we have a global permission * - * @param authorisations + * @param authorisations Set * @return true if granted */ private boolean checkGlobalPermissions(Set authorisations) @@ -1907,14 +1909,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } /** - * Check that a given authentication is available on a node - * - * @param authorisations - * @param aclId - * @param context - * @return true if a check is required - */ - boolean checkRequired(Set authorisations, Long aclId, PermissionContext context) + * Check that a given authentication is available on a node + * + * @param authorisations Set + * @param aclId Long + * @param context PermissionContext + * @return true if a check is required + */ + boolean checkRequired(Set authorisations, Long aclId, PermissionContext context) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -1952,18 +1954,18 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param context - * @param authorisations - - * the set of authorities - * @param denied - - * the set of denied permissions/authority pais - * @param context - * @return true if granted - */ - private boolean isGranted(AccessControlEntry ace, Set authorisations, Set> denied, PermissionContext context) + /** + * Is a permission granted + * + * @param ace AccessControlEntry + * @param authorisations - + * the set of authorities + * @param denied - + * the set of denied permissions/authority pais + * @param context PermissionContext + * @return true if granted + */ + private boolean isGranted(AccessControlEntry ace, Set authorisations, Set> denied, PermissionContext context) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.DENIED) @@ -2023,18 +2025,18 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param ace - * @param authorisations - - * the set of authorities - * @param allowed - - * the set of denied permissions/authority pais - * @param context - * @return true if granted - */ - private boolean isDenied(AccessControlEntry ace, Set authorisations, Set> allowed, PermissionContext context) + /** + * Is a permission granted + * + * @param ace AccessControlEntry + * @param authorisations - + * the set of authorities + * @param allowed - + * the set of denied permissions/authority pais + * @param context PermissionContext + * @return true if granted + */ + private boolean isDenied(AccessControlEntry ace, Set authorisations, Set> allowed, PermissionContext context) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.ALLOWED) @@ -2176,14 +2178,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm granters.add(OLD_ALL_PERMISSIONS_REFERENCE); } - /** - * Internal hook point for recursion - * - * @param authority - * @param aclId - * @return true if granted - */ - boolean evaluate(String authority, Long aclId) + /** + * Internal hook point for recursion + * + * @param authority String + * @param aclId Long + * @return true if granted + */ + boolean evaluate(String authority, Long aclId) { // Start out true and "and" all other results boolean success = true; @@ -2237,13 +2239,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } - /** - * Check if we have a global permission - * - * @param authority - * @return true if granted - */ - private boolean checkGlobalPermissions(String authority) + /** + * Check if we have a global permission + * + * @param authority String + * @return true if granted + */ + private boolean checkGlobalPermissions(String authority) { for (PermissionEntry pe : modelDAO.getGlobalPermissionEntries()) { @@ -2255,14 +2257,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Check that a given authentication is available on a node - * - * @param authority - * @param aclId - * @return true if a check is required - */ - boolean checkRequired(String authority, Long aclId) + /** + * Check that a given authentication is available on a node + * + * @param authority String + * @param aclId Long + * @return true if a check is required + */ + boolean checkRequired(String authority, Long aclId) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -2285,14 +2287,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param ace - * @param authority - * @param denied - - * the set of denied permissions/authority pais - * @return true if granted + /** + * Is a permission granted + * + * @param ace AccessControlEntry + * @param authority String + * @param denied - + * the set of denied permissions/authority pais + * @return true if granted */ private boolean isGranted(AccessControlEntry ace, String authority, Set> denied) { @@ -2433,14 +2435,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm granters.add(OLD_ALL_PERMISSIONS_REFERENCE); } - /** - * Internal hook point for recursion - * - * @param authority - * @param aclId - * @return true if granted - */ - boolean evaluate(String authority, Long aclId) + /** + * Internal hook point for recursion + * + * @param authority String + * @param aclId Long + * @return true if granted + */ + boolean evaluate(String authority, Long aclId) { // Start out true and "and" all other results boolean success = true; @@ -2494,13 +2496,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } - /** - * Check if we have a global permission - * - * @param authority - * @return true if granted - */ - private boolean checkGlobalPermissions(String authority) + /** + * Check if we have a global permission + * + * @param authority String + * @return true if granted + */ + private boolean checkGlobalPermissions(String authority) { for (PermissionEntry pe : modelDAO.getGlobalPermissionEntries()) { @@ -2512,14 +2514,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Check that a given authentication is available on a node - * - * @param authority - * @param aclId - * @return true if a check is required - */ - boolean checkRequired(String authority, Long aclId) + /** + * Check that a given authentication is available on a node + * + * @param authority String + * @param aclId Long + * @return true if a check is required + */ + boolean checkRequired(String authority, Long aclId) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -2542,16 +2544,16 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param ace - * @param authority - * @param allowed - - * the set of allowed permissions/authority pais - * @return true if granted - */ - private boolean isDenied(AccessControlEntry ace, String authority, Set> allowed) + /** + * Is a permission granted + * + * @param ace AccessControlEntry + * @param authority String + * @param allowed - + * the set of allowed permissions/authority pais + * @return true if granted + */ + private boolean isDenied(AccessControlEntry ace, String authority, Set> allowed) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.ALLOWED) @@ -2666,13 +2668,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return nodeRef.getStoreRef().getProtocol().equals(VersionModel.STORE_PROTOCOL) || nodeRef.getStoreRef().getIdentifier().equals(Version2Model.STORE_ID); } - /** - * Converts specified version nodeRef (eg. versionStore://...) to versioned nodeRef (eg. workspace://SpacesStore/...) - * - * @param versionNodeRef - always version nodeRef (ie. in the 'version' store) - * @return versioned nodeRef (ie.in the 'live' store) - */ - @SuppressWarnings("deprecation") + /** + * Converts specified version nodeRef (eg. versionStore://...) to versioned nodeRef (eg. workspace://SpacesStore/...) + * + * @param versionNodeRef - always version nodeRef (ie. in the 'version' store) + * @return versioned nodeRef (ie.in the 'live' store) + */ + @SuppressWarnings("deprecation") protected NodeRef convertVersionNodeRefToVersionedNodeRef(NodeRef versionNodeRef) { Map properties = nodeService.getProperties(versionNodeRef); diff --git a/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryAfterInvocationProvider.java b/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryAfterInvocationProvider.java index 7d3d640b26..801f0b0145 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryAfterInvocationProvider.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryAfterInvocationProvider.java @@ -108,7 +108,7 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the permission service. * - * @param permissionService + * @param permissionService PermissionService */ public void setPermissionService(PermissionService permissionService) { @@ -138,7 +138,7 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the namespace prefix resolver * - * @param nspr + * @param nspr NamespacePrefixResolver */ public void setNamespacePrefixResolver(NamespacePrefixResolver nspr) { @@ -158,7 +158,7 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the node service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -168,7 +168,7 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the authentication service * - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { @@ -178,7 +178,7 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the max number of permission checks * - * @param maxPermissionChecks + * @param maxPermissionChecks int */ public void setMaxPermissionChecks(int maxPermissionChecks) { @@ -188,19 +188,19 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, /** * Set the max time for permission checks * - * @param maxPermissionCheckTimeMillis + * @param maxPermissionCheckTimeMillis long */ public void setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis) { this.maxPermissionCheckTimeMillis = maxPermissionCheckTimeMillis; } - - /** - * Types and aspects for which we will abstain on voting if they are present. - * @param unfilteredFor - */ - public void setUnfilteredFor(Set unfilteredFor) - { + + /** + * Types and aspects for which we will abstain on voting if they are present. + * @param unfilteredFor Set + */ + public void setUnfilteredFor(Set unfilteredFor) + { this.unfilteredFor = unfilteredFor; } diff --git a/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryVoter.java b/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryVoter.java index 04715d7aed..61d9ab928b 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryVoter.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/acegi/ACLEntryVoter.java @@ -102,7 +102,7 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean /** * Set the permission service - * @param permissionService + * @param permissionService PermissionService */ public void setPermissionService(PermissionService permissionService) { @@ -129,7 +129,7 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean /** * Set the name space prefix resolver - * @param nspr + * @param nspr NamespacePrefixResolver */ public void setNamespacePrefixResolver(NamespacePrefixResolver nspr) { @@ -156,25 +156,25 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean /** * Set the node service - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; } - - /** - * Set the ownable service - * @param ownableService - */ - public void setOwnableService(OwnableService ownableService) - { + + /** + * Set the ownable service + * @param ownableService OwnableService + */ + public void setOwnableService(OwnableService ownableService) + { this.ownableService = ownableService; } /** * Set the authentication service - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { @@ -183,7 +183,7 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean /** * Set the authority service - * @param authorityService + * @param authorityService AuthorityService */ public void setAuthorityService(AuthorityService authorityService) { @@ -193,7 +193,7 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean /** * Types and aspects for which we will abstain on voting if they are present. - * @param abstainFor + * @param abstainFor Set */ public void setAbstainFor(Set abstainFor) { diff --git a/source/java/org/alfresco/repo/security/permissions/impl/acegi/FilteringResultSet.java b/source/java/org/alfresco/repo/security/permissions/impl/acegi/FilteringResultSet.java index d9c5d4207d..33f13f7569 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/acegi/FilteringResultSet.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/acegi/FilteringResultSet.java @@ -302,7 +302,7 @@ public class FilteringResultSet extends ACLEntryAfterInvocationProvider implemen /** * Bulk fetch results in the cache * - * @param bulkFetch + * @param bulkFetch boolean */ public boolean setBulkFetch(boolean bulkFetch) { @@ -322,7 +322,7 @@ public class FilteringResultSet extends ACLEntryAfterInvocationProvider implemen /** * Set the bulk fetch size * - * @param bulkFetchSize + * @param bulkFetchSize int */ public int setBulkFetchSize(int bulkFetchSize) { diff --git a/source/java/org/alfresco/repo/security/permissions/impl/model/Permission.java b/source/java/org/alfresco/repo/security/permissions/impl/model/Permission.java index 3950ad44d2..7546d04315 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/model/Permission.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/model/Permission.java @@ -72,7 +72,7 @@ public class Permission extends AbstractPermission implements XMLModelInitialisa /** * A permission for the given type * - * @param typeQName + * @param typeQName QName */ public Permission(QName typeQName) { diff --git a/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionGroup.java b/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionGroup.java index da53f682a5..f3469088ab 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionGroup.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionGroup.java @@ -79,7 +79,7 @@ public final class PermissionGroup extends AbstractPermissionReference implement /** * Permission group for the given type or aspect. - * @param container + * @param container QName */ public PermissionGroup(QName container) { diff --git a/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionModel.java b/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionModel.java index 5a6351dcf4..5a11294b1d 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionModel.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/model/PermissionModel.java @@ -258,8 +258,9 @@ public class PermissionModel implements ModelDAO /** * Support to add permissions for types * - * @param type - * @param permissions + * @param type QName + * @param permissions Set + * @param exposedOnly boolean */ private void addTypePermissions(QName type, Set permissions, boolean exposedOnly) { @@ -287,8 +288,9 @@ public class PermissionModel implements ModelDAO /** * Support to add permissions for aspects. * - * @param type - * @param permissions + * @param type QName + * @param permissions Set + * @param exposedOnly boolean */ private void addAspectPermissions(QName type, Set permissions, boolean exposedOnly) { @@ -311,9 +313,11 @@ public class PermissionModel implements ModelDAO /** * Support to merge permissions together. Respects extended permissions. - * - * @param target - * @param type + * + * @param target Set + * @param type QName + * @param exposedOnly boolean + * @param typeRequired boolean */ private void mergePermissions(Set target, QName type, boolean exposedOnly, boolean typeRequired) { @@ -365,7 +369,7 @@ public class PermissionModel implements ModelDAO /** * Support to find permission groups * - * @param target + * @param target PermissionReference * @return the permission group */ private PermissionGroup getPermissionGroupOrNull(PermissionReference target) @@ -377,7 +381,7 @@ public class PermissionModel implements ModelDAO /** * Support to get a permission group * - * @param target + * @param target PermissionReference * @return the permission group */ private PermissionGroup getPermissionGroup(PermissionReference target) @@ -393,7 +397,7 @@ public class PermissionModel implements ModelDAO /** * Get the base permission group for a given permission group. * - * @param pg + * @param pg PermissionGroup * @return the permission group */ private PermissionGroup getBasePermissionGroupOrNull(PermissionGroup pg) @@ -429,7 +433,7 @@ public class PermissionModel implements ModelDAO /** * Query the model for a base permission group Uses the Data Dictionary to reolve inheritance * - * @param pg + * @param pg PermissionGroup * @return the permission group */ private PermissionGroup getBasePermissionGroupOrNullImpl(PermissionGroup pg) @@ -842,8 +846,8 @@ public class PermissionModel implements ModelDAO /** * Get the requirements for a permission * - * @param required - * @param on + * @param required PermissionReference + * @param on RequiredPermission.On * @return the set of permission references */ private Set getRequirementsForPermission(PermissionReference required, RequiredPermission.On on) @@ -866,10 +870,10 @@ public class PermissionModel implements ModelDAO /** * Get the requirements for a permission set * - * @param target - * @param on - * @param qName - * @param aspectQNames + * @param target PermissionGroup + * @param on RequiredPermission.On + * @param qName QName + * @param aspectQNames Set * @return the set of permission references */ private Set getRequirementsForPermissionGroup(PermissionGroup target, RequiredPermission.On on, QName qName, Set aspectQNames) @@ -953,7 +957,7 @@ public class PermissionModel implements ModelDAO /** * Utility method to find a permission * - * @param perm + * @param perm PermissionReference * @return the permission */ private Permission getPermissionOrNull(PermissionReference perm) @@ -965,9 +969,9 @@ public class PermissionModel implements ModelDAO /** * Check type specifc extension of permission sets. * - * @param pr - * @param typeQname - * @param aspects + * @param pr PermissionReference + * @param typeQname QName + * @param aspects Set * @return true if dynamic */ private boolean isPartOfDynamicPermissionGroup(PermissionReference pr, QName typeQname, Set aspects) @@ -1146,7 +1150,7 @@ public class PermissionModel implements ModelDAO /** * Set the model * - * @param model + * @param model String */ public void setModel(String model) { @@ -1156,7 +1160,7 @@ public class PermissionModel implements ModelDAO /** * Set the dtd schema that is used to validate permission model * - * @param dtdSchema + * @param dtdSchema String */ public void setDtdSchema(String dtdSchema) { @@ -1166,7 +1170,7 @@ public class PermissionModel implements ModelDAO /** * Indicates whether model should be validated on initialization against specified dtd * - * @param validate + * @param validate boolean */ public void setValidate(boolean validate) { @@ -1176,7 +1180,7 @@ public class PermissionModel implements ModelDAO /** * Set the dictionary service * - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -1186,7 +1190,7 @@ public class PermissionModel implements ModelDAO /** * Set the node service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -1469,7 +1473,7 @@ public class PermissionModel implements ModelDAO /** * Get the default acces status for the givne permission * - * @param pr + * @param pr PermissionReference * @return the access status */ public AccessStatus getDefaultPermission(PermissionReference pr) @@ -1649,10 +1653,10 @@ public class PermissionModel implements ModelDAO /** * factory for the key * - * @param required - * @param qName - * @param aspectQNames - * @param on + * @param required PermissionReference + * @param qName QName + * @param aspectQNames Set + * @param on RequiredPermission.On * @return the key */ public static RequiredKey getRequiredKey(PermissionReference required, QName qName, Set aspectQNames, RequiredPermission.On on) diff --git a/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider.java b/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider.java index a94f4de415..14336c33be 100644 --- a/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider.java +++ b/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2005-2011 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-2011 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.security.person; @@ -30,8 +30,8 @@ import org.springframework.beans.factory.BeanNameAware; import org.springframework.beans.factory.InitializingBean; /** - * Common support for creating home folders This is hooked into node creation events from Person type objects via the - * homeFolderManager. Provider must all be wired up to the homeFolderManager. + * Common support for creating home folders This is hooked into node creation events from Person type objects via the + * homeFolderManager. Provider must all be wired up to the homeFolderManager. * * @deprecated * Depreciated since 4.0. {@link AbstractHomeFolderProvider2} should now be used. @@ -59,12 +59,12 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, * Service registry to get hold of public services (so that actions are audited) */ private ServiceRegistry serviceRegistry; - + /** * The path to a folder */ private String path; - + /** * The owner to set on creation of a home folder (if unset this will be the uid). */ @@ -85,9 +85,9 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, */ private V2Adaptor v2Adaptor = new V2Adaptor(this); - public AbstractHomeFolderProvider() - { - super(); + public AbstractHomeFolderProvider() + { + super(); } /** @@ -109,7 +109,7 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, /** * Set the home folder manager. - * @param homeFolderManager + * @param homeFolderManager PortableHomeFolderManager */ public void setHomeFolderManager(PortableHomeFolderManager homeFolderManager) { @@ -196,7 +196,7 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, { this.serviceRegistry = serviceRegistry; } - + /** * Set the tenant service */ @@ -204,13 +204,13 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, { // keep class signature but no longer use value } - + /** - * Set the permission manager + * Set the permission manager */ - public void setOnCreatePermissionsManager(PermissionsManager onCreatePermissionsManager) + public void setOnCreatePermissionsManager(PermissionsManager onCreatePermissionsManager) { - this.onCreatePermissionsManager = onCreatePermissionsManager; + this.onCreatePermissionsManager = onCreatePermissionsManager; } /** @@ -221,10 +221,10 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, return onCreatePermissionsManager; } - public void setOnReferencePermissionsManager(PermissionsManager onReferencePermissionsManager) - { - this.onReferencePermissionsManager = onReferencePermissionsManager; - } + public void setOnReferencePermissionsManager(PermissionsManager onReferencePermissionsManager) + { + this.onReferencePermissionsManager = onReferencePermissionsManager; + } /** * Gets the PermissionsManager used on referencing the home folder @@ -233,9 +233,9 @@ public abstract class AbstractHomeFolderProvider implements HomeFolderProvider, { return onReferencePermissionsManager; } - + /** - * Set the authority to use as the owner of all home folder nodes. + * Set the authority to use as the owner of all home folder nodes. */ public void setOwnerOnCreate(String ownerOnCreate) { diff --git a/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider2.java b/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider2.java index e78cccc1c1..f9a2b43410 100644 --- a/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider2.java +++ b/source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider2.java @@ -90,7 +90,7 @@ public abstract class AbstractHomeFolderProvider2 implements /** * Set the home folder manager. - * @param homeFolderManager + * @param homeFolderManager PortableHomeFolderManager */ public void setHomeFolderManager(PortableHomeFolderManager homeFolderManager) { diff --git a/source/java/org/alfresco/repo/security/person/GetPeopleCannedQueryFactory.java b/source/java/org/alfresco/repo/security/person/GetPeopleCannedQueryFactory.java index f9feaa8e92..32dab548a2 100644 --- a/source/java/org/alfresco/repo/security/person/GetPeopleCannedQueryFactory.java +++ b/source/java/org/alfresco/repo/security/person/GetPeopleCannedQueryFactory.java @@ -102,7 +102,6 @@ public class GetPeopleCannedQueryFactory extends AbstractCannedQueryFactory */ private PagingResults getPeopleFts(String pattern, PagingRequest pagingRequest) { @@ -2015,9 +2015,9 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per * Determine if the updated properties constitute a valid user update. * Currently we only check for updates to the user firstname, lastname * - * @param before - * @param after - * @return + * @param before Map + * @param after Map + * @return boolean */ private boolean validUserUpdateEvent(Map before, Map after) { @@ -2035,8 +2035,8 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per /** * Publish new user event * - * @param eventType - * @param properties + * @param eventType String + * @param properties Map */ private void publishEvent(String eventType, Map properties) { diff --git a/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java b/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java index ce2b172b4f..0bce8df9e7 100644 --- a/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java +++ b/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java @@ -116,7 +116,7 @@ public class PortableHomeFolderManager implements HomeFolderManager /** * Register a home folder provider. * - * @param provider + * @param provider HomeFolderProvider */ @SuppressWarnings("deprecation") public void addProvider(HomeFolderProvider provider) @@ -127,7 +127,7 @@ public class PortableHomeFolderManager implements HomeFolderManager /** * Register a home folder provider. * - * @param provider + * @param provider HomeFolderProvider2 */ public void addProvider(HomeFolderProvider2 provider) { @@ -153,7 +153,7 @@ public class PortableHomeFolderManager implements HomeFolderManager /** * Set the default home folder provider (user which none is specified or when one is not found) - * @param defaultProvider + * @param defaultProvider HomeFolderProvider2 */ public void setDefaultProvider(HomeFolderProvider2 defaultProvider) { @@ -259,13 +259,13 @@ public class PortableHomeFolderManager implements HomeFolderManager // Could check to see if provider is a V2Adaptor to avoid // object creation, but there is little point. return new StoreRef(provider.getStoreUrl()); - } - - /** - * Helper method for {@link HomeFolderProvider2#getHomeFolder} (so that it - * does not need its own NodeService) that returns a person property value. - */ - public String getPersonProperty(NodeRef person, QName name) + } + + /** + * Helper method for {@link HomeFolderProvider2#getHomeFolder} (so that it + * does not need its own NodeService) that returns a person property value. + */ + public String getPersonProperty(NodeRef person, QName name) { String value = DefaultTypeConverter.INSTANCE.convert(String.class, nodeService.getProperty(person, name)); @@ -309,13 +309,13 @@ public class PortableHomeFolderManager implements HomeFolderManager pathToResolve + " " + refs.size()); } return refs.get(0); - } - - /** - * Helper method for {@link HomeFolderProvider2#getHomeFolder(NodeRef)} - * implementations to return a {@link HomeSpaceNodeRef} - * @param referenceRootNode indicates that a reference to the root node - * should be returned if the home folder property on the person + } + + /** + * Helper method for {@link HomeFolderProvider2#getHomeFolder(NodeRef)} + * implementations to return a {@link HomeSpaceNodeRef} + * @param referenceRootNode indicates that a reference to the root node + * should be returned if the home folder property on the person * has not yet been set. */ public HomeSpaceNodeRef getHomeFolder(HomeFolderProvider2 provider, NodeRef person, boolean referenceRootNode) diff --git a/source/java/org/alfresco/repo/security/person/SplitPersonCleanupBootstrapBean.java b/source/java/org/alfresco/repo/security/person/SplitPersonCleanupBootstrapBean.java index 2f7ab5f6e8..467c79641e 100644 --- a/source/java/org/alfresco/repo/security/person/SplitPersonCleanupBootstrapBean.java +++ b/source/java/org/alfresco/repo/security/person/SplitPersonCleanupBootstrapBean.java @@ -79,7 +79,7 @@ public class SplitPersonCleanupBootstrapBean extends AbstractLifecycleBean /** * Can have uid+GUID or uid + "(" + GUID + ")" * - * @return + * @return int */ protected int removePeopleWithGUIDBasedIds() { diff --git a/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizer.java b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizer.java index 52e05139c8..678c3954f9 100644 --- a/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizer.java +++ b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizer.java @@ -68,13 +68,13 @@ import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import java.util.concurrent.TimeUnit; -/** - * A ChainingUserRegistrySynchronizer is responsible for synchronizing Alfresco's local user (person) and - * group (authority) information with the external subsystems in the authentication chain (most typically LDAP - * directories). When the {@link #synchronize(boolean, boolean)} method is called, it visits each {@link UserRegistry} bean in - * the 'chain' of application contexts, managed by a {@link ChildApplicationContextManager}, and compares its - * timestamped user and group information with the local users and groups last retrieved from the same source. Any - * updates and additions made to those users and groups are applied to the local copies. The ordering of each +/** + * A ChainingUserRegistrySynchronizer is responsible for synchronizing Alfresco's local user (person) and + * group (authority) information with the external subsystems in the authentication chain (most typically LDAP + * directories). When the {@link #synchronize(boolean, boolean)} method is called, it visits each {@link UserRegistry} bean in + * the 'chain' of application contexts, managed by a {@link ChildApplicationContextManager}, and compares its + * timestamped user and group information with the local users and groups last retrieved from the same source. Any + * updates and additions made to those users and groups are applied to the local copies. The ordering of each * {@link UserRegistry} in the chain determines its precedence when it comes to user and group name collisions. The * {@link JobLockService} is used to ensure that in a cluster, no two nodes actually run a synchronize at the same time. *

    diff --git a/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java index e972d0e4d3..6736832408 100644 --- a/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java +++ b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java @@ -61,14 +61,14 @@ public interface ChainingUserRegistrySynchronizerStatus /** * Get the date/time that the last user/person update completed - * @param zoneId + * @param zoneId String * @return date or null if sync has never completed */ public Date getSynchronizationLastUserUpdateTime(String zoneId); /** * Get the date/time that the last group update completed - * @param zoneId + * @param zoneId String * @return date or null if sync has never completed */ public Date getSynchronizationLastGroupUpdateTime(String zoneId); @@ -89,7 +89,7 @@ public interface ChainingUserRegistrySynchronizerStatus /** * - * @return + * @return String */ public String getSynchronizationStatus(); diff --git a/source/java/org/alfresco/repo/security/sync/SynchronizeDiagnostic.java b/source/java/org/alfresco/repo/security/sync/SynchronizeDiagnostic.java index a8ba6ea483..131d0c75cb 100644 --- a/source/java/org/alfresco/repo/security/sync/SynchronizeDiagnostic.java +++ b/source/java/org/alfresco/repo/security/sync/SynchronizeDiagnostic.java @@ -30,13 +30,13 @@ public interface SynchronizeDiagnostic /** * - * @return + * @return Date */ public Date getPersonLastSynced(); /** * - * @return + * @return Date */ public Date getGroupLastSynced(); diff --git a/source/java/org/alfresco/repo/security/sync/TestableChainingUserRegistrySynchronizer.java b/source/java/org/alfresco/repo/security/sync/TestableChainingUserRegistrySynchronizer.java index 4c1b2bd7b1..5135a47ade 100644 --- a/source/java/org/alfresco/repo/security/sync/TestableChainingUserRegistrySynchronizer.java +++ b/source/java/org/alfresco/repo/security/sync/TestableChainingUserRegistrySynchronizer.java @@ -7,7 +7,7 @@ public interface TestableChainingUserRegistrySynchronizer /** * runs read only diagnostic tests upon the specified user directory, does not actually do any synchronization * - * @param authenticatorName, name of the user directory to test + * @param authenticatorName name of the user directory to test * @return diagnostic information @see org.alfresco.repo.security.sync.SynchronizeDiagnostic * @throws AuthenticationException */ diff --git a/source/java/org/alfresco/repo/site/SiteServiceImpl.java b/source/java/org/alfresco/repo/site/SiteServiceImpl.java index 0d38981769..d44d9ac311 100644 --- a/source/java/org/alfresco/repo/site/SiteServiceImpl.java +++ b/source/java/org/alfresco/repo/site/SiteServiceImpl.java @@ -577,9 +577,10 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic * Note - Changes here likely need to be replicated to the {@link #updateSite(SiteInfo)} * method too, as that also has to deal with Site Permissions. * - * @param siteNodeRef - * @param shortName - * @param visibility + * @param siteNodeRef NodeRef + * @param shortName String + * @param visibility SiteVisibility + * @param memberships Map> */ private void setupSitePermissions( final NodeRef siteNodeRef, final String shortName, final SiteVisibility visibility, final Map> memberships) @@ -704,7 +705,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic /** * Gets a map containing the site's custom properties * - * @return Map map containing the custom properties of the site + * @return map containing the custom properties of the site */ private Map getSiteCustomProperties(Map properties) { @@ -724,7 +725,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic /** * Gets a map containing the site's custom properties * - * @return Map map containing the custom properties of the site + * @return map containing the custom properties of the site */ private Map getSiteCustomProperties(NodeRef siteNodeRef) { @@ -1326,8 +1327,8 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic /** * Get the site implementation given a short name * - * @param shortName - * @return + * @param shortName String + * @return SiteInfo */ private SiteInfo getSiteImpl(String shortName) { @@ -2102,9 +2103,9 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic * One of the user's firstname or lastname must match at least * one of the filters given. * - * @param nameFilters - * @param username - * @return + * @param nameFilters String[] + * @param username String + * @return boolean */ private boolean matchPerson(final String[] nameFilters, final String username) { @@ -2631,7 +2632,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic * * If the containingSite is null then the targetNode's current containing site is used. * - * @param targetNode + * @param targetNode NodeRef * @param containingSite the site which the site is a member of. If null, it will be calculated. */ @Override @@ -2907,7 +2908,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic * * @param userName user name * @param role role - * @return + * @return String */ private String getActivityUserData(String userName, String role) { @@ -2979,9 +2980,9 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic /** * Helper to check that we are not removing the last Site Manager from a site * - * @param shortName - * @param authorityName - * @param role + * @param shortName String + * @param authorityName String + * @param role String */ private void checkLastManagerRemoval(final String shortName, final String authorityName, final String role) { diff --git a/source/java/org/alfresco/repo/site/package-info.java b/source/java/org/alfresco/repo/site/package-info.java index 3d17d04d3d..1104a61bb5 100644 --- a/source/java/org/alfresco/repo/site/package-info.java +++ b/source/java/org/alfresco/repo/site/package-info.java @@ -2,9 +2,9 @@ * Provides the implementation of the site service which is used to provide services used by the sites of the * Share interface. * - * @See org.alfresco.service.cmr.site.SiteService + * @see org.alfresco.service.cmr.site.SiteService * @since 3.0 */ -@PackageMarker -package org.alfresco.repo.site; +@PackageMarker +package org.alfresco.repo.site; import org.alfresco.util.PackageMarker; diff --git a/source/java/org/alfresco/repo/site/script/ScriptSiteService.java b/source/java/org/alfresco/repo/site/script/ScriptSiteService.java index cc9760e88a..03c34c8da4 100644 --- a/source/java/org/alfresco/repo/site/script/ScriptSiteService.java +++ b/source/java/org/alfresco/repo/site/script/ScriptSiteService.java @@ -55,7 +55,7 @@ public class ScriptSiteService extends BaseScopableProcessorExtension /** * Sets the Service Registry * - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { @@ -73,7 +73,7 @@ public class ScriptSiteService extends BaseScopableProcessorExtension } /** - * @see {@link #createSite(String, String, String, String, String)} + * @see #createSite(String, String, String, String, String) * * @param sitePreset site preset * @param shortName site short name @@ -284,7 +284,7 @@ public class ScriptSiteService extends BaseScopableProcessorExtension * Converts the given List of SiteInfo objects to a JavaScript friendly array * of Site objects. * - * @param siteInfos + * @param siteInfos List * @return Array of Site objects */ protected Site[] makeSitesArray(List siteInfos) diff --git a/source/java/org/alfresco/repo/site/script/Site.java b/source/java/org/alfresco/repo/site/script/Site.java index 63767fba5d..e4aedac8fd 100644 --- a/source/java/org/alfresco/repo/site/script/Site.java +++ b/source/java/org/alfresco/repo/site/script/Site.java @@ -252,7 +252,7 @@ public class Site implements Serializable /** * Gets a map of role name mapping to associated group name. * - * @return ScriptableMap map of role to group name + * @return map of role to group name */ public ScriptableHashMap getSitePermissionGroups() { @@ -358,7 +358,7 @@ public class Site implements Serializable * @param nameFilter user name filter * @param roleFilter user role filter * - * @return ScriptableHashMap list of members of site with their roles + * @return list of members of site with their roles * @deprecated Use {@link #listMembers(String, String, int, boolean)} instead */ public ScriptableHashMap listMembers(String nameFilter, String roleFilter) @@ -378,7 +378,7 @@ public class Site implements Serializable * @param roleFilter user role filter * @param size max results size crop if >0 * - * @return ScriptableHashMap list of members of site with their roles + * @return list of members of site with their roles * @deprecated Use {@link #listMembers(String, String, int, boolean)} instead */ public ScriptableHashMap listMembers(String nameFilter, String roleFilter, int size) @@ -400,7 +400,7 @@ public class Site implements Serializable * @param size max results size crop if >0 * @param collapseGroups true if collapse member groups into user list, false otherwise * - * @return ScriptableHashMap list of members of site with their roles + * @return list of members of site with their roles */ public ScriptableHashMap listMembers(String nameFilter, String roleFilter, int size, boolean collapseGroups) { @@ -498,7 +498,7 @@ public class Site implements Serializable /** * Gets (or creates) the "container" folder for the specified component id * - * @param componentId + * @param componentId String * @return node representing the "container" folder (or null, if for some reason * the container can not be created - probably due to permissions) */ @@ -733,7 +733,7 @@ public class Site implements Serializable /** * Determine if the "container" folder for the specified component exists * - * @param componentId + * @param componentId String * @return true => "container" folder exists */ public boolean hasContainer(String componentId) @@ -856,7 +856,7 @@ public class Site implements Serializable /** * Get a map of the sites custom properties * - * @return ScriptableQNameMap map of names and values + * @return map of names and values */ public ScriptableQNameMap getCustomProperties() { diff --git a/source/java/org/alfresco/repo/solr/AlfrescoModelDiff.java b/source/java/org/alfresco/repo/solr/AlfrescoModelDiff.java index 98bdc9f434..e8bf3f1b11 100644 --- a/source/java/org/alfresco/repo/solr/AlfrescoModelDiff.java +++ b/source/java/org/alfresco/repo/solr/AlfrescoModelDiff.java @@ -23,10 +23,10 @@ public class AlfrescoModelDiff /** * use full model name or it will be converted to the prefix form - as we are requesting the model it may not be on the other side - so the namespace is unknown. - * @param modelName - * @param type - * @param oldChecksum - * @param newChecksum + * @param modelName String + * @param type TYPE + * @param oldChecksum Long + * @param newChecksum Long */ public AlfrescoModelDiff(String modelName, TYPE type, Long oldChecksum, Long newChecksum) { diff --git a/source/java/org/alfresco/repo/solr/NodeMetaData.java b/source/java/org/alfresco/repo/solr/NodeMetaData.java index c11a6b0630..b6f12e4545 100644 --- a/source/java/org/alfresco/repo/solr/NodeMetaData.java +++ b/source/java/org/alfresco/repo/solr/NodeMetaData.java @@ -133,8 +133,8 @@ public class NodeMetaData this.childAssocs = childAssocs; } /** - * @param parentAssocs - * @param parentAssocsCrc + * @param parentAssocs List + * @param parentAssocsCrc Long */ public void setParentAssocs(List parentAssocs, Long parentAssocsCrc) { diff --git a/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java b/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java index c5bf1e796e..4b40a48f38 100644 --- a/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java +++ b/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java @@ -136,34 +136,34 @@ public interface SOLRTrackingComponent } /** - * @return + * @return boolean */ boolean isEnabled(); /** - * @param enabled + * @param enabled boolean */ void setEnabled(boolean enabled); /** * Get the last transaction timestamp from the repo - * @return + * @return Long */ public Long getMaxTxnCommitTime(); /** * Get the last transaction id from the repo - * @return + * @return Long */ public Long getMaxTxnId(); /** - * @return + * @return Long */ public Long getMaxChangeSetCommitTime(); /** - * @return + * @return Long */ public Long getMaxChangeSetId(); } diff --git a/source/java/org/alfresco/repo/tagging/TagScopePropertyMethodInterceptor.java b/source/java/org/alfresco/repo/tagging/TagScopePropertyMethodInterceptor.java index d62891dafd..d84c9162eb 100644 --- a/source/java/org/alfresco/repo/tagging/TagScopePropertyMethodInterceptor.java +++ b/source/java/org/alfresco/repo/tagging/TagScopePropertyMethodInterceptor.java @@ -157,10 +157,10 @@ public class TagScopePropertyMethodInterceptor implements MethodInterceptor /** * Given a NodeRef and, optionally, the property map of that node, this operation establishes whether * the node is a TagScope node, and returns the appropriate value of the cm:tagScopeSummary property. - * @param nodeRef + * @param nodeRef NodeRef * @param allNodeProperties Optional. If the caller has a current property map for the node being queried * then supplying it here saves a little time. This argument is allowed to be null. - * @return + * @return List */ protected List getTagSummary(NodeRef nodeRef, Map allNodeProperties) { @@ -207,7 +207,7 @@ public class TagScopePropertyMethodInterceptor implements MethodInterceptor * Allows the functionality of this interceptor to be enabled and disabled on a thread-by-thread basis. * The caller should ensure that the value is reset to its prior setting once it has finished using the * thread of execution. - * @param enable + * @param enable Boolean * @return The setting prior to invoking this operation. */ public static final Boolean setEnabled(Boolean enable) diff --git a/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java b/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java index 33664491ad..4af419cc6d 100644 --- a/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java +++ b/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java @@ -1363,7 +1363,7 @@ public class TaggingServiceImpl implements TaggingService, * This should avoid contention problems and race conditions. * * @param nodeRef node reference - * @param updates + * @param updates Map */ private void updateTagScope(NodeRef nodeRef, Map updates) { diff --git a/source/java/org/alfresco/repo/tagging/script/ScriptTaggingService.java b/source/java/org/alfresco/repo/tagging/script/ScriptTaggingService.java index b07cc15d2b..7c8b49f34a 100644 --- a/source/java/org/alfresco/repo/tagging/script/ScriptTaggingService.java +++ b/source/java/org/alfresco/repo/tagging/script/ScriptTaggingService.java @@ -41,7 +41,7 @@ public class ScriptTaggingService extends BaseScopableProcessorExtension /** * Sets the Service Registry * - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { @@ -64,10 +64,10 @@ public class ScriptTaggingService extends BaseScopableProcessorExtension /** * Get page of tags with totalRecords info * - * @param store - * @param fromTag - * @param pageSize - * @return + * @param store String + * @param fromTag int + * @param pageSize int + * @return PagedTagsWrapper */ public PagedTagsWrapper getPagedTags(String store, int fromTag, int pageSize) { diff --git a/source/java/org/alfresco/repo/template/Session.java b/source/java/org/alfresco/repo/template/Session.java index 403ac4f791..70d1343be2 100644 --- a/source/java/org/alfresco/repo/template/Session.java +++ b/source/java/org/alfresco/repo/template/Session.java @@ -43,7 +43,7 @@ public class Session extends BaseTemplateProcessorExtension /** * Get the current authentication ticket. * - * @return + * @return String */ public String getTicket() { diff --git a/source/java/org/alfresco/repo/template/TemplateNode.java b/source/java/org/alfresco/repo/template/TemplateNode.java index 4c86ab2ae4..9dd8ad6562 100644 --- a/source/java/org/alfresco/repo/template/TemplateNode.java +++ b/source/java/org/alfresco/repo/template/TemplateNode.java @@ -70,7 +70,7 @@ import freemarker.ext.dom.NodeModel; * Various helper methods are provided to access common and useful node variables such * as the content url and type information. *

    - * See {@link http://wiki.alfresco.com/wiki/Template_Guide} + * See Template_Guide * * @author Kevin Roast */ diff --git a/source/java/org/alfresco/repo/template/XSLTemplateModel.java b/source/java/org/alfresco/repo/template/XSLTemplateModel.java index e87473a035..f822469e59 100644 --- a/source/java/org/alfresco/repo/template/XSLTemplateModel.java +++ b/source/java/org/alfresco/repo/template/XSLTemplateModel.java @@ -39,8 +39,8 @@ public class XSLTemplateModel implements Map } /** - * @param key - * @return + * @param key Object + * @return boolean * @see java.util.Map#containsKey(java.lang.Object) */ public boolean containsKey(Object key) @@ -49,8 +49,8 @@ public class XSLTemplateModel implements Map } /** - * @param value - * @return + * @param value Object + * @return boolean * @see java.util.Map#containsValue(java.lang.Object) */ public boolean containsValue(Object value) @@ -59,7 +59,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return Set * @see java.util.Map#entrySet() */ public Set> entrySet() @@ -68,8 +68,8 @@ public class XSLTemplateModel implements Map } /** - * @param o - * @return + * @param o Object + * @return boolean * @see java.util.Map#equals(java.lang.Object) */ public boolean equals(Object o) @@ -78,8 +78,8 @@ public class XSLTemplateModel implements Map } /** - * @param key - * @return + * @param key Object + * @return Object * @see java.util.Map#get(java.lang.Object) */ public Object get(Object key) @@ -88,7 +88,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return int * @see java.util.Map#hashCode() */ public int hashCode() @@ -97,7 +97,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return boolean * @see java.util.Map#isEmpty() */ public boolean isEmpty() @@ -106,7 +106,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return Set * @see java.util.Map#keySet() */ public Set keySet() @@ -115,9 +115,9 @@ public class XSLTemplateModel implements Map } /** - * @param key - * @param value - * @return + * @param key Object + * @param value Object + * @return Object * @see java.util.Map#put(java.lang.Object, java.lang.Object) */ public Object put(QName key, Object value) @@ -126,7 +126,7 @@ public class XSLTemplateModel implements Map } /** - * @param m + * @param m Map * @see java.util.Map#putAll(java.util.Map) */ public void putAll(Map m) @@ -135,8 +135,8 @@ public class XSLTemplateModel implements Map } /** - * @param key - * @return + * @param key Object + * @return Object * @see java.util.Map#remove(java.lang.Object) */ public Object remove(Object key) @@ -145,7 +145,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return int * @see java.util.Map#size() */ public int size() @@ -154,7 +154,7 @@ public class XSLTemplateModel implements Map } /** - * @return + * @return Collection * @see java.util.Map#values() */ public Collection values() diff --git a/source/java/org/alfresco/repo/tenant/MultiTServiceImpl.java b/source/java/org/alfresco/repo/tenant/MultiTServiceImpl.java index f3ced9efe6..5405c0eb99 100644 --- a/source/java/org/alfresco/repo/tenant/MultiTServiceImpl.java +++ b/source/java/org/alfresco/repo/tenant/MultiTServiceImpl.java @@ -682,7 +682,7 @@ public class MultiTServiceImpl implements TenantService } /** - * @return + * @return String */ public static String getMultiTenantDomainName(String name) { diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailDefinition.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailDefinition.java index 3d49434e2d..731a7d561f 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailDefinition.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailDefinition.java @@ -69,8 +69,8 @@ public class ThumbnailDefinition /** * Constructor * - * @param destinationMimetype - * @param options + * @param destinationMimetype String + * @param options TransformationOptions */ public ThumbnailDefinition(String destinationMimetype, TransformationOptions options) { @@ -93,10 +93,10 @@ public class ThumbnailDefinition /** * Constructor. Specify the place holder thumbnail path. * - * @param mimetype - * @param options - * @param thumbnailName - * @param placeHolderResourcePath + * @param mimetype String + * @param options TransformationOptions + * @param thumbnailName String + * @param placeHolderResourcePath String */ public ThumbnailDefinition(String mimetype, TransformationOptions options, String thumbnailName, String placeHolderResourcePath) { @@ -200,7 +200,7 @@ public class ThumbnailDefinition /** * This method sets the placeholder resource path. * - * @param placeHolderResourcePath + * @param placeHolderResourcePath String */ public void setPlaceHolderResourcePath(String placeHolderResourcePath) { @@ -209,7 +209,7 @@ public class ThumbnailDefinition /** * - * @return + * @return String */ public String getPlaceHolderResourcePath() { @@ -219,7 +219,7 @@ public class ThumbnailDefinition /** * This method sets the mime-aware placeholder resource path template. * - * @param mimeAwarePlaceHolderResourcePath + * @param mimeAwarePlaceHolderResourcePath String * @since 3.4.1 (Team) */ public void setMimeAwarePlaceHolderResourcePath(String mimeAwarePlaceHolderResourcePath) @@ -229,7 +229,7 @@ public class ThumbnailDefinition /** * - * @return + * @return String * @since 3.4.1 (Team) */ public String getMimeAwarePlaceHolderResourcePath() @@ -250,7 +250,7 @@ public class ThumbnailDefinition /** * Sets the thumbnail registry * - * @param thumbnailRegistry + * @param thumbnailRegistry ThumbnailRegistry */ public void setThumbnailRegistry(ThumbnailRegistry thumbnailRegistry) { diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java index 502d0425e7..f327d48216 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java @@ -134,7 +134,7 @@ public class ThumbnailRegistry implements ApplicationContextAware, ApplicationLi /** * This method is used to inject the thumbnail definitions. - * @param thumbnailDefinitions + * @param thumbnailDefinitions List */ public void setThumbnailDefinitions(final List thumbnailDefinitions) { @@ -298,8 +298,8 @@ public class ThumbnailRegistry implements ApplicationContextAware, ApplicationLi /** * - * @param mimetype - * @return + * @param mimetype String + * @return List * @deprecated Use {@link #getThumbnailDefinitions(String)} instead. */ @Deprecated @@ -373,8 +373,8 @@ public class ThumbnailRegistry implements ApplicationContextAware, ApplicationLi /** * Returns the maximum source size of any content that may transformed between the supplied * sourceMimetype and thumbnailDefinition's targetMimetype using its transformation options. - * @param sourceMimetype - * @param thumbnailDefinition + * @param sourceMimetype String + * @param thumbnailDefinition ThumbnailDefinition * @return 0 if there are no transformers, -1 if there is no limit or if positive the size in bytes. */ public long getMaxSourceSizeBytes(String sourceMimetype, ThumbnailDefinition thumbnailDefinition) diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailRenditionConvertor.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailRenditionConvertor.java index 894f03e5a5..89a1dcf6ce 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailRenditionConvertor.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailRenditionConvertor.java @@ -69,9 +69,9 @@ public class ThumbnailRenditionConvertor * {@link ThumbnailParentAssociationDetails assocDetails}, * create and return an equivalent {@link RenditionDefinition} object. * - * @param thumbnailDefinition - * @param assocDetails - * @return + * @param thumbnailDefinition ThumbnailDefinition + * @param assocDetails ThumbnailParentAssociationDetails + * @return RenditionDefinitions */ public RenditionDefinition convert(ThumbnailDefinition thumbnailDefinition, ThumbnailParentAssociationDetails assocDetails) { @@ -110,7 +110,7 @@ public class ThumbnailRenditionConvertor /** * This method examines the various data values on the thumbnail definition and * works out if it is an 'image' rendition or a 'reformat' rendition - * @param thumbnailDefinition + * @param thumbnailDefinition ThumbnailDefinition * @return true for an image-based RenditionDefinition, else false */ private boolean isImageBasedRendition(ThumbnailDefinition thumbnailDefinition) @@ -125,9 +125,9 @@ public class ThumbnailRenditionConvertor * create and return a parameter Map which contains the equivalent {@link RenditionDefinition} * configuration. * - * @param transformationOptions - * @param assocDetails - * @return + * @param transformationOptions TransformationOptions + * @param assocDetails ThumbnailParentAssociationDetails + * @return Map */ public Map convert(TransformationOptions transformationOptions, ThumbnailParentAssociationDetails assocDetails) { diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java index 2de28087ec..880b33983f 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java @@ -114,7 +114,7 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Set the behaviour filter. * - * @param behaviourFilter + * @param behaviourFilter BehaviourFilter */ public void setBehaviourFilter(BehaviourFilter behaviourFilter) { @@ -124,7 +124,7 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Set the rendition service. * - * @param renditionService + * @param renditionService RenditionService */ public void setRenditionService(RenditionService renditionService) { @@ -611,9 +611,9 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Creates a {@link RenditionDefinition} with no parameters set. - * @param thumbnailQName - * @param transformationOptions - * @return + * @param thumbnailQName QName + * @param transformationOptions TransformationOptions + * @return RenditionDefinition */ private RenditionDefinition createRawRenditionDefinition(QName thumbnailQName, final TransformationOptions transformationOptions) @@ -628,12 +628,12 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Creates a fully parameterized {@link RenditionDefinition}. - * @param contentProperty - * @param mimetype - * @param transformationOptions - * @param thumbnailQName - * @param assocDetails - * @return + * @param contentProperty QName + * @param mimetype String + * @param transformationOptions TransformationOptions + * @param thumbnailQName QName + * @param assocDetails ThumbnailParentAssociationDetails + * @return RenditionDefinition */ private RenditionDefinition createRenditionDefinition(final QName contentProperty, final String mimetype, final TransformationOptions transformationOptions, final QName thumbnailQName, @@ -675,8 +675,8 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Sets the thumbnail name if the rendition is of type cm:thumbnail. - * @param thumbnail - * @param thumbnailName + * @param thumbnail NodeRef + * @param thumbnailName String */ private void setThumbnailNameProperty(NodeRef thumbnail, String thumbnailName) { diff --git a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnail.java b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnail.java index 6a1671f6bf..3d1884afec 100644 --- a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnail.java +++ b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnail.java @@ -46,9 +46,9 @@ public class ScriptThumbnail extends ScriptNode /** * Constructor * - * @param nodeRef - * @param services - * @param scope + * @param nodeRef NodeRef + * @param services ServiceRegistry + * @param scope Scriptable */ public ScriptThumbnail(NodeRef nodeRef, ServiceRegistry services, Scriptable scope) { diff --git a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java index e382b831fc..3773f973c7 100644 --- a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java +++ b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java @@ -39,7 +39,7 @@ public class ScriptThumbnailService extends BaseScopableProcessorExtension /** * Sets the Service Registry * - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { diff --git a/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java b/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java index 762f7dc9a0..aa0f2f3718 100644 --- a/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java +++ b/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java @@ -142,7 +142,7 @@ public abstract class AlfrescoTransactionSupport extends TransactionSupportUtil * * @return true => changes are pending * - * @deprecated To be replaced by {@link DirtySessionMethodInterceptor} + * @deprecated To be replaced by {@code DirtySessionMethodInterceptor} */ public static boolean isDirty() { @@ -182,7 +182,7 @@ public abstract class AlfrescoTransactionSupport extends TransactionSupportUtil * This method can be called repeatedly as long as the service being bound * implements equals and hashCode. * - * @param daoService + * @param daoService TransactionalDao */ public static void bindDaoService(TransactionalDao daoService) { @@ -206,7 +206,7 @@ public abstract class AlfrescoTransactionSupport extends TransactionSupportUtil * This method can be called repeatedly as long as the service being bound * implements equals and hashCode. * - * @param integrityChecker + * @param integrityChecker IntegrityChecker */ public static void bindIntegrityChecker(IntegrityChecker integrityChecker) { diff --git a/source/java/org/alfresco/repo/transaction/TooBusyException.java b/source/java/org/alfresco/repo/transaction/TooBusyException.java index 88d46d7476..c13cebdb81 100644 --- a/source/java/org/alfresco/repo/transaction/TooBusyException.java +++ b/source/java/org/alfresco/repo/transaction/TooBusyException.java @@ -33,7 +33,7 @@ public class TooBusyException extends AlfrescoRuntimeException private static final long serialVersionUID = 1L; /** - * @param msgId + * @param msgId String */ public TooBusyException(String msgId) { @@ -41,8 +41,8 @@ public class TooBusyException extends AlfrescoRuntimeException } /** - * @param msgId - * @param msgParams + * @param msgId String + * @param msgParams Object[] */ public TooBusyException(String msgId, Object[] msgParams) { @@ -50,8 +50,8 @@ public class TooBusyException extends AlfrescoRuntimeException } /** - * @param msgId - * @param cause + * @param msgId String + * @param cause Throwable */ public TooBusyException(String msgId, Throwable cause) { @@ -59,9 +59,9 @@ public class TooBusyException extends AlfrescoRuntimeException } /** - * @param msgId - * @param msgParams - * @param cause + * @param msgId String + * @param msgParams Object[] + * @param cause Throwable */ public TooBusyException(String msgId, Object[] msgParams, Throwable cause) { diff --git a/source/java/org/alfresco/repo/transaction/TransactionAwareSingleton.java b/source/java/org/alfresco/repo/transaction/TransactionAwareSingleton.java index 5431c0acd5..edf5c304b8 100644 --- a/source/java/org/alfresco/repo/transaction/TransactionAwareSingleton.java +++ b/source/java/org/alfresco/repo/transaction/TransactionAwareSingleton.java @@ -35,7 +35,7 @@ import org.alfresco.util.GUID; * private static final TransactionAwareSingleton MY_SINGLETON = new TransactionAwareSingleton(); * *

    - * All modifications to the singleton via {@link #get()} and {@link #put(T)} are made in a + * All modifications to the singleton via {@link #get()} and {@link #put(Object)} are made in a * transaction-local manner and promoted to the shared value in a thread-safe manner upon * transacton completion. Transaction-local changes take precedence over the shared value. * diff --git a/source/java/org/alfresco/repo/transfer/AbstractManifestProcessorBase.java b/source/java/org/alfresco/repo/transfer/AbstractManifestProcessorBase.java index 98f4612b28..4d88b3e1fd 100644 --- a/source/java/org/alfresco/repo/transfer/AbstractManifestProcessorBase.java +++ b/source/java/org/alfresco/repo/transfer/AbstractManifestProcessorBase.java @@ -156,9 +156,9 @@ public abstract class AbstractManifestProcessorBase implements TransferManifestP /** * Given the node ref, this method constructs the appropriate ChildAssociationRef that would place this node in the * transfer's temporary folder. Useful when handling orphans. - * - * @param nodeRef - * @return + * + * @param nodeRef NodeRef + * @return ChildAssociationRef */ protected ChildAssociationRef getTemporaryLocation(NodeRef nodeRef) { @@ -248,8 +248,8 @@ public abstract class AbstractManifestProcessorBase implements TransferManifestP * This method is invoked if an exception or error occurs while processing the manifest. * By default it does nothing, but classes that extend this class can override this to provide * custom clean-up. - * @param node - * @param ex + * @param node TransferManifestNode + * @param ex Throwable */ protected void localHandleException(TransferManifestNode node, Throwable ex) { diff --git a/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java b/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java index 7a11ac5dbf..93fd95f524 100644 --- a/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java @@ -832,8 +832,8 @@ public class AlienProcessorImpl implements AlienProcessor /** * Is this node invaded ? - * @param nodeRef - * @param invader + * @param nodeRef NodeRef + * @param invader String * @return true, this node has been invaded by the invader */ private boolean isInvaded(NodeRef nodeRef, String invader) diff --git a/source/java/org/alfresco/repo/transfer/BasicCorrespondingNodeResolverImpl.java b/source/java/org/alfresco/repo/transfer/BasicCorrespondingNodeResolverImpl.java index cacc6ec636..d5e47aa94d 100644 --- a/source/java/org/alfresco/repo/transfer/BasicCorrespondingNodeResolverImpl.java +++ b/source/java/org/alfresco/repo/transfer/BasicCorrespondingNodeResolverImpl.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -104,7 +104,10 @@ public class BasicCorrespondingNodeResolverImpl implements CorrespondingNodeReso } /** - * @param parentPath + * + * @param store StoreRef + * @param parentPath Path + * @return NodeRef */ private NodeRef resolveParentPath(StoreRef store, Path parentPath) { diff --git a/source/java/org/alfresco/repo/transfer/CachingCorrespondingNodeResolverImpl.java b/source/java/org/alfresco/repo/transfer/CachingCorrespondingNodeResolverImpl.java index cb8bdbd75d..edf7c6716a 100644 --- a/source/java/org/alfresco/repo/transfer/CachingCorrespondingNodeResolverImpl.java +++ b/source/java/org/alfresco/repo/transfer/CachingCorrespondingNodeResolverImpl.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -45,7 +45,7 @@ public class CachingCorrespondingNodeResolverImpl implements CorrespondingNodeRe } /** - * @param delegateResolver + * @param delegateResolver CorrespondingNodeResolver */ public CachingCorrespondingNodeResolverImpl(CorrespondingNodeResolver delegateResolver) { diff --git a/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java b/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java index b8786944ac..cacfd0332d 100644 --- a/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java +++ b/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java @@ -121,8 +121,8 @@ public class ChildAssociatedNodeFinder extends AbstractNodeFinder } /** - * @param thisNode - * @return + * @param thisNode NodeRef + * @return Set */ private Set processExcludedSet(NodeRef thisNode) { diff --git a/source/java/org/alfresco/repo/transfer/ContentChunkProcessor.java b/source/java/org/alfresco/repo/transfer/ContentChunkProcessor.java index 6288a43d5c..e874c4e4a8 100644 --- a/source/java/org/alfresco/repo/transfer/ContentChunkProcessor.java +++ b/source/java/org/alfresco/repo/transfer/ContentChunkProcessor.java @@ -31,7 +31,7 @@ public interface ContentChunkProcessor { /** * process this chunk of content data - * @param data + * @param data Set */ public void processChunk(Set data) throws TransferException; diff --git a/source/java/org/alfresco/repo/transfer/ContentChunker.java b/source/java/org/alfresco/repo/transfer/ContentChunker.java index b5bb5f9bc6..5571eccf6d 100644 --- a/source/java/org/alfresco/repo/transfer/ContentChunker.java +++ b/source/java/org/alfresco/repo/transfer/ContentChunker.java @@ -49,19 +49,19 @@ public interface ContentChunker /** * - * @param chunkSize + * @param chunkSize long */ public void setChunkSize(long chunkSize); /** * - * @return + * @return long */ public long getChunkSize(); /** * - * @param handler + * @param handler ContentChunkProcessor */ public void setHandler(ContentChunkProcessor handler); diff --git a/source/java/org/alfresco/repo/transfer/ContentDataPart.java b/source/java/org/alfresco/repo/transfer/ContentDataPart.java index f1330ceef2..831f56582d 100644 --- a/source/java/org/alfresco/repo/transfer/ContentDataPart.java +++ b/source/java/org/alfresco/repo/transfer/ContentDataPart.java @@ -48,7 +48,7 @@ public class ContentDataPart extends PartBase /** * ContentDataPart * @param contentService content service - * @param partName + * @param partName String * @param data data */ public ContentDataPart(ContentService contentService, String partName, ContentData data) { diff --git a/source/java/org/alfresco/repo/transfer/CorrespondingNodeResolverFactory.java b/source/java/org/alfresco/repo/transfer/CorrespondingNodeResolverFactory.java index eb266327cd..6b503e0cb6 100644 --- a/source/java/org/alfresco/repo/transfer/CorrespondingNodeResolverFactory.java +++ b/source/java/org/alfresco/repo/transfer/CorrespondingNodeResolverFactory.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -27,7 +27,7 @@ public interface CorrespondingNodeResolverFactory { /** - * @return + * @return CorrespondingNodeResolver */ CorrespondingNodeResolver getResolver(); diff --git a/source/java/org/alfresco/repo/transfer/HttpClientTransmitterImpl.java b/source/java/org/alfresco/repo/transfer/HttpClientTransmitterImpl.java index a163fbb154..47a8ca7bc8 100644 --- a/source/java/org/alfresco/repo/transfer/HttpClientTransmitterImpl.java +++ b/source/java/org/alfresco/repo/transfer/HttpClientTransmitterImpl.java @@ -120,7 +120,7 @@ public class HttpClientTransmitterImpl implements TransferTransmitter /** * By default this class uses the standard SSLProtocolSocketFactory, but this method allows this to be overridden. * Useful if, for example, one wishes to permit support of self-signed certificates on the target. - * @param socketFactory + * @param socketFactory ProtocolSocketFactory */ public void setHttpsSocketFactory(ProtocolSocketFactory socketFactory) { @@ -131,7 +131,7 @@ public class HttpClientTransmitterImpl implements TransferTransmitter * By default, this class uses a plain HttpClient instance with the only non-default * option being the multi-threaded connection manager. * Use this method to replace this with your own HttpClient instance configured how you wish - * @param httpClient + * @param httpClient HttpClient */ public void setHttpClient(HttpClient httpClient) { @@ -140,7 +140,7 @@ public class HttpClientTransmitterImpl implements TransferTransmitter /** * Whether httpClient will use preemptive authentication or not. - * @param flag + * @param isAuthenticationPreemptive boolean */ public void setIsAuthenticationPreemptive(boolean isAuthenticationPreemptive) { @@ -182,7 +182,10 @@ public class HttpClientTransmitterImpl implements TransferTransmitter } /** - * @param response + * + * @param methodName String + * @param response int + * @param method HttpMethod */ private void checkResponseStatus(String methodName, int response, HttpMethod method) { @@ -213,8 +216,8 @@ public class HttpClientTransmitterImpl implements TransferTransmitter /** * Get the HTTPState for a transfer target - * @param target - * @return + * @param target TransferTarget + * @return HttpState */ protected HttpState getHttpState(TransferTarget target) { @@ -226,8 +229,8 @@ public class HttpClientTransmitterImpl implements TransferTransmitter } /** - * @param target - * @return + * @param target TransferTarget + * @return HostConfiguration */ private HostConfiguration getHostConfig(TransferTarget target) { @@ -742,7 +745,7 @@ public class HttpClientTransmitterImpl implements TransferTransmitter * the error message ("errorMessage"), and, optionally, the Alfresco message id ("alfrescoErrorId") * and Alfresco message parameters ("alfrescoErrorParams"). * @return The rehydrated error object, or null if errorJSON is null. - * @throws JSONException if an error occurs while parsing the supplied JSON object + * Throws {@code JSONException} if an error occurs while parsing the supplied JSON object */ private Throwable rehydrateError(JSONObject errorJSON) { diff --git a/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java b/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java index 937f8f994c..452e3dbb11 100644 --- a/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java +++ b/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java @@ -45,8 +45,8 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @return + * @param transferId String + * @return TransferProgress * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#getProgress(java.lang.String) */ @@ -56,9 +56,9 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @param obj - * @param ex + * @param transferId String + * @param obj Object + * @param ex Throwable * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#logException(java.lang.String, java.lang.Object, java.lang.Throwable) */ @@ -69,8 +69,8 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @param obj + * @param transferId String + * @param obj Object * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#logComment(java.lang.String, java.lang.Object) */ @@ -110,9 +110,9 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @param currPos - * @param endPos + * @param transferId String + * @param currPos int + * @param endPos int * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#updateProgress(java.lang.String, int, int) */ @@ -126,8 +126,8 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @param currPos + * @param transferId String + * @param currPos int * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#updateProgress(java.lang.String, int) */ @@ -141,8 +141,8 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit } /** - * @param transferId - * @param status + * @param transferId String + * @param status Status * @throws TransferException * @see org.alfresco.repo.transfer.TransferProgressMonitor#updateStatus(java.lang.String, org.alfresco.service.cmr.transfer.TransferProgress.Status) */ diff --git a/source/java/org/alfresco/repo/transfer/ManifestProcessorFactory.java b/source/java/org/alfresco/repo/transfer/ManifestProcessorFactory.java index e91d82f922..ae308eaf1b 100644 --- a/source/java/org/alfresco/repo/transfer/ManifestProcessorFactory.java +++ b/source/java/org/alfresco/repo/transfer/ManifestProcessorFactory.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -34,16 +34,17 @@ public interface ManifestProcessorFactory { /** * The requisite processor - * @param receiver - * @param transferId + * @param receiver TransferReceiver + * @param transferId String + * @param out TransferRequsiteWriter * @return the requisite processor */ TransferManifestProcessor getRequsiteProcessor(TransferReceiver receiver, String transferId, TransferRequsiteWriter out); /** * The commit processors - * @param receiver - * @param transferId + * @param receiver TransferReceiver + * @param transferId String * @return the requsite processor */ List getCommitProcessors(TransferReceiver receiver, String transferId); diff --git a/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java b/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java index b6a4ed758e..12f7cb0479 100644 --- a/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java +++ b/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java @@ -112,8 +112,8 @@ public class PeerAssociatedNodeFinder extends AbstractNodeFinder } /** - * @param thisNode - * @return + * @param thisNode NodeRef + * @return Set */ private Set processExcludedSet(NodeRef thisNode) { diff --git a/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java b/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java index 5013a1ba67..3d9b9faa1b 100644 --- a/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java @@ -123,7 +123,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB private Map categoryMap = new HashMap(); /** - * @param transferId + * @param receiver TransferReceiver + * @param transferId String */ public RepoPrimaryManifestProcessorImpl(TransferReceiver receiver, String transferId) { @@ -276,9 +277,9 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB /** * Create new node. * - * @param node - * @param resolvedNodes - * @param primaryParentAssoc + * @param node TransferManifestNormalNode + * @param resolvedNodes ResolvedParentChildPair + * @param primaryParentAssoc ChildAssociationRef */ private void create(TransferManifestNormalNode node, ResolvedParentChildPair resolvedNodes, ChildAssociationRef primaryParentAssoc) @@ -399,8 +400,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB /** * Delete this node - * @param node - * @param nodeToDelete + * @param node TransferManifestDeletedNode + * @param nodeToDelete NodeRef */ protected void delete(TransferManifestDeletedNode node, NodeRef nodeToDelete) { @@ -473,9 +474,9 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB /** * - * @param node - * @param resolvedNodes - * @param primaryParentAssoc + * @param node TransferManifestNormalNode + * @param resolvedNodes ResolvedParentChildPair + * @param primaryParentAssoc ChildAssociationRef */ private void update(TransferManifestNormalNode node, ResolvedParentChildPair resolvedNodes, ChildAssociationRef primaryParentAssoc) @@ -856,8 +857,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @param nodeToUpdate - * @param contentProps + * @param nodeToUpdate NodeRef + * @param contentProps Map * @return true if any content property has been updated for the needToUpdate node */ private boolean writeContent(NodeRef nodeToUpdate, Map contentProps) @@ -921,7 +922,7 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @return + * @return Set */ protected Set getLocalProperties() { @@ -929,7 +930,7 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @param primaryParentAssoc + * @param primaryParentAssoc ChildAssociationRef */ private void storeOrphanNode(ChildAssociationRef primaryParentAssoc) { @@ -943,8 +944,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @param node - * @param msgId + * @param node TransferManifestNode + * @param msgId String */ private void error(TransferManifestNode node, String msgId) { @@ -954,7 +955,7 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @param msgId + * @param msgId String */ private void error(String msgId) { @@ -1030,8 +1031,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB * CRUD of Categories and Tags - also maps noderefs of type d:content from source to target * * - * @param properties - * @param manifestCategories + * @param properties Map + * @param manifestCategories Map */ private void processCategories(Map properties, Map manifestCategories) { @@ -1094,8 +1095,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB * * It will lazily create any missing categories and tags as it executes. * - * @param sourceCategoryNodeRef - * @param manifestCategories + * @param sourceCategoryNodeRef NodeRef + * @param manifestCategories Map * @return targetNodeRef */ private NodeRef processCategory(final NodeRef sourceCategoryNodeRef, final Map manifestCategories) diff --git a/source/java/org/alfresco/repo/transfer/RepoRequisiteManifestProcessorImpl.java b/source/java/org/alfresco/repo/transfer/RepoRequisiteManifestProcessorImpl.java index adbfe23faa..8080722ab5 100644 --- a/source/java/org/alfresco/repo/transfer/RepoRequisiteManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoRequisiteManifestProcessorImpl.java @@ -56,8 +56,9 @@ public class RepoRequisiteManifestProcessorImpl extends AbstractManifestProcesso private static final Log log = LogFactory.getLog(RepoRequisiteManifestProcessorImpl.class); /** - * @param receiver - * @param transferId + * @param receiver TransferReceiver + * @param transferId String + * @param out TransferRequsiteWriter */ public RepoRequisiteManifestProcessorImpl(TransferReceiver receiver, String transferId, TransferRequsiteWriter out) { diff --git a/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java b/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java index 2290a9056c..a893dd1282 100644 --- a/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java @@ -58,8 +58,8 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso private static final Log log = LogFactory.getLog(RepoSecondaryManifestProcessorImpl.class); /** - * @param receiver - * @param transferId + * @param receiver TransferReceiver + * @param transferId String */ public RepoSecondaryManifestProcessorImpl(TransferReceiver receiver, String transferId) { @@ -117,10 +117,10 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso /** * Process the peer associations * - * @param requiredAssocs - * @param currentAssocs - * @param nodeRef - * @param isSource + * @param requiredAssocs List + * @param currentAssocs List + * @param nodeRef NodeRef + * @param isSource boolean */ private void processPeerAssociations(List requiredAssocs, List currentAssocs, @@ -316,9 +316,9 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso /** * - * @param sourceRef - * @param targetRef - * @param assocTypeQName + * @param sourceRef NodeRef + * @param targetRef NodeRef + * @param assocTypeQName QName */ public AssociationRefKey(NodeRef sourceRef, NodeRef targetRef, QName assocTypeQName) { @@ -329,7 +329,7 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso /** * - * @param ref + * @param ref AssociationRef */ public AssociationRefKey(AssociationRef ref) { @@ -341,7 +341,6 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso /** * Compares: *

      - *
    • {@link #id}
    • *
    • {@link #sourceRef}
    • *
    • {@link #targetRef}
    • *
    • {@link #assocTypeQName}
    • diff --git a/source/java/org/alfresco/repo/transfer/RepoTertiaryManifestProcessorImpl.java b/source/java/org/alfresco/repo/transfer/RepoTertiaryManifestProcessorImpl.java index 7bee77f887..bc89a093e9 100644 --- a/source/java/org/alfresco/repo/transfer/RepoTertiaryManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoTertiaryManifestProcessorImpl.java @@ -1,19 +1,19 @@ /* * Copyright (C) 2009-2015 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 + * + * 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.transfer; @@ -60,8 +60,8 @@ public class RepoTertiaryManifestProcessorImpl extends AbstractManifestProcessor String manifestRepositoryId; /** - * @param receiver - * @param transferId + * @param receiver TransferReceiver + * @param transferId String */ public RepoTertiaryManifestProcessorImpl(TransferReceiver receiver, String transferId) { diff --git a/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java b/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java index b060f9df80..88a02a9fda 100644 --- a/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java @@ -499,7 +499,7 @@ public class RepoTransferReceiverImpl implements TransferReceiver, } /** - * @return + * @return NodeRef */ private NodeRef createTransferRecord() { @@ -558,7 +558,7 @@ public class RepoTransferReceiverImpl implements TransferReceiver, * * This is the last chance to clean up. * - * @param transferId + * @param transferId String */ private void timeout(final String transferId) { @@ -722,7 +722,7 @@ public class RepoTransferReceiverImpl implements TransferReceiver, } /** - * @param file + * @param file File */ private void deleteFile(File file) { diff --git a/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java b/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java index 377345bb05..f19a782a34 100644 --- a/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java +++ b/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java @@ -60,7 +60,7 @@ public class StandardNodeCrawlerImpl implements NodeCrawler } /** - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public StandardNodeCrawlerImpl(ServiceRegistry serviceRegistry) { @@ -146,8 +146,8 @@ public class StandardNodeCrawlerImpl implements NodeCrawler } /** - * @param thisNode - * @return + * @param thisNode NodeRef + * @return Set */ private Set findSubsequentNodes(NodeRef thisNode) { @@ -160,8 +160,8 @@ public class StandardNodeCrawlerImpl implements NodeCrawler } /** - * @param thisNode - * @return + * @param thisNode NodeRef + * @return boolean */ private boolean includeNode(NodeRef thisNode) { diff --git a/source/java/org/alfresco/repo/transfer/Transfer.java b/source/java/org/alfresco/repo/transfer/Transfer.java index 8b96ac3a30..9d2c6c266c 100644 --- a/source/java/org/alfresco/repo/transfer/Transfer.java +++ b/source/java/org/alfresco/repo/transfer/Transfer.java @@ -70,7 +70,7 @@ public class Transfer } /** - * @param target + * @param target TransferTarget */ public void setTransferTarget(TransferTarget target) { diff --git a/source/java/org/alfresco/repo/transfer/TransferCommons.java b/source/java/org/alfresco/repo/transfer/TransferCommons.java index 7a40b8ccab..ddf76847e8 100644 --- a/source/java/org/alfresco/repo/transfer/TransferCommons.java +++ b/source/java/org/alfresco/repo/transfer/TransferCommons.java @@ -84,7 +84,7 @@ public class TransferCommons /** * Mapping between contentUrl and part name. * - * @param contentUrl + * @param contentUrl String * @return the part name */ public final static String URLToPartName(String contentUrl) diff --git a/source/java/org/alfresco/repo/transfer/TransferContext.java b/source/java/org/alfresco/repo/transfer/TransferContext.java index 2e04907b89..e07a6444c4 100644 --- a/source/java/org/alfresco/repo/transfer/TransferContext.java +++ b/source/java/org/alfresco/repo/transfer/TransferContext.java @@ -30,7 +30,7 @@ public class TransferContext private Map categoriesCache = new HashMap(); /** * - * @return + * @return Map */ public Map getManifestCategoriesCache() { diff --git a/source/java/org/alfresco/repo/transfer/TransferEventImpl.java b/source/java/org/alfresco/repo/transfer/TransferEventImpl.java index d5c36bb42f..a73024b87c 100644 --- a/source/java/org/alfresco/repo/transfer/TransferEventImpl.java +++ b/source/java/org/alfresco/repo/transfer/TransferEventImpl.java @@ -89,7 +89,7 @@ public abstract class TransferEventImpl implements TransferEvent /** * The position in the range - * @return + * @return long */ public long getPosition() { @@ -98,7 +98,7 @@ public abstract class TransferEventImpl implements TransferEvent /** * The maximum range - * @return + * @return long */ public long getRange() { diff --git a/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java b/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java index c31b791b20..2706ef1daf 100644 --- a/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java +++ b/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java @@ -90,9 +90,9 @@ public class TransferEventProcessor /** * - * @param data - * @param range - * @param position + * @param data ContentData + * @param range long + * @param position long */ public void sendContent(ContentData data, long range, long position) { @@ -110,8 +110,8 @@ public class TransferEventProcessor /** * - * @param range - * @param position + * @param range long + * @param position long */ public void sendSnapshot(long range, long position) { @@ -153,8 +153,8 @@ public class TransferEventProcessor /** * - * @param range - * @param position + * @param range long + * @param position long */ public void committing(long range, long position) { diff --git a/source/java/org/alfresco/repo/transfer/TransferFatalException.java b/source/java/org/alfresco/repo/transfer/TransferFatalException.java index d2f68c6e27..c76d524b87 100644 --- a/source/java/org/alfresco/repo/transfer/TransferFatalException.java +++ b/source/java/org/alfresco/repo/transfer/TransferFatalException.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -30,9 +30,9 @@ public class TransferFatalException extends TransferException private static final long serialVersionUID = 1022985703059592513L; /** - * @param msgId - * @param msgParams - * @param cause + * @param msgId String + * @param msgParams Object[] + * @param cause Throwable */ public TransferFatalException(String msgId, Object[] msgParams, Throwable cause) { @@ -40,8 +40,8 @@ public class TransferFatalException extends TransferException } /** - * @param msgId - * @param msgParams + * @param msgId String + * @param msgParams Object[] */ public TransferFatalException(String msgId, Object[] msgParams) { @@ -49,8 +49,8 @@ public class TransferFatalException extends TransferException } /** - * @param msgId - * @param cause + * @param msgId String + * @param cause Throwable */ public TransferFatalException(String msgId, Throwable cause) { @@ -58,7 +58,7 @@ public class TransferFatalException extends TransferException } /** - * @param msgId + * @param msgId String */ public TransferFatalException(String msgId) { diff --git a/source/java/org/alfresco/repo/transfer/TransferProcessingException.java b/source/java/org/alfresco/repo/transfer/TransferProcessingException.java index 24c434a7e3..85abf7ff30 100644 --- a/source/java/org/alfresco/repo/transfer/TransferProcessingException.java +++ b/source/java/org/alfresco/repo/transfer/TransferProcessingException.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -33,9 +33,9 @@ public class TransferProcessingException extends TransferException private static final long serialVersionUID = 2547803698674661069L; /** - * @param msgId - * @param msgParams - * @param cause + * @param msgId String + * @param msgParams Object[] + * @param cause Throwable */ public TransferProcessingException(String msgId, Object[] msgParams, Throwable cause) { @@ -43,8 +43,8 @@ public class TransferProcessingException extends TransferException } /** - * @param msgId - * @param msgParams + * @param msgId String + * @param msgParams Object[] */ public TransferProcessingException(String msgId, Object[] msgParams) { @@ -52,8 +52,8 @@ public class TransferProcessingException extends TransferException } /** - * @param msgId - * @param cause + * @param msgId String + * @param cause Throwable */ public TransferProcessingException(String msgId, Throwable cause) { @@ -61,7 +61,7 @@ public class TransferProcessingException extends TransferException } /** - * @param msgId + * @param msgId String */ public TransferProcessingException(String msgId) { diff --git a/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java b/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java index 8c61bb1ce4..403c9382b0 100644 --- a/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java +++ b/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java @@ -38,35 +38,35 @@ public interface TransferProgressMonitor { /** * log an ad-hoc message - * @param transferId - * @param obj + * @param transferId String + * @param obj Object * @throws TransferException */ void logComment(String transferId, Object obj) throws TransferException; /** * log an ad-hoc message and an exception - * @param transferId - * @param obj - * @param ex + * @param transferId String + * @param obj Object + * @param ex Throwable * @throws TransferException */ void logException(String transferId, Object obj, Throwable ex) throws TransferException; /** * Log the creation of a new node - * @param transferId - * @param sourceNode - * @param destNode - * @param newPath - * @param orphan + * @param transferId String + * @param sourceNode NodeRef + * @param destNode NodeRef + * @param newPath String + * @param orphan boolean */ void logCreated(String transferId, NodeRef sourceNode, NodeRef destNode, NodeRef newParent, String newPath, boolean orphan); /** * Log the creation of a new node - * @param transferId - * @param sourceNode - * @param destNode + * @param transferId String + * @param sourceNode NodeRef + * @param destNode NodeRef * @param path The path of the updated node */ void logUpdated(String transferId, NodeRef sourceNode, NodeRef destNode, String path); @@ -74,50 +74,53 @@ public interface TransferProgressMonitor /** * Log the deletion of a node - * @param transferId - * @param sourceNode - * @param destNode + * @param transferId String + * @param sourceNode NodeRef + * @param destNode NodeRef * @param path The path of the deleted node */ void logDeleted(String transferId, NodeRef sourceNode, NodeRef destNode, String path); /** * After the transfer has completed this method reads the log. - * @param transferId - * @return the log + * @param transferId String + * @param sourceNodeRef NodeRef + * @param destNodeRef NodeRef + * @param oldPath String + * @param newParent NodeRef + * @param newPath String */ - void logMoved(String transferId, NodeRef sourceNodeRef, NodeRef destNodeRef, String oldPath, NodeRef newParent, String newPath); /** * update the progress of the specified transfer - * @param transferId - * @param currPos + * @param transferId String + * @param currPos int * @throws TransferException */ void updateProgress(String transferId, int currPos) throws TransferException; /** * update the progress of the specified transfer and possibly change the end position. - * @param transferId - * @param currPos - * @param endPos + * @param transferId String + * @param currPos int + * @param endPos int * @throws TransferException */ void updateProgress(String transferId, int currPos, int endPos) throws TransferException; /** * update the startus of the transfer - * @param transferId - * @param status + * @param transferId String + * @param status TransferProgress.Status * @throws TransferException */ void updateStatus(String transferId, TransferProgress.Status status) throws TransferException; /** * Read the progress of the - * @param transferId + * @param transferId String * @return the progress of the transfer * @throws TransferException */ diff --git a/source/java/org/alfresco/repo/transfer/TransferServiceImpl2.java b/source/java/org/alfresco/repo/transfer/TransferServiceImpl2.java index d25dee7bdd..af250ee66a 100644 --- a/source/java/org/alfresco/repo/transfer/TransferServiceImpl2.java +++ b/source/java/org/alfresco/repo/transfer/TransferServiceImpl2.java @@ -310,8 +310,8 @@ public class TransferServiceImpl2 implements TransferService2 /** * Given the noderef of a group of transfer targets, return all the contained transfer targets. - * @param groupNode - * @return + * @param groupNode NodeRef + * @return Set */ private Set getTransferTargets(NodeRef groupNode) { @@ -419,9 +419,9 @@ public class TransferServiceImpl2 implements TransferService2 /** * Transfer async. * - * @param targetName - * @param definition - * @param callbacks + * @param targetName String + * @param definition TransferDefinition + * @param callbacks TransferCallback... * */ public void transferAsync(String targetName, TransferDefinition definition, TransferCallback... callbacks) @@ -432,9 +432,9 @@ public class TransferServiceImpl2 implements TransferService2 /** * Transfer async. * - * @param targetName - * @param definition - * @param callbacks + * @param targetName String + * @param definition TransferDefinition + * @param callbacks Collection * */ public void transferAsync(String targetName, TransferDefinition definition, Collection callbacks) @@ -504,9 +504,9 @@ public class TransferServiceImpl2 implements TransferService2 /** * Transfer Synchronous * - * @param targetName - * @param definition - * @param callbacks + * @param targetName String + * @param definition TransferDefinition + * @param callbacks TransferCallback... */ public TransferEndEvent transfer(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferFailureException @@ -517,9 +517,9 @@ public class TransferServiceImpl2 implements TransferService2 /** * Transfer Synchronous * - * @param targetName - * @param definition - * @param callbacks + * @param targetName String + * @param definition TransferDefinition + * @param callbacks Collection */ public TransferEndEvent transfer(String targetName, TransferDefinition definition, Collection callbacks) throws TransferFailureException @@ -1125,7 +1125,7 @@ public class TransferServiceImpl2 implements TransferService2 /** * Check whether the specified transfer should be cancelled. - * @param transferHandle + * @param transferHandle String * @throws TransferException - the transfer has been cancelled. */ private void checkCancel(String transferHandle) throws TransferException @@ -1230,8 +1230,8 @@ public class TransferServiceImpl2 implements TransferService2 /** * - * @param name - * @return + * @param name String + * @return NodeRef */ private NodeRef lookupTransferTarget(String name) { @@ -1308,7 +1308,7 @@ public class TransferServiceImpl2 implements TransferService2 /** * Utility to dump the contents of a file to the console - * @param file + * @param file File */ private static void outputFile(File file) throws IOException { diff --git a/source/java/org/alfresco/repo/transfer/TransferSummaryReport.java b/source/java/org/alfresco/repo/transfer/TransferSummaryReport.java index 89496eab1e..b2ab6eaf7c 100644 --- a/source/java/org/alfresco/repo/transfer/TransferSummaryReport.java +++ b/source/java/org/alfresco/repo/transfer/TransferSummaryReport.java @@ -20,53 +20,49 @@ public interface TransferSummaryReport /** * Log the creation of a new node - * - * @param transferId - * @param sourceNode - * @param destNode - * @param newPath - * @param orphan + * + * @param sourceNode NodeRef + * @param destNode NodeRef + * @param newParent NodeRef + * @param newPath String + * @param orphan boolean */ void logSummaryCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParent, String newPath, boolean orphan); /** * Log the creation of a new node - * - * @param transferId - * @param sourceNode - * @param destNode - * @param path - * The path of the updated node - * @param orphan + * + * @param sourceNode NodeRef + * @param destNode NodeRef + * @param path The path of the updated node */ void logSummaryUpdated(NodeRef sourceNode, NodeRef destNode, String path); /** * Log the deletion of a node * - * @param transferId - * @param sourceNode - * @param destNode - * @param path - * The path of the deleted node - * @param orphan + * @param sourceNode NodeRef + * @param destNode NodeRef + * @param path The path of the updated node */ void logSummaryDeleted(NodeRef sourceNode, NodeRef destNode, String path); /** * After the transfer has completed this method reads the log. - * - * @param transferId - * @return the log + * + * @param sourceNodeRef NodeRef + * @param destNodeRef NodeRef + * @param oldPath String + * @param newParent NodeRef + * @param newPath String + * */ - void logSummaryMoved(NodeRef sourceNodeRef, NodeRef destNodeRef, String oldPath, NodeRef newParent, String newPath); /** * log an ad-hoc message * - * @param transferId - * @param obj + * @param obj Object * @throws TransferException */ void logSummaryComment(Object obj) throws TransferException; @@ -74,9 +70,8 @@ public interface TransferSummaryReport /** * log an ad-hoc message and an exception * - * @param transferId - * @param obj - * @param ex + * @param obj Object + * @param ex Throwable * @throws TransferException */ void logSummaryException(Object obj, Throwable ex) throws TransferException; @@ -84,8 +79,7 @@ public interface TransferSummaryReport /** * update the status of the transfer * - * @param transferId - * @param status + * @param status TransferProgress.Status * @throws TransferException */ void logSummaryUpdateStatus(TransferProgress.Status status) throws TransferException; diff --git a/source/java/org/alfresco/repo/transfer/TransferTransmitter.java b/source/java/org/alfresco/repo/transfer/TransferTransmitter.java index cf5c182b46..e6f1617559 100644 --- a/source/java/org/alfresco/repo/transfer/TransferTransmitter.java +++ b/source/java/org/alfresco/repo/transfer/TransferTransmitter.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -37,7 +37,7 @@ public interface TransferTransmitter { /** * Verify that the target is available - * @param target + * @param target TransferTarget * @throws TransferException */ void verifyTarget(TransferTarget target) throws TransferException; @@ -55,11 +55,10 @@ public interface TransferTransmitter Transfer begin(TransferTarget target, String fromRepositoryId, TransferVersion fromVersion) throws TransferException; /** - * @param manifest, the transfer manifest file + * @param manifest the transfer manifest file * @param transfer the transfer object returned by an earlier call to begin * @param results - where to write the results, probably a temporary file the output steam should be * open and will be closed before the method returns. - * @return the transfer requisite. * @throws TransferException */ void sendManifest(Transfer transfer, File manifest, OutputStream results) throws TransferException; diff --git a/source/java/org/alfresco/repo/transfer/TransferVersionImpl.java b/source/java/org/alfresco/repo/transfer/TransferVersionImpl.java index 42942f7015..2ab642458b 100644 --- a/source/java/org/alfresco/repo/transfer/TransferVersionImpl.java +++ b/source/java/org/alfresco/repo/transfer/TransferVersionImpl.java @@ -30,10 +30,10 @@ public class TransferVersionImpl implements TransferVersion /** * - * @param versionMajor - * @param versionMinor - * @param versionRevision - * @param edition + * @param versionMajor String + * @param versionMinor String + * @param versionRevision String + * @param edition String */ public TransferVersionImpl(String versionMajor, String versionMinor, String versionRevision, String edition) { diff --git a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeHelper.java b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeHelper.java index 7e9c8c6126..6f35594d36 100644 --- a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeHelper.java +++ b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeHelper.java @@ -56,7 +56,7 @@ public class TransferManifestNodeHelper /** * Gets the content properties for a node * @param node the node to process - * @return + * @return Set */ public static Set getContentData(TransferManifestNormalNode node) { diff --git a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestProcessor.java b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestProcessor.java index 93c5f5361c..eed9b43d7f 100644 --- a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestProcessor.java +++ b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestProcessor.java @@ -38,19 +38,19 @@ public interface TransferManifestProcessor /** * Gives the header to be proceessed - * @param header, the header + * @param header the header */ public void processTransferManifiestHeader(TransferManifestHeader header); /** * Gives a manifest node to be processed - * @param node, the node + * @param node the node */ public void processTransferManifestNode(TransferManifestNormalNode node); /** * Gives a deleted manifest node to be processed - * @param node, the node + * @param node the node */ public void processTransferManifestNode(TransferManifestDeletedNode node); diff --git a/source/java/org/alfresco/repo/transfer/package-info.java b/source/java/org/alfresco/repo/transfer/package-info.java index 3b90fbcbc7..4ee8378830 100644 --- a/source/java/org/alfresco/repo/transfer/package-info.java +++ b/source/java/org/alfresco/repo/transfer/package-info.java @@ -2,10 +2,10 @@ * Provides the implementation of the transfer service which can be used to * transfer nodes from one repository to another. * - * @See org.alfresco.service.cmr.transfer.TransferService + * @see org.alfresco.service.cmr.transfer.TransferService * * @since 3.3 */ -@PackageMarker -package org.alfresco.repo.transfer; +@PackageMarker +package org.alfresco.repo.transfer; import org.alfresco.util.PackageMarker; diff --git a/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java b/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java index 6b4056b123..87361a3450 100644 --- a/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java +++ b/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java @@ -51,7 +51,7 @@ public class ScriptTransferService extends BaseScopableProcessorExtension private List excludedAspects = new ArrayList(); /** - * @param transferService + * @param transferService TransferService */ public void setTransferService(TransferService transferService) { @@ -60,7 +60,7 @@ public class ScriptTransferService extends BaseScopableProcessorExtension /** * - * @return + * @return TransferService */ public TransferService getTransferService() { diff --git a/source/java/org/alfresco/repo/usage/ContentUsageImpl.java b/source/java/org/alfresco/repo/usage/ContentUsageImpl.java index a0949b3cf0..2ff9617b7f 100644 --- a/source/java/org/alfresco/repo/usage/ContentUsageImpl.java +++ b/source/java/org/alfresco/repo/usage/ContentUsageImpl.java @@ -396,13 +396,13 @@ public class ContentUsageImpl implements ContentUsageService, recordDelete(nodeRef); } } - } - } - - /* - * Called after an cm:ownable aspect has been added to a node - * - * @param nodeRef the node to which the aspect was added + } + } + + /* + * Called after an cm:ownable aspect has been added to a node + * + * @param nodeRef the node to which the aspect was added * @param aspectTypeQName the type of the aspect */ /* NOTE: now handled via onUpdateProperties as expected @@ -498,13 +498,13 @@ public class ContentUsageImpl implements ContentUsageService, } } - /** - * Set user's usage. Should only be called by background (collapse) job ! - * - * @param personNodeRef person nodeRef - * @param currentUsage - */ - public void setUserStoredUsage(NodeRef personNodeRef, long currentUsage) + /** + * Set user's usage. Should only be called by background (collapse) job ! + * + * @param personNodeRef person nodeRef + * @param currentUsage long + */ + public void setUserStoredUsage(NodeRef personNodeRef, long currentUsage) { if (personNodeRef != null) { @@ -565,15 +565,15 @@ public class ContentUsageImpl implements ContentUsageService, return currentUsage; } - /** - * Set user's current quota. - * Usually called by Web Client (Admin Console) if admin is changing/setting a user's quota. - * - * @param userName user name - * @param currentQuota User's new quota (in bytes) - */ - public void setUserQuota(String userName, long currentQuota) - { + /** + * Set user's current quota. + * Usually called by Web Client (Admin Console) if admin is changing/setting a user's quota. + * + * @param userName user name + * @param currentQuota User's new quota (in bytes) + */ + public void setUserQuota(String userName, long currentQuota) + { NodeRef personNodeRef = getPerson(userName); if (personNodeRef != null) { diff --git a/source/java/org/alfresco/repo/usage/RepoUsageComponent.java b/source/java/org/alfresco/repo/usage/RepoUsageComponent.java index 414c69548a..06a42b5377 100644 --- a/source/java/org/alfresco/repo/usage/RepoUsageComponent.java +++ b/source/java/org/alfresco/repo/usage/RepoUsageComponent.java @@ -94,13 +94,13 @@ public interface RepoUsageComponent * some other client was already performing the same reset */ boolean resetUsage(UsageType usageType); - - /** - * Get the current repository usage data. This will not trigger an update of the data if it - * is not available; only {@link #updateUsage(UsageType) pre-loaded data} will be used. - * - * @return Returns the repository-specific current usage data. - */ + + /** + * Get the current repository usage data. This will not trigger an update of the data if it + * is not available; only pre-loaded data will be used. + * + * @return Returns the repository-specific current usage data. + */ RepoUsage getUsage(); /** diff --git a/source/java/org/alfresco/repo/version/VersionRevertCallback.java b/source/java/org/alfresco/repo/version/VersionRevertCallback.java index dedf676fdb..50ef6f60f9 100644 --- a/source/java/org/alfresco/repo/version/VersionRevertCallback.java +++ b/source/java/org/alfresco/repo/version/VersionRevertCallback.java @@ -51,8 +51,8 @@ public interface VersionRevertCallback /** * How should the specified aspect be reverted? * - * @param aspectName, the name of the aspect to revert - * @param details, details of the aspect to revert + * @param aspectName the name of the aspect to revert + * @param details details of the aspect to revert * */ public RevertAspectAction getRevertAspectAction(QName aspectName, VersionRevertDetails details); @@ -76,8 +76,8 @@ public interface VersionRevertCallback /** * How should the specified assoc be reverted? * - * @param assocName, the name of the assoc to revert - * @param details, details of the node to revert + * @param assocName the name of the assoc to revert + * @param details details of the node to revert * */ public RevertAssocAction getRevertAssocAction(QName assocName, VersionRevertDetails details); diff --git a/source/java/org/alfresco/repo/version/VersionServiceImpl.java b/source/java/org/alfresco/repo/version/VersionServiceImpl.java index b2408fe283..b0c4b0c55c 100644 --- a/source/java/org/alfresco/repo/version/VersionServiceImpl.java +++ b/source/java/org/alfresco/repo/version/VersionServiceImpl.java @@ -162,8 +162,8 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl /** * Register version label policy for the specified type * - * @param typeQName - * @param policy + * @param typeQName QName + * @param policy CalculateVersionLabelPolicy */ public void registerVersionLabelPolicy(QName typeQName, CalculateVersionLabelPolicy policy) { @@ -1006,7 +1006,7 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl } /** - * @see org.alfresco.cms.version.VersionService#revert(NodeRef) + * @see org.alfresco.service.cmr.version.VersionService#revert(NodeRef) */ public void revert(NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/version/VersionableAspect.java b/source/java/org/alfresco/repo/version/VersionableAspect.java index 89def120b4..38808b1502 100644 --- a/source/java/org/alfresco/repo/version/VersionableAspect.java +++ b/source/java/org/alfresco/repo/version/VersionableAspect.java @@ -272,7 +272,7 @@ public class VersionableAspect implements ContentServicePolicies.OnContentUpdate } /** - * @return Returns the {@link VersionableAspectCopyBehaviourCallback} + * @return Returns the CopyBehaviourCallback */ public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails) { @@ -327,8 +327,8 @@ public class VersionableAspect implements ContentServicePolicies.OnContentUpdate /** * Before add aspect policy behaviour * - * @param nodeRef - * @param aspectTypeQName + * @param nodeRef NodeRef + * @param aspectTypeQName QName */ public void beforeAddAspect(final NodeRef nodeRef, QName aspectTypeQName) { @@ -352,8 +352,8 @@ public class VersionableAspect implements ContentServicePolicies.OnContentUpdate /** * On add aspect policy behaviour * - * @param nodeRef - * @param aspectTypeQName + * @param nodeRef NodeRef + * @param aspectTypeQName QName */ public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName) { @@ -519,8 +519,8 @@ public class VersionableAspect implements ContentServicePolicies.OnContentUpdate /** * On create version implementation method * - * @param nodeRef - * @param versionProperties + * @param nodeRef NodeRef + * @param versionProperties Map */ private void createVersionImpl(NodeRef nodeRef, Map versionProperties) { diff --git a/source/java/org/alfresco/repo/version/common/AbstractVersionServiceImpl.java b/source/java/org/alfresco/repo/version/common/AbstractVersionServiceImpl.java index 7c29654404..c54c849bea 100644 --- a/source/java/org/alfresco/repo/version/common/AbstractVersionServiceImpl.java +++ b/source/java/org/alfresco/repo/version/common/AbstractVersionServiceImpl.java @@ -195,8 +195,8 @@ public abstract class AbstractVersionServiceImpl /** * How should revert deal with this aspect? - * @param aspectName - * @param revertDetails + * @param aspectName QName + * @param revertDetails VersionRevertDetails * @return the action to be taken */ protected RevertAspectAction getRevertAspectAction(QName aspectName, VersionRevertDetails revertDetails) @@ -221,9 +221,9 @@ public abstract class AbstractVersionServiceImpl /** * How should revert deal with this association - * @param className - * @param assocName - * @param revertDetails + * @param className QName + * @param assocName QName + * @param revertDetails VersionRevertDetails * @return the action to be taken */ protected RevertAssocAction getRevertAssocAction(QName className, QName assocName, VersionRevertDetails revertDetails) @@ -249,10 +249,10 @@ public abstract class AbstractVersionServiceImpl /** * Invokes the on create version policy behaviour for a given type * - * @param classRef - * @param nodeDetails - * @param nodeRef - * @param versionProperties + * @param classRef QName + * @param nodeDetails NodeRef + * @param nodeRef Map + * @param versionProperties PolicyScope */ private void invokeOnCreateVersion( QName classRef, @@ -283,9 +283,10 @@ public abstract class AbstractVersionServiceImpl * Default implementation of the on create version policy. * Override if you wish to supply your own policy. * - * @param nodeRef - * @param versionProperties - * @param nodeDetails + * @param classRef QName + * @param nodeRef NodeRef + * @param versionProperties Map + * @param nodeDetails PolicyScope */ abstract protected void defaultOnCreateVersion( QName classRef, @@ -296,11 +297,11 @@ public abstract class AbstractVersionServiceImpl /** * Invoke the calculate version label policy behaviour * - * @param classRef - * @param preceedingVersion - * @param versionNumber - * @param versionProperties - * @return + * @param classRef QName + * @param preceedingVersion Version + * @param versionNumber int + * @param versionProperties Map + * @return String */ protected String invokeCalculateVersionLabel( QName classRef, diff --git a/source/java/org/alfresco/repo/version/common/VersionHistoryImpl.java b/source/java/org/alfresco/repo/version/common/VersionHistoryImpl.java index 52ae444826..264d8c9659 100644 --- a/source/java/org/alfresco/repo/version/common/VersionHistoryImpl.java +++ b/source/java/org/alfresco/repo/version/common/VersionHistoryImpl.java @@ -130,7 +130,7 @@ public class VersionHistoryImpl implements VersionHistory /** * Sorts Versions into descending create date order (most recent first). * @param versions Must be in order addVersion was called. - * @return + * @return Collection */ private Collection sortDescending(Collection versions) { diff --git a/source/java/org/alfresco/repo/version/common/VersionUtil.java b/source/java/org/alfresco/repo/version/common/VersionUtil.java index 8185329236..3394eb7854 100644 --- a/source/java/org/alfresco/repo/version/common/VersionUtil.java +++ b/source/java/org/alfresco/repo/version/common/VersionUtil.java @@ -67,7 +67,6 @@ public class VersionUtil * with the reserved properties. * * @param names the property names - * @return true is the names are considered valid, false otherwise * @throws ReservedVersionNameException */ public static void checkVersionPropertyNames(Collection names) diff --git a/source/java/org/alfresco/repo/webdav/LockInfo.java b/source/java/org/alfresco/repo/webdav/LockInfo.java index beb5bef760..8bb232b771 100644 --- a/source/java/org/alfresco/repo/webdav/LockInfo.java +++ b/source/java/org/alfresco/repo/webdav/LockInfo.java @@ -57,7 +57,7 @@ public interface LockInfo /** * Setter for lock scope. * - * @param scope + * @param scope String */ void setScope(String scope); @@ -92,7 +92,7 @@ public interface LockInfo /** * Setter for sharedLockTokens list. * - * @param sharedLockTokens + * @param sharedLockTokens Set */ void setSharedLockTokens(Set sharedLockTokens); @@ -168,18 +168,18 @@ public interface LockInfo long getRemainingTimeoutSeconds(); /** - * Sets the expiry date/time to lockTimeout seconds into the future. Provide - * a lockTimeout of WebDAV.TIMEOUT_INFINITY for never expires. - * - * @param lockTimeoutSecs - */ - void setTimeoutSeconds(int lockTimeoutSecs); - + * Sets the expiry date/time to lockTimeout seconds into the future. Provide + * a lockTimeout of WebDAV.TIMEOUT_INFINITY for never expires. + * + * @param lockTimeoutSecs int + */ + void setTimeoutSeconds(int lockTimeoutSecs); + /** * Sets the expiry date/time to lockTimeout minutes into the future. Provide * a lockTimeout of WebDAV.TIMEOUT_INFINITY for never expires. * - * @param lockTimeoutMins + * @param lockTimeoutMins int */ void setTimeoutMinutes(int lockTimeoutMins); } \ No newline at end of file diff --git a/source/java/org/alfresco/repo/webdav/MTNodesCache2.java b/source/java/org/alfresco/repo/webdav/MTNodesCache2.java index ecb2fcb6ef..4368ce508b 100644 --- a/source/java/org/alfresco/repo/webdav/MTNodesCache2.java +++ b/source/java/org/alfresco/repo/webdav/MTNodesCache2.java @@ -147,7 +147,6 @@ public class MTNodesCache2 /** * @return Returns the name of the store - * @throws ServletException if the store name was not set */ public String getStoreName() { @@ -161,7 +160,6 @@ public class MTNodesCache2 /** * @return Returns the WebDAV root path within the store - * @throws ServletException if the root path was not set */ public String getRootPath() { diff --git a/source/java/org/alfresco/repo/webdav/WebDavServiceImpl.java b/source/java/org/alfresco/repo/webdav/WebDavServiceImpl.java index 42fbd54af0..088536cf11 100644 --- a/source/java/org/alfresco/repo/webdav/WebDavServiceImpl.java +++ b/source/java/org/alfresco/repo/webdav/WebDavServiceImpl.java @@ -38,7 +38,7 @@ import org.springframework.extensions.surf.util.URLEncoder; *

      * This is a bog standard spring bean for the repo side of WebDav. * - * @See org.alfresco.repo.webdav.WebDavServlet the server side of webdav. + * @link org.alfresco.repo.webdav.WebDavServlet the server side of webdav. * * @author mrogers */ diff --git a/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java b/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java index 7423a3ef98..730cb4e1f6 100644 --- a/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java +++ b/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java @@ -43,12 +43,12 @@ public abstract class AbstractWorkflowPropertyHandler implements WorkflowPropert private static final TypeConverter typeConverter = DefaultTypeConverter.INSTANCE; protected WorkflowNodeConverter nodeConverter; - protected MessageService messageService; - - /** - * @param value - * @param assocDef - */ + protected MessageService messageService; + + /** + * @param value Serializable + * @param assocDef AssociationDefinition + */ protected Object handleAssociation(Serializable value, AssociationDefinition assocDef) { if (assocDef.isProtected()) @@ -57,12 +57,12 @@ public abstract class AbstractWorkflowPropertyHandler implements WorkflowPropert } // Convert association to ActivitiScriptNode / List return convertAssociationValue(assocDef, value); - } - - /** - * @param value - * @param propDef - * @return + } + + /** + * @param value Serializable + * @param propDef PropertyDefinition + * @return Object */ protected Object handleProperty(Serializable value, PropertyDefinition propDef) { @@ -112,7 +112,7 @@ public abstract class AbstractWorkflowPropertyHandler implements WorkflowPropert /** * Register this WorkflowPropertyHandler with the provided registry. - * @param registry + * @param registry WorkflowPropertyHandlerRegistry */ public void setRegistry(WorkflowPropertyHandlerRegistry registry) { diff --git a/source/java/org/alfresco/repo/workflow/AlfrescoBpmEngine.java b/source/java/org/alfresco/repo/workflow/AlfrescoBpmEngine.java index 9b092c1724..80c9d463d1 100644 --- a/source/java/org/alfresco/repo/workflow/AlfrescoBpmEngine.java +++ b/source/java/org/alfresco/repo/workflow/AlfrescoBpmEngine.java @@ -66,7 +66,7 @@ public abstract class AlfrescoBpmEngine extends BPMEngine /** * Sets the Tenant Service * - * @param tenantService + * @param tenantService TenantService */ public void setTenantService(TenantService tenantService) { @@ -76,7 +76,7 @@ public abstract class AlfrescoBpmEngine extends BPMEngine /** * Sets the Message Service * - * @param messageService + * @param messageService MessageService */ public void setMessageService(MessageService messageService) { @@ -86,7 +86,7 @@ public abstract class AlfrescoBpmEngine extends BPMEngine /** * Sets the Namespace Service * - * @param namespaceService + * @param namespaceService NamespaceService */ public void setNamespaceService(NamespaceService namespaceService) { diff --git a/source/java/org/alfresco/repo/workflow/BPMEngineRegistry.java b/source/java/org/alfresco/repo/workflow/BPMEngineRegistry.java index ab1ab9c40c..d07db3a3bd 100644 --- a/source/java/org/alfresco/repo/workflow/BPMEngineRegistry.java +++ b/source/java/org/alfresco/repo/workflow/BPMEngineRegistry.java @@ -238,9 +238,9 @@ public class BPMEngineRegistry * Returns true if the globalId parameter is a valid global Id * for the given engineId. * - * @param globalId - * @param engineId - * @return + * @param globalId String + * @param engineId String + * @return boolean */ public static boolean isGlobalId(String globalId, String engineId) { diff --git a/source/java/org/alfresco/repo/workflow/PackageManager.java b/source/java/org/alfresco/repo/workflow/PackageManager.java index 077be7478c..3d7b85a0fb 100644 --- a/source/java/org/alfresco/repo/workflow/PackageManager.java +++ b/source/java/org/alfresco/repo/workflow/PackageManager.java @@ -90,7 +90,7 @@ public class PackageManager * Takes a comma-separated list of {@link NodeRef} ids and adds the * specified NodeRefs to the package. * - * @param items + * @param items String */ public void addItems(String items) { @@ -125,7 +125,7 @@ public class PackageManager * Takes a comma-separated list of {@link NodeRef} ids and adds the * specified NodeRefs to the package. * - * @param items + * @param items String */ public void removeItems(String items) { @@ -155,7 +155,7 @@ public class PackageManager * Creates a new Workflow package using the specified container. * If the container is null then a new container node is created. * Applies the specified updates to the package after it is created. - * @param container + * @param container NodeRef * @return the package {@link NodeRef}. * @throws WorkflowException if the specified container is already package. */ @@ -168,7 +168,7 @@ public class PackageManager /** * Applies the specified modifications to the package. - * @param packageRef + * @param packageRef NodeRef */ public void update(final NodeRef packageRef) { diff --git a/source/java/org/alfresco/repo/workflow/StartWorkflowActionExecuter.java b/source/java/org/alfresco/repo/workflow/StartWorkflowActionExecuter.java index 23ee8883a3..08c608cdda 100644 --- a/source/java/org/alfresco/repo/workflow/StartWorkflowActionExecuter.java +++ b/source/java/org/alfresco/repo/workflow/StartWorkflowActionExecuter.java @@ -57,7 +57,7 @@ public class StartWorkflowActionExecuter extends ActionExecuterAbstractBase /** - * @param namespaceService + * @param namespaceService NamespaceService */ public void setNamespaceService(NamespaceService namespaceService) { @@ -65,7 +65,7 @@ public class StartWorkflowActionExecuter extends ActionExecuterAbstractBase } /** - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -73,7 +73,7 @@ public class StartWorkflowActionExecuter extends ActionExecuterAbstractBase } /** - * @param workflowService + * @param workflowService WorkflowService */ public void setWorkflowService(WorkflowService workflowService) { diff --git a/source/java/org/alfresco/repo/workflow/TaskComponent.java b/source/java/org/alfresco/repo/workflow/TaskComponent.java index e32bb0285b..f1ff21876a 100644 --- a/source/java/org/alfresco/repo/workflow/TaskComponent.java +++ b/source/java/org/alfresco/repo/workflow/TaskComponent.java @@ -114,7 +114,7 @@ public interface TaskComponent /** * Suspend the specified Task * - * @param taskId + * @param taskId String * @return the update task */ public WorkflowTask suspendTask(String taskId); diff --git a/source/java/org/alfresco/repo/workflow/TaskUpdater.java b/source/java/org/alfresco/repo/workflow/TaskUpdater.java index c5864e80f3..6c0c1501fd 100644 --- a/source/java/org/alfresco/repo/workflow/TaskUpdater.java +++ b/source/java/org/alfresco/repo/workflow/TaskUpdater.java @@ -98,8 +98,8 @@ public class TaskUpdater } /** - * @param isAdd - * @return + * @param isAdd boolean + * @return Map */ private Map> getAssociationMap(boolean isAdd) { diff --git a/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java b/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java index 0bbdd2396f..1f98d6c4c1 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java @@ -39,7 +39,7 @@ public class WorkflowAuthorityManager /** * Convert Alfresco authority to user id * - * @param authority + * @param authority NodeRef * @return actor id */ public String mapAuthorityToName(NodeRef authority) diff --git a/source/java/org/alfresco/repo/workflow/WorkflowComponent.java b/source/java/org/alfresco/repo/workflow/WorkflowComponent.java index 2fdd814899..778a119990 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowComponent.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowComponent.java @@ -189,7 +189,7 @@ public interface WorkflowComponent /** * Gets all "in-flight" workflow instances according to the specified workflowInstanceQuery parameter * - * @param workflowInstanceQuery + * @param workflowInstanceQuery WorkflowInstanceQuery * @return the list of "in-flight" workflow instances */ public List getWorkflows(WorkflowInstanceQuery workflowInstanceQuery); @@ -197,9 +197,9 @@ public interface WorkflowComponent /** * Gets maxItems "in-flight" workflow instances according to the specified workflowInstanceQuery parameter * - * @param workflowInstanceQuery - * @param maxItems - * @param skipCount + * @param workflowInstanceQuery WorkflowInstanceQuery + * @param maxItems int + * @param skipCount int * @return maxItems workflow instances */ public List getWorkflows(WorkflowInstanceQuery workflowInstanceQuery, int maxItems, int skipCount); @@ -207,7 +207,7 @@ public interface WorkflowComponent /** * Get count of workflow instances * - * @param workflowInstanceQuery + * @param workflowInstanceQuery WorkflowInstanceQuery * @return count of workflow instances */ public long countWorkflows(WorkflowInstanceQuery workflowInstanceQuery); diff --git a/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java b/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java index e970eae90d..6aa1386693 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java @@ -130,7 +130,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Set the authentication component * - * @param authenticationContext + * @param authenticationContext AuthenticationContext */ public void setAuthenticationContext(AuthenticationContext authenticationContext) { @@ -140,7 +140,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Sets the Dictionary DAO * - * @param dictionaryDAO + * @param dictionaryDAO DictionaryDAO */ public void setDictionaryDAO(DictionaryDAO dictionaryDAO) { @@ -170,7 +170,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Sets the Workflow Definitions * - * @param workflowDefinitions + * @param workflowDefinitions List */ public void setWorkflowDefinitions(List workflowDefinitions) { diff --git a/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java b/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java index 1f5f564bc6..d94528d019 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java @@ -33,8 +33,8 @@ public interface WorkflowNodeConverter { /** * Converts a {@link NodeRef} into the appropriate Node type. - * @param node - * @return + * @param node NodeRef + * @return Object */ Object convertNode(NodeRef node); @@ -44,16 +44,16 @@ public interface WorkflowNodeConverter * a {@link List} of the appropriate Node type is returned. Otherwise a * single instance of the appropriate Node type is returned. * - * @param value - * @param isMany - * @return + * @param value NodeRef + * @param isMany boolean + * @return Object */ Object convertNode(NodeRef value, boolean isMany); /** * Converts a {@link Collection} of {@link NodeRef}s into a {@link List} of the appropriate Node type. - * @param values - * @return + * @param values Collection + * @return List */ List convertNodes(Collection values); @@ -63,9 +63,9 @@ public interface WorkflowNodeConverter * a {@link List} of the appropriate Node type is returned. Otherwise a * single instance of the appropriate Node type is returned. * - * @param values - * @param isMany - * @return + * @param values Collection + * @param isMany boolean + * @return Object */ Object convertNodes(Collection values, boolean isMany); @@ -75,16 +75,16 @@ public interface WorkflowNodeConverter * a {@link List} of the appropriate Node type is returned. Otherwise a * single instance of the appropriate Node type is returned. - * @param value - * @param isMany - * @return + * @param value Object + * @param isMany boolean + * @return Object */ Object convertNodes(Object value, boolean isMany); /** * - * @param toConvert - * @return + * @param toConvert Object + * @return NodeRef */ NodeRef convertToNode(Object toConvert); @@ -101,8 +101,8 @@ public interface WorkflowNodeConverter * {@link List} of {@link NodeRef}s is returned. Otherwise a single * {@link NodeRef} is returned. * - * @param object - * @return + * @param object NodeRef + * @return Serializable */ Serializable convert(Object object); } diff --git a/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java b/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java index 21f6b500b5..3e4d01acc7 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java @@ -89,14 +89,14 @@ public class WorkflowNotificationUtils /** * - * @param taskId - * @param taskTitle - * @param description - * @param dueDate - * @param priority - * @param workflowPackage - * @param assignedAuthorites - * @param pooled + * @param taskId String + * @param taskTitle String + * @param description String + * @param dueDate Date + * @param priority Integer + * @param workflowPackage NodeRef + * @param assignedAuthorites String[] + * @param pooled boolean */ public void sendWorkflowAssignedNotificationEMail( String taskId, diff --git a/source/java/org/alfresco/repo/workflow/WorkflowPackageComponent.java b/source/java/org/alfresco/repo/workflow/WorkflowPackageComponent.java index df7d18ef99..d80359b497 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowPackageComponent.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowPackageComponent.java @@ -49,7 +49,7 @@ public interface WorkflowPackageComponent * The workflow package aspect is removed, and if the container was previously created by the workflow * service (i.e. not provided from elsewhere), it will be deleted. * - * @param container + * @param container NodeRef */ public void deletePackage(NodeRef container); diff --git a/source/java/org/alfresco/repo/workflow/WorkflowPropertyHandlerRegistry.java b/source/java/org/alfresco/repo/workflow/WorkflowPropertyHandlerRegistry.java index 9f2bb5cd8b..2a1e70f57d 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowPropertyHandlerRegistry.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowPropertyHandlerRegistry.java @@ -39,8 +39,8 @@ public class WorkflowPropertyHandlerRegistry private final WorkflowQNameConverter qNameConverter; /** - * @param defaultHandler - * @param qNameConverter + * @param defaultHandler WorkflowPropertyHandler + * @param qNameConverter WorkflowQNameConverter */ public WorkflowPropertyHandlerRegistry(WorkflowPropertyHandler defaultHandler, WorkflowQNameConverter qNameConverter) { diff --git a/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java b/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java index ba147ddf87..1ff84f7318 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java @@ -98,7 +98,7 @@ public class WorkflowServiceImpl implements WorkflowService /** * Sets the Authority Service * - * @param authorityService + * @param authorityService AuthorityService */ public void setAuthorityService(AuthorityService authorityService) { @@ -136,7 +136,7 @@ public class WorkflowServiceImpl implements WorkflowService /** * Sets the Node Service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -146,7 +146,7 @@ public class WorkflowServiceImpl implements WorkflowService /** * Sets the Content Service * - * @param contentService + * @param contentService ContentService */ public void setContentService(ContentService contentService) { @@ -156,7 +156,7 @@ public class WorkflowServiceImpl implements WorkflowService /** * Set the dictionary service * - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -166,7 +166,7 @@ public class WorkflowServiceImpl implements WorkflowService /** * Set the node service which applies permissions * - * @param protectedNodeService + * @param protectedNodeService NodeService */ public void setProtectedNodeService(NodeService protectedNodeService) { @@ -1346,7 +1346,7 @@ public class WorkflowServiceImpl implements WorkflowService * package is associated with the specified task then this method returns * null. * - * @param taskId + * @param taskId String * @return The workflow package NodeRef or null. */ private NodeRef getWorkflowPackageIfExists(String taskId) @@ -1357,7 +1357,7 @@ public class WorkflowServiceImpl implements WorkflowService } /** - * @param workflowPackage + * @param workflowPackage NodeRef */ private List getRepositoryPackageContents(NodeRef workflowPackage) { @@ -1395,7 +1395,7 @@ public class WorkflowServiceImpl implements WorkflowService * dcitionary. If the type is not in the data dictionary then the method * logs a warning and returns false. Otherwise it returns true. * - * @param nodeRef + * @param nodeRef NodeRef * @return True if the nodeRef type is in the data dictionary, otherwise * false. */ diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiTaskPropertyHandler.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiTaskPropertyHandler.java index 556e48ed6a..8f3f62aa6b 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/ActivitiTaskPropertyHandler.java +++ b/source/java/org/alfresco/repo/workflow/activiti/ActivitiTaskPropertyHandler.java @@ -50,10 +50,11 @@ public abstract class ActivitiTaskPropertyHandler extends AbstractWorkflowProper } /** - * @param type - * @param key - * @param value - * @return + * @param process Object + * @param type TypeDefinition + * @param key QName + * @param value Serializable + * @return Object */ private Object handleProcessPropert(Object process, TypeDefinition type, QName key, Serializable value) { @@ -62,21 +63,21 @@ public abstract class ActivitiTaskPropertyHandler extends AbstractWorkflowProper /** * Handles the property for a {@link Task}. - * @param task - * @param type - * @param key - * @param value - * @return + * @param task Task + * @param type TypeDefinition + * @param key QName + * @param value Serializable + * @return Object */ protected abstract Object handleTaskProperty(Task task, TypeDefinition type, QName key, Serializable value); /** * Handles the property for a {@link DelegateTask}. - * @param task - * @param value - * @param key - * @param type - * @return + * @param task DelegateTask + * @param value TypeDefinition + * @param key QName + * @param type Serializable + * @return Object */ protected abstract Object handleDelegateTaskProperty(DelegateTask task, TypeDefinition type, QName key, Serializable value); } diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java index 5755c6e58b..917bcdb9b1 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java +++ b/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java @@ -110,14 +110,14 @@ public class ActivitiTypeConverter /** * filters HistoricProcessInstances by domain - * including all instances for default domain - * and excluding shared instances (THOR-206) for tenants - * - * @param values - * @param processKeyGetter - * @return - */ - public List doSpecialTenantFilterAndSafeConvert(List values, Function processKeyGetter) + * including all instances for default domain + * and excluding shared instances (THOR-206) for tenants + * + * @param values List + * @param processKeyGetter Function + * @return List + */ + public List doSpecialTenantFilterAndSafeConvert(List values, Function processKeyGetter) { List filtered = factory.doSpecialTenantFilter(values, processKeyGetter); factory.setIgnoreTenantCheck(factory.isDefaultDomain()); @@ -134,8 +134,8 @@ public class ActivitiTypeConverter /** * Convert a {@link Deployment} into a {@link WorkflowDeployment}. - * @param deployment - * @return + * @param deployment Deployment + * @return WorkflowDeployment */ public WorkflowDeployment convert(Deployment deployment) { @@ -146,13 +146,13 @@ public class ActivitiTypeConverter WorkflowDefinition wfDef = convert(processDef); return factory.createDeployment(wfDef); } - - /** - * Convert a {@link ProcessDefinition} into a {@link WorkflowDefinition}. - * @param definition - * @return - */ - public WorkflowDefinition convert(ProcessDefinition definition) + + /** + * Convert a {@link ProcessDefinition} into a {@link WorkflowDefinition}. + * @param definition ProcessDefinition + * @return WorkflowDefinition + */ + public WorkflowDefinition convert(ProcessDefinition definition) { if(definition==null) return null; @@ -206,14 +206,14 @@ public class ActivitiTypeConverter return factory.createTaskDefinition(taskDefId, node, taskDefId, false); } - - /** - * Get the taskDefinition key based on the Activiti task definition id, - * @param taskDefinitionKey - * @param processDefinitionId - * @return - */ - public WorkflowTaskDefinition getTaskDefinition(String taskDefinitionKey, String processDefinitionId) + + /** + * Get the taskDefinition key based on the Activiti task definition id, + * @param taskDefinitionKey String + * @param processDefinitionId String + * @return WorkflowTaskDefinition + */ + public WorkflowTaskDefinition getTaskDefinition(String taskDefinitionKey, String processDefinitionId) { ProcessDefinitionEntity procDef = (ProcessDefinitionEntity) activitiUtil.getDeployedProcessDefinition(processDefinitionId); Collection userTasks = findUserTasks(procDef.getInitial()); @@ -314,10 +314,10 @@ public class ActivitiTypeConverter } /** - * @param activity - * @param key - * @param forceIsTaskNode - * @return + * @param activity PvmActivity + * @param key String + * @param forceIsTaskNode boolean + * @return WorkflowNode */ private WorkflowNode getNode(PvmActivity activity, String key, boolean forceIsTaskNode) { @@ -439,7 +439,7 @@ public class ActivitiTypeConverter /** * Converts the given task into a {@link WorkflowTask}, allows ignoring domain mismatch (ALF-12264) - * @param task + * @param task Task * @param ignoreDomainMismatch whether or not to ignore domain mismatch exception * @return the converter task. Returns null when the domain mismatched and ignoreDomainMismatch was true. */ diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiUtil.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiUtil.java index 7b87a4b144..474a048ee0 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/ActivitiUtil.java +++ b/source/java/org/alfresco/repo/workflow/activiti/ActivitiUtil.java @@ -193,7 +193,7 @@ public class ActivitiUtil } /** - * @return + * @return ManagementService */ public ManagementService getManagementService() { @@ -201,8 +201,8 @@ public class ActivitiUtil } /** - * @param localId - * @return + * @param localId String + * @return HistoricTaskInstance */ public HistoricTaskInstance getHistoricTaskInstance(String localId) { diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowEngine.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowEngine.java index 737ee23f6e..a4ffd6178d 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowEngine.java +++ b/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowEngine.java @@ -1031,8 +1031,8 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine } /** - * @param path - * @param instance + * @param path WorkflowPath + * @param instance ProcessInstance */ private void endStartTaskAutomatically(WorkflowPath path, ProcessInstance instance) { @@ -1127,7 +1127,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Converts the given list of {@link ProcessDefinition}s to a list of {@link WorkflowDefinition}s * that have a valid domain. - * @param definitions + * @param definitions List */ private List getValidWorkflowDefinitions(List definitions) { @@ -1143,7 +1143,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Converts the given list of {@link Task}s to a list of {@link WorkflowTask}s * that have a valid domain. - * @param tasks + * @param tasks List */ private List getValidWorkflowTasks(List tasks) { @@ -1163,7 +1163,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Converts the given list of {@link Task}s to a list of {@link WorkflowTask}s * that have a valid domain. - * @param tasks + * @param tasks List */ private List getValidHistoricTasks(List tasks) { @@ -1218,7 +1218,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Sets the Dictionary Service - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -1228,7 +1228,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Sets the Node Service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -1246,7 +1246,7 @@ public class ActivitiWorkflowEngine extends BPMEngine implements WorkflowEngine /** * Sets the Person Service * - * @param personService + * @param personService PersonService */ public void setPersonService(PersonService personService) { diff --git a/source/java/org/alfresco/repo/workflow/activiti/BaseExecutionListener.java b/source/java/org/alfresco/repo/workflow/activiti/BaseExecutionListener.java index 913eb2f54e..85422f4465 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/BaseExecutionListener.java +++ b/source/java/org/alfresco/repo/workflow/activiti/BaseExecutionListener.java @@ -57,7 +57,7 @@ public abstract class BaseExecutionListener implements ExecutionListener /** * Defaults to the full {@link Class} Name. - * @return + * @return String */ protected String getName() { diff --git a/source/java/org/alfresco/repo/workflow/activiti/BaseJavaDelegate.java b/source/java/org/alfresco/repo/workflow/activiti/BaseJavaDelegate.java index e300c51d42..44a9fcf691 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/BaseJavaDelegate.java +++ b/source/java/org/alfresco/repo/workflow/activiti/BaseJavaDelegate.java @@ -57,7 +57,7 @@ public abstract class BaseJavaDelegate implements JavaDelegate /** * Defaults to the full {@link Class} Name. - * @return + * @return String */ protected String getName() { diff --git a/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPooledActorsPropertyHandler.java b/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPooledActorsPropertyHandler.java index 464f34dced..044612a878 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPooledActorsPropertyHandler.java +++ b/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPooledActorsPropertyHandler.java @@ -142,13 +142,13 @@ public class ActivitiPooledActorsPropertyHandler extends ActivitiTaskPropertyHan } } - /** - * Returns a DTO containing the users and groups to add and the links to remove. - * - * @param value - * @param links - * @return - */ + /** + * Returns a DTO containing the users and groups to add and the links to remove. + * + * @param value Serializable + * @param links Collection + * @return UserAndGroupUpdates + */ private UserAndGroupUpdates getUserAndGroupUpdates(Serializable value, Collection links) { Collection actors = getNodes(value); diff --git a/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPropertyConverter.java b/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPropertyConverter.java index 3b49f18424..8ae12c6adc 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPropertyConverter.java +++ b/source/java/org/alfresco/repo/workflow/activiti/properties/ActivitiPropertyConverter.java @@ -355,13 +355,13 @@ public class ActivitiPropertyConverter // } // } - /** - * Sets Default Properties of Task - * - * @param task - * task instance - */ - public void setDefaultTaskProperties(DelegateTask task) + /** + * Sets Default Properties of Task + * + * @param task + * task instance + */ + public void setDefaultTaskProperties(DelegateTask task) { TypeDefinition typeDefinition = typeManager.getFullTaskDefinition(task); // Only local task properties should be set to default value @@ -494,8 +494,8 @@ public class ActivitiPropertyConverter } /** - * @param historicProcessInstance - * @return + * @param historicProcessInstance HistoricProcessInstance + * @return Map */ public Map getStartVariables(HistoricProcessInstance historicProcessInstance) { @@ -517,8 +517,8 @@ public class ActivitiPropertyConverter /** * Get all variable updates for process instance, latest updates on top * - * @param processId - * @return + * @param processId String + * @return Map */ public Map getHistoricProcessVariables(String processId) { @@ -532,8 +532,8 @@ public class ActivitiPropertyConverter /** * Get all variable updates for task instance, latest updates on top * - * @param taskId - * @return + * @param taskId String + * @return Map */ public Map getHistoricTaskVariables(String taskId) { @@ -543,13 +543,13 @@ public class ActivitiPropertyConverter return getHistoricVariables(query); } - /** - * Get all variable updates for activity, latest updates on top - * - * @param activityId - * @return - */ - public Map getHistoricActivityVariables(String activityId) + /** + * Get all variable updates for activity, latest updates on top + * + * @param activityId String + * @return Map + */ + public Map getHistoricActivityVariables(String activityId) { HistoricDetailQuery query = activitiUtil.getHistoryService() .createHistoricDetailQuery() @@ -649,15 +649,15 @@ public class ActivitiPropertyConverter return property; } } - - /** - * Converts a {@link Serializable} value to the type of the specified property. - * @param task - * @param value - * @param propertyName - * @return - */ - public Serializable convertValueToPropertyType(Task task, Serializable value, QName propertyName) + + /** + * Converts a {@link Serializable} value to the type of the specified property. + * @param task Task + * @param value Serializable + * @param propertyName QName + * @return Serializable + */ + public Serializable convertValueToPropertyType(Task task, Serializable value, QName propertyName) { TypeDefinition taskDef = typeManager.getFullTaskDefinition(task); PropertyDefinition propDef = taskDef.getProperties().get(propertyName); @@ -801,8 +801,8 @@ public class ActivitiPropertyConverter } /** - * @param task - * @param properties + * @param task Task + * @param properties Map */ private void setTaskOwner(Task task, Map properties) { @@ -834,7 +834,7 @@ public class ActivitiPropertyConverter /** * Filter out all internal task-properties. * - * @param properties + * @param properties Map * @return filtered properties. */ private Map filterTaskProperties( @@ -1029,8 +1029,8 @@ public class ActivitiPropertyConverter } /** - * @param value - * @return + * @param value Object + * @return boolean */ private boolean isEmptyString(Object value) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoAssignment.java b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoAssignment.java index af9e394831..2792e24ab0 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoAssignment.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoAssignment.java @@ -237,7 +237,8 @@ public class AlfrescoAssignment extends JBPMSpringAssignmentHandler /** * Convert Alfresco authority to actor id * - * @param authority + * @param authority ScriptNode + * @param allowGroup boolean * @return actor id */ private String mapAuthorityToName(ScriptNode authority, boolean allowGroup) diff --git a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoJavaScript.java b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoJavaScript.java index aa8eeaadb3..2147206e2f 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoJavaScript.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoJavaScript.java @@ -241,7 +241,7 @@ public class AlfrescoJavaScript extends JBPMSpringActionHandler /** * Is the script specified as text only, or as explicit expression, variable elements - * @return + * @return boolean */ @SuppressWarnings("unchecked") private boolean isScriptOnlyText() @@ -282,9 +282,9 @@ public class AlfrescoJavaScript extends JBPMSpringActionHandler /** * Convert values for JBPM Context * - * @param value - * @param services - * @return + * @param value Object + * @param services ServiceRegistry + * @return Object */ @SuppressWarnings("unchecked") private static Object convertForJBPM(Object value, ServiceRegistry services) diff --git a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoTimer.java b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoTimer.java index 1abd48f158..0e04e92b67 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoTimer.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/AlfrescoTimer.java @@ -48,7 +48,7 @@ public class AlfrescoTimer extends Timer /** * Construct * - * @param token + * @param token Token */ public AlfrescoTimer(Token token) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/ForEachFork.java b/source/java/org/alfresco/repo/workflow/jbpm/ForEachFork.java index 1e22a01fb2..32722feee9 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/ForEachFork.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/ForEachFork.java @@ -60,7 +60,7 @@ public class ForEachFork extends JBPMSpringActionHandler /** * Create a new child token for each item in list. * - * @param executionContext + * @param executionContext ExecutionContext * @throws Exception */ public void execute(final ExecutionContext executionContext) @@ -194,9 +194,10 @@ public class ForEachFork extends JBPMSpringActionHandler /** * Create a token name * - * @param parent - * @param transitionName - * @return + * @param parent Token + * @param transitionName String + * @param loopIndex int + * @return String */ protected String getTokenName(Token parent, String transitionName, int loopIndex) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java b/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java index 7ef857765f..245856e65d 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java @@ -216,21 +216,21 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine private static final String ERR_GET_COMPANY_HOME_INVALID = "jbpm.engine.get.company.home.invalid"; private static final String ERR_GET_COMPANY_HOME_MULTIPLE = "jbpm.engine.get.company.home.multiple"; - // engine ID - public static final String ENGINE_ID = "jbpm"; - - public JBPMEngine() - { - super(); - ignoredProperties.put(WorkflowModel.PROP_STATUS.getLocalName(), WorkflowModel.PROP_STATUS); - ignoredProperties.put(WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP.getLocalName(), WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); - ignoredProperties.put(WorkflowModel.PROP_PACKAGE_ACTION_GROUP.getLocalName(), WorkflowModel.PROP_PACKAGE_ACTION_GROUP); - } - /** - * Sets the JBPM Template used for accessing JBoss JBPM in the correct - * context + // engine ID + public static final String ENGINE_ID = "jbpm"; + + public JBPMEngine() + { + super(); + ignoredProperties.put(WorkflowModel.PROP_STATUS.getLocalName(), WorkflowModel.PROP_STATUS); + ignoredProperties.put(WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP.getLocalName(), WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); + ignoredProperties.put(WorkflowModel.PROP_PACKAGE_ACTION_GROUP.getLocalName(), WorkflowModel.PROP_PACKAGE_ACTION_GROUP); + } + /** + * Sets the JBPM Template used for accessing JBoss JBPM in the correct + * context * - * @param jbpmTemplate + * @param jbpmTemplate JbpmTemplate */ public void setJBPMTemplate(JbpmTemplate jbpmTemplate) { @@ -240,7 +240,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Node Service * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -250,7 +250,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Person Service * - * @param personService + * @param personService PersonService */ public void setPersonService(PersonService personService) { @@ -260,7 +260,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Authority DAO * - * @param authorityDAO + * @param authorityDAO AuthorityDAO */ public void setAuthorityDAO(AuthorityDAO authorityDAO) { @@ -270,7 +270,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Service Registry * - * @param serviceRegistry + * @param serviceRegistry ServiceRegistry */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { @@ -280,7 +280,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Company Home Path * - * @param companyHomePath + * @param companyHomePath String */ public void setCompanyHomePath(String companyHomePath) { @@ -290,7 +290,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Sets the Company Home Store * - * @param companyHomeStore + * @param companyHomeStore String */ public void setCompanyHomeStore(String companyHomeStore) { @@ -302,7 +302,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine * company home when folk do not have read access to company home TODO: * review use with DC * - * @param unprotectedSearchService + * @param unprotectedSearchService SearchService */ public void setUnprotectedSearchService(SearchService unprotectedSearchService) { @@ -321,13 +321,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine return deployDefinition(workflowDefinition, mimetype, null); } - /* - * @see org.alfresco.repo.workflow.WorkflowComponent#deployDefinition(java.io.InputStream, java.lang.String, java.lang.String) - */ - public WorkflowDeployment deployDefinition(final InputStream workflowDefinition, final String mimetype, String name) - { - try - { + /* + * @see org.alfresco.repo.workflow.WorkflowComponent#deployDefinition(java.io.InputStream, java.lang.String, java.lang.String) + */ + public WorkflowDeployment deployDefinition(final InputStream workflowDefinition, final String mimetype, String name) + { + try + { return (WorkflowDeployment)jbpmTemplate.execute(new JbpmCallback() { public Object doInJbpm(JbpmContext context) @@ -2041,8 +2041,8 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Construct a JBPM Hibernate query based on the Task Query provided * - * @param session - * @param query + * @param session Session + * @param query WorkflowTaskQuery * @return jbpm hiberate query criteria */ private Criteria createTaskQueryCriteria(Session session, WorkflowTaskQuery query) @@ -2207,8 +2207,8 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine } /** - * @param variables - * @return + * @param variables Criteria + * @return Disjunction */ private Disjunction createProcessIdCriteria(Criteria variables) { @@ -2264,9 +2264,9 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Create process-specific query criteria * - * @param root - * @param query - * @return + * @param root Criteria + * @param query WorkflowTaskQuery + * @return Criteria */ private Criteria createProcessCriteria(Criteria root, WorkflowTaskQuery query) { @@ -2722,13 +2722,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** - * Construct a Process Definition from the provided Process Definition - * stream - * - * @param definitionStream - * stream to create process definition from - * @param mimetype - * mimetype of stream + * Construct a Process Definition from the provided Process Definition + * stream + * + * @param definitionStream + * stream to create process definition from + * @param mimetype + * mimetype of stream * @return process definition */ @SuppressWarnings("unchecked") @@ -2855,24 +2855,24 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine } /** - * Gets Properties of Task - * - * @param instance task instance - * @param localProperties properties to set - */ - protected Map getTaskProperties(TaskInstance instance, boolean localProperties) - { + * Gets Properties of Task + * + * @param instance task instance + * @param localProperties properties to set + */ + protected Map getTaskProperties(TaskInstance instance, boolean localProperties) + { return getTaskProperties(instance, localProperties, null); } /** - * Gets Properties of Task - * - * @param instance task instance - * @param localProperties properties to set - * @param variablesCache cahce of context instance variables if any exists - */ - @SuppressWarnings("unchecked") + * Gets Properties of Task + * + * @param instance task instance + * @param localProperties properties to set + * @param variablesCache cahce of context instance variables if any exists + */ + @SuppressWarnings("unchecked") protected Map getTaskProperties(TaskInstance instance, boolean localProperties, Map variablesCache) { // retrieve type definition for task @@ -3180,13 +3180,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine * * @param instance * task instance - */ - protected void setDefaultTaskProperties(TaskInstance instance) - { - Map existingValues = getTaskProperties(instance, false); - Map defaultValues = new HashMap(); - - // construct an anonymous type that flattens all mandatory aspects + */ + protected void setDefaultTaskProperties(TaskInstance instance) + { + Map existingValues = getTaskProperties(instance, false); + Map defaultValues = new HashMap(); + + // construct an anonymous type that flattens all mandatory aspects ClassDefinition classDef = getFullTaskDefinition(instance); Map propertyDefs = classDef.getProperties(); @@ -3361,7 +3361,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine * Attempts to convert a JBPM Object to the correct Alfresco data type * @param propDef PropertyDefinition * @param value any Value - * @return + * @return Serializable */ private Serializable convertValue(PropertyDefinition propDef, Object value) { @@ -3463,13 +3463,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine return value; } - /** - * Convert person name to an Alfresco Person - * - * @param name - * the person name to convert - * @return the Alfresco person - */ + /** + * Convert person name to an Alfresco Person + * + * @param name + * the person name to convert + * @return the Alfresco person + */ private NodeRef mapNameToPerson(String name) { NodeRef authority = null; @@ -3484,13 +3484,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine return authority; } - /** - * Convert authority name to an Alfresco Authority - * - * @param name - * the authority names to convert - * @return the Alfresco authorities - */ + /** + * Convert authority name to an Alfresco Authority + * + * @param name + * the authority names to convert + * @return the Alfresco authorities + */ private NodeRef mapNameToAuthority(String name) { NodeRef authority = null; @@ -3508,7 +3508,7 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Convert Alfresco authority to actor id * - * @param authority + * @param authority NodeRef * @return actor id */ private String mapAuthorityToName(NodeRef authority) @@ -3586,12 +3586,12 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Creates a Workflow Path - * - * @param token - * JBoss JBPM Token - * @return Workflow Path - */ - protected WorkflowPath createWorkflowPath(Token token) + * + * @param token + * JBoss JBPM Token + * @return Workflow Path + */ + protected WorkflowPath createWorkflowPath(Token token) { if(token == null) return null; @@ -3605,8 +3605,8 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine * * @param token * JBoss JBPM Token - * @param wfInstance - * @param node + * @param wfInstance WorkflowInstance + * @param node WorkflowNode * @return Workflow Path */ protected WorkflowPath createWorkflowPath(Token token, WorkflowInstance wfInstance, WorkflowNode node) @@ -3703,8 +3703,9 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine * * @param instance * JBoss JBPM Process Instance - * @param endDate - * @param variables + * @param definition WorkflowDefinition + * @param endDate Date + * @param variables Map * @return Workflow instance */ protected WorkflowInstance createWorkflowInstance(ProcessInstance instance, WorkflowDefinition definition, Date endDate, Map variables) @@ -3757,8 +3758,8 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * * Creates a Workflow Task - * @param task - * @return + * @param task TaskInstance + * @return WorkflowTask */ protected WorkflowTask createWorkflowTask(TaskInstance task) { @@ -3770,13 +3771,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Creates a Workflow Task - * - * @param task - * JBoss Task Instance - * @param definition task definition - * @param path - * @param properties - * @return Workflow Task + * + * @param task + * JBoss Task Instance + * @param definition task definition + * @param path WorkflowPath + * @param properties Map + * @return Workflow Task */ private WorkflowTask createWorkflowTask(TaskInstance task, WorkflowTaskDefinition definition, WorkflowPath path, Map properties) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/JBPMScheduler.java b/source/java/org/alfresco/repo/workflow/jbpm/JBPMScheduler.java index 53e009ed37..17676273ab 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/JBPMScheduler.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/JBPMScheduler.java @@ -38,7 +38,7 @@ public class JBPMScheduler extends AbstractLifecycleBean private boolean JbpmEngineEnabled = false; /** - * @param jbpmTemplate + * @param jbpmTemplate JbpmTemplate */ public void setJBPMTemplate(JbpmTemplate jbpmTemplate) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/JBPMTestSpringActionHandler.java b/source/java/org/alfresco/repo/workflow/jbpm/JBPMTestSpringActionHandler.java index 9360fffa6b..d85d4f55de 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/JBPMTestSpringActionHandler.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/JBPMTestSpringActionHandler.java @@ -38,7 +38,7 @@ public class JBPMTestSpringActionHandler extends JBPMSpringActionHandler /** * Setter accessible from jBPM jPDL - * @param value + * @param value String */ public void setValue(String value) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/JoinEndForkedTokens.java b/source/java/org/alfresco/repo/workflow/jbpm/JoinEndForkedTokens.java index 936a3869d7..f235c4f6d1 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/JoinEndForkedTokens.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/JoinEndForkedTokens.java @@ -60,8 +60,8 @@ public class JoinEndForkedTokens implements ActionHandler /** * Cancel token * - * @param executionContext - * @param token + * @param executionContext ExecutionContext + * @param token Token */ protected void cancelToken(ExecutionContext executionContext, Token token) { @@ -85,8 +85,8 @@ public class JoinEndForkedTokens implements ActionHandler /** * Cancel tasks associated with a token * - * @param executionContext - * @param token + * @param executionContext ExecutionContext + * @param token Token */ protected void cancelTokenTasks(ExecutionContext executionContext, Token token) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java b/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java index 67a1bc7a98..507699ca99 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java @@ -108,7 +108,7 @@ public class NodeListConverter extends SerializableToByteArrayConverter /** * @param value Object - * @return + * @return JBPMNodeList */ @SuppressWarnings("unchecked") private JBPMNodeList revertNodes(Object value) diff --git a/source/java/org/alfresco/repo/workflow/jbpm/WorkflowTaskInstance.java b/source/java/org/alfresco/repo/workflow/jbpm/WorkflowTaskInstance.java index 01fabf5df4..a1efd60d02 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/WorkflowTaskInstance.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/WorkflowTaskInstance.java @@ -62,8 +62,8 @@ public class WorkflowTaskInstance extends TaskInstance /** * Construct * - * @param taskName - * @param actorId + * @param taskName String + * @param actorId String */ public WorkflowTaskInstance(String taskName, String actorId) { diff --git a/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java b/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java index 962611ae3e..094d671900 100644 --- a/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java +++ b/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java @@ -189,13 +189,13 @@ public class JscriptWorkflowTask extends BaseScopableProcessorExtension implemen } - /** - * End the task - * - * @param transitionId - * transition to end the task for - */ - public void endTask(String transitionId) + /** + * End the task + * + * @param transitionId + * transition to end the task for + */ + public void endTask(String transitionId) { workflowService.endTask(task.getId(), transitionId); } @@ -203,7 +203,7 @@ public class JscriptWorkflowTask extends BaseScopableProcessorExtension implemen /** * Get the available transition ids. * - * @return + * @return ScriptableHashMap */ public ScriptableHashMap getTransitions() { @@ -222,7 +222,7 @@ public class JscriptWorkflowTask extends BaseScopableProcessorExtension implemen /** * Get the packe resources (array of noderefs) * - * @return + * @return Scriptable */ public Scriptable getPackageResources() { diff --git a/source/java/org/alfresco/service/ServiceRegistry.java b/source/java/org/alfresco/service/ServiceRegistry.java index b1d368ed18..25b7d54e6a 100644 --- a/source/java/org/alfresco/service/ServiceRegistry.java +++ b/source/java/org/alfresco/service/ServiceRegistry.java @@ -357,7 +357,7 @@ public interface ServiceRegistry /** * Get the ownable service (or null if one is not provided) - * @return + * @return OwnableService */ @NotAuditable OwnableService getOwnableService(); diff --git a/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java b/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java index 76a6dfc33c..156363b763 100644 --- a/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java +++ b/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java @@ -99,13 +99,13 @@ public interface ActionTrackingService * Cancellable actions periodically check to see * if a cancel has been requested, and will take * note of the cancel request once seen. - * If the specified action is not a cancellable - * action, nothing will happen. - * - * @param executionSummary - */ - void requestActionCancellation(ExecutionSummary executionSummary); - + * If the specified action is not a cancellable + * action, nothing will happen. + * + * @param executionSummary ExecutionSummary + */ + void requestActionCancellation(ExecutionSummary executionSummary); + /** * Has cancellation been requested for the given * action? diff --git a/source/java/org/alfresco/service/cmr/action/ParameterConstraint.java b/source/java/org/alfresco/service/cmr/action/ParameterConstraint.java index 804a7faad1..b25894c80b 100644 --- a/source/java/org/alfresco/service/cmr/action/ParameterConstraint.java +++ b/source/java/org/alfresco/service/cmr/action/ParameterConstraint.java @@ -47,8 +47,8 @@ public interface ParameterConstraint /** * - * @param value - * @return + * @param value String + * @return String */ String getValueDisplayLabel(String value); diff --git a/source/java/org/alfresco/service/cmr/action/ParameterizedItemDefinition.java b/source/java/org/alfresco/service/cmr/action/ParameterizedItemDefinition.java index d5e5ef5a8a..51bfe884ba 100644 --- a/source/java/org/alfresco/service/cmr/action/ParameterizedItemDefinition.java +++ b/source/java/org/alfresco/service/cmr/action/ParameterizedItemDefinition.java @@ -58,7 +58,7 @@ public interface ParameterizedItemDefinition /** * Indicates whether the parameterized item has any parameter definitions * - * @return` true if the parameterized item has any parameter definitions, false otherwise + * @return true if the parameterized item has any parameter definitions, false otherwise */ public boolean hasParameterDefinitions(); diff --git a/source/java/org/alfresco/service/cmr/activities/ActivityService.java b/source/java/org/alfresco/service/cmr/activities/ActivityService.java index d075639fb4..0f25752c0d 100644 --- a/source/java/org/alfresco/service/cmr/activities/ActivityService.java +++ b/source/java/org/alfresco/service/cmr/activities/ActivityService.java @@ -106,7 +106,6 @@ public interface ActivityService extends ActivityPostService * @param siteId - optional, if set then will filter by given siteId else return all sites * @param excludeThisUser - if TRUE then will exclude activities for this user (hence returning other users only) * @param excludeOtherUsers - if TRUE then will exclude activities for other users (hence returning this user only) - * @param excludeOtherUsers - if TRUE then will only return activities of users this user follows * @param minFeedId - inclusive from min feed DB id, if -1 then return all available * @return list of JSON feed entries */ @@ -152,7 +151,7 @@ public interface ActivityService extends ActivityPostService /** * Return maximum configured item entries (per feed) * - * @return + * @return int */ @NotAuditable public int getMaxFeedItems(); diff --git a/source/java/org/alfresco/service/cmr/activities/FileFolderActivityPosterImpl.java b/source/java/org/alfresco/service/cmr/activities/FileFolderActivityPosterImpl.java index 063cd57c25..40e7f948f3 100644 --- a/source/java/org/alfresco/service/cmr/activities/FileFolderActivityPosterImpl.java +++ b/source/java/org/alfresco/service/cmr/activities/FileFolderActivityPosterImpl.java @@ -55,11 +55,11 @@ public class FileFolderActivityPosterImpl implements ActivityPoster /** * Create JSON suitable for create, modify or delete activity posts. * - * @param tenantDomain - * @param path - * @param parentNodeRef - * @param nodeRef - * @param fileName + * @param tenantDomain String + * @param path String + * @param parentNodeRef NodeRef + * @param nodeRef NodeRef + * @param fileName String * @throws JSONException * @return JSONObject */ diff --git a/source/java/org/alfresco/service/cmr/audit/AuditInfo.java b/source/java/org/alfresco/service/cmr/audit/AuditInfo.java index 3495e3e6fc..a849f37e52 100644 --- a/source/java/org/alfresco/service/cmr/audit/AuditInfo.java +++ b/source/java/org/alfresco/service/cmr/audit/AuditInfo.java @@ -64,28 +64,28 @@ public interface AuditInfo /** * The timestamp for the audit entry. * - * @return + * @return Date */ public Date getDate(); /** * Is this entry recording an error? * - * @return + * @return boolean */ public boolean isFail(); /** * Was this audit entry subject to filtering (which must have been met if an entry is found). Filters are not applied in version 1.4. * - * @return + * @return boolean */ public boolean isFiltered(); /** * Get the host address of the server machine. * - * @return + * @return String */ public String getHostAddress(); @@ -100,14 +100,14 @@ public interface AuditInfo * The serialized properties on the key node, if one exists, after the method invocation. Note these values are serialized before the method is called so they are unaffected by * the method invocation. In V1.4 these are not stored. * - * @return + * @return Map */ public Map getKeyPropertiesAfter(); /** * The serialized properties on the key node, if one exists, before the method invocation. In V1.4 these are not stored. * - * @return + * @return Map */ public Map getKeyPropertiesBefore(); @@ -130,14 +130,14 @@ public interface AuditInfo * * These are not stored in V1.4. * - * @return + * @return Serializable[] */ public Serializable[] getMethodArguments(); /** * Get the method arguments as strings. * - * @return + * @return String[] */ public String[] getMethodArgumentsAsStrings(); @@ -153,7 +153,7 @@ public interface AuditInfo * * This is not available in V1.4. * - * @return + * @return Serializable */ public Serializable getReturnObject(); @@ -169,7 +169,7 @@ public interface AuditInfo * * This is not stored in V1.4. * - * @return + * @return String */ public String getSessionId(); diff --git a/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java b/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java index 78a16202df..0ac5cb09ef 100644 --- a/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java +++ b/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java @@ -231,7 +231,7 @@ public class CalendarTimezoneHelper /** * Splits an iCal line into key and value by the first * unquoted colon. - * @param icalLine + * @param icalLine String */ protected static String[] icalLineKeyValue(String icalLine){ int delim = indexOfFirstUnquotedColon(icalLine); @@ -244,7 +244,7 @@ public class CalendarTimezoneHelper } /** - * @param icalLine + * @param icalLine String * @return location of first non quote enclosed colon */ private static int indexOfFirstUnquotedColon(String icalLine){ diff --git a/source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java b/source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java index 726a87266c..9f59167aca 100644 --- a/source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java +++ b/source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java @@ -119,8 +119,7 @@ public interface CheckOutCheckInService /** * By default the checked in node is not keep checked in. * - * @see VersionOperationsService#checkin(NodeRef, HashMap, String, boolean) - * + * * @param workingCopyNodeRef the working copy node reference * @param versionProperties the version properties. If null is passed then the original node * is NOT versioned during the checkin operation. @@ -140,8 +139,7 @@ public interface CheckOutCheckInService * If no content url is specified then current content set on the working * copy is understood to be current. * - * @see VersionOperationsService#checkin(NodeRef, HashMap, String) - * + * * @param workingCopyNodeRef the working copy node reference * @param versionProperties the version properties. If null is passed then the original node * is NOT versioned during the checkin operation. diff --git a/source/java/org/alfresco/service/cmr/download/DownloadRequest.java b/source/java/org/alfresco/service/cmr/download/DownloadRequest.java index 7ea6be1a37..90a2febe22 100644 --- a/source/java/org/alfresco/service/cmr/download/DownloadRequest.java +++ b/source/java/org/alfresco/service/cmr/download/DownloadRequest.java @@ -47,7 +47,7 @@ public class DownloadRequest } /** - * @return + * @return String */ public String getOwner() { diff --git a/source/java/org/alfresco/service/cmr/download/DownloadService.java b/source/java/org/alfresco/service/cmr/download/DownloadService.java index 7b045726d3..ea1df5fa2c 100644 --- a/source/java/org/alfresco/service/cmr/download/DownloadService.java +++ b/source/java/org/alfresco/service/cmr/download/DownloadService.java @@ -56,7 +56,7 @@ public interface DownloadService /** * Delete downloads created before before. * - * @param before + * @param before Date */ public void deleteDownloads(Date before); diff --git a/source/java/org/alfresco/service/cmr/download/DownloadStatus.java b/source/java/org/alfresco/service/cmr/download/DownloadStatus.java index 654804a40d..daf4f5108c 100644 --- a/source/java/org/alfresco/service/cmr/download/DownloadStatus.java +++ b/source/java/org/alfresco/service/cmr/download/DownloadStatus.java @@ -116,7 +116,6 @@ public class DownloadStatus implements Serializable /** * @return the number of files added to the download archive - * @return */ public long getFilesAdded() { diff --git a/source/java/org/alfresco/service/cmr/email/EmailDelivery.java b/source/java/org/alfresco/service/cmr/email/EmailDelivery.java index f48a20ff46..43116f2429 100644 --- a/source/java/org/alfresco/service/cmr/email/EmailDelivery.java +++ b/source/java/org/alfresco/service/cmr/email/EmailDelivery.java @@ -16,8 +16,8 @@ public class EmailDelivery implements Serializable /** * New Email Delivery Instructions. Who gets the message and who sent it. * Which may be different from the contents of the message. - * @param recipient - * @param from + * @param recipient String + * @param from String * @param auth - may be null if the email is not authenticated */ public EmailDelivery(String recipient, String from, String auth) diff --git a/source/java/org/alfresco/service/cmr/favourites/FavouritesService.java b/source/java/org/alfresco/service/cmr/favourites/FavouritesService.java index 6b59c4bc15..214e616ff3 100644 --- a/source/java/org/alfresco/service/cmr/favourites/FavouritesService.java +++ b/source/java/org/alfresco/service/cmr/favourites/FavouritesService.java @@ -62,9 +62,9 @@ public interface FavouritesService * If the nodeRef is already favourited, the favourite entity is returned. No * information regarding the favourite e.g. createdAt is updated. * - * @param userName - * @param nodeRef - * @return + * @param userName String + * @param nodeRef NodeRef + * @return PersonFavourite */ @Auditable(parameters = {"userName", "nodeRef"}) PersonFavourite addFavourite(String userName, NodeRef nodeRef); @@ -72,9 +72,9 @@ public interface FavouritesService /** * Is the entity identified by nodeRef a favourite document of user "userName". * - * @param userName - * @param nodeRef - * @return + * @param userName String + * @param nodeRef NodeRef + * @return boolean */ @Auditable(parameters = {"userName", "nodeRef"}) boolean isFavourite(String userName, NodeRef nodeRef); @@ -82,9 +82,9 @@ public interface FavouritesService /** * Remove the document identified by nodeRef as a favourite for user "userName". * - * @param userName - * @param nodeRef - * @return + * @param userName String + * @param nodeRef NodeRef + * @return boolean */ @Auditable(parameters = {"userName", "nodeRef"}) boolean removeFavourite(String userName, NodeRef nodeRef); @@ -92,11 +92,11 @@ public interface FavouritesService /** * A paged list of favourites for user "userName". * - * @param userName - * @param types - * @param sortProps - * @param pagingRequest - * @return + * @param userName String + * @param types Set + * @param sortProps List> + * @param pagingRequest PagingRequest + * @return PagingResults */ @Auditable(parameters = {"userName", "types", "pagingRequest"}) PagingResults getPagedFavourites(String userName, Set types, @@ -105,9 +105,9 @@ public interface FavouritesService /** * Get a specific favourite for user "userName". * - * @param userName - * @param nodeRef - * @return + * @param userName String + * @param nodeRef NodeRef + * @return PersonFavourite */ @Auditable(parameters = {"userName", "nodeRef"}) PersonFavourite getFavourite(String userName, NodeRef nodeRef); diff --git a/source/java/org/alfresco/service/cmr/invitation/InvitationSearchCriteria.java b/source/java/org/alfresco/service/cmr/invitation/InvitationSearchCriteria.java index 9d2d3563d5..817efd33fc 100644 --- a/source/java/org/alfresco/service/cmr/invitation/InvitationSearchCriteria.java +++ b/source/java/org/alfresco/service/cmr/invitation/InvitationSearchCriteria.java @@ -38,13 +38,13 @@ public interface InvitationSearchCriteria /** * Search by inviter (who started the invitation) - * @return + * @return String */ String getInviter(); /** * Search by invitee (who is being invited, alfresco userid) - * @return + * @return String */ String getInvitee(); diff --git a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java index 91d81ca62e..492314a766 100644 --- a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java +++ b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java @@ -44,14 +44,14 @@ public interface InvitationService public List getInvitationServiceWorkflowNames(); /** - * Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name - * The server path is calculated based on the sysAdmin parameters - * @param inviteeUserName Alfresco user name of who should be invited - * @param resourceType resourceType - * @param resourceName - * @param inviteeRole - * @param acceptUrl - * @param rejectUrl + * Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name + * The server path is calculated based on the sysAdmin parameters + * @param inviteeUserName Alfresco user name of who should be invited + * @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 @@ -81,14 +81,14 @@ public interface InvitationService * Alfresco User NameA new user name will be generated as part of the invitation process. * The server path is calculated based on the sysAdmin parameters * - * @param inviteeFirstName - * @param inviteeLastName - * @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 uniquely identify this invitation. @@ -116,15 +116,15 @@ public interface InvitationService String acceptUrl, String rejectUrl); /** - * Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name - * - * @param inviteeUserName Alfresco user name of who should be invited - * @param resourceType resourceType - * @param resourceName - * @param inviteeRole - * @param serverPath - * @param acceptUrl - * @param rejectUrl + * Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name + * + * @param inviteeUserName Alfresco user name of who should be invited + * @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 @@ -155,15 +155,15 @@ public interface InvitationService * Start the invitation process for a NominatedInvitation for a user who does not yet have an * Alfresco User NameA new user name will be generated as part of the invitation process. * - * @param inviteeFirstName - * @param inviteeLastName - * @param inviteeEmail - * @param resourceType Invitation.ResourceType - * @param resourceName - * @param inviteeRole - * @param serverPath - * @param acceptUrl - * @param rejectUrl + * @param inviteeFirstName String + * @param inviteeLastName String + * @param inviteeEmail String + * @param resourceType Invitation.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 uniquely identify this invitation. @@ -193,13 +193,13 @@ public interface InvitationService String acceptUrl, String rejectUrl); - /** - * Start the invitation process for a ModeratedInvitation - * @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 inviteeUserName who is to be invited + * @param resourceType Invitation.ResourceType what resource type ? + * @param resourceName which resource + * @param inviteeRole which role ? + */ @Auditable(parameters = { "inviteeComments", "inviteeUserName", @@ -215,21 +215,21 @@ public interface InvitationService /** * Update the invitee comments for an existing moderated invitation * - * @param inviteeId - * @param siteShortName - * @param inviteeComments + * @param inviteeId String + * @param siteShortName String + * @param inviteeComments String * @return the invitation */ @Auditable(parameters = {"inviteeId", "siteShortName", "inviteeComments"}) ModeratedInvitation updateModeratedInvitation(String inviteeId, String siteShortName, String inviteeComments); - /** - * For a Nominated Invitation invitee accepts this invitation - * - * @param invitationId - * @param ticket - * @return the invitation - */ + /** + * For a Nominated Invitation invitee accepts this invitation + * + * @param invitationId String + * @param ticket String + * @return the invitation + */ @Auditable(parameters = {"invitationId", "reason"}) public Invitation accept(String invitationId, String ticket); @@ -245,8 +245,8 @@ public interface InvitationService /** * User or moderator rejects this request - * @param invitationId - * @param reason + * @param invitationId String + * @param reason String */ @Auditable(parameters = {"invitationId", "reason"}) public Invitation reject(String invitationId, String reason); @@ -261,7 +261,7 @@ public interface InvitationService /** * get an invitation from its invitation id * - * @param invitationId; + * @param invitationId String */ @NotAuditable public Invitation getInvitation(String invitationId) ; @@ -277,8 +277,8 @@ public interface InvitationService /** * list Invitations for a specific resource - * @param resourceType - * @param resourceName + * @param resourceType Invitation.ResourceType + * @param resourceName String */ @NotAuditable public List listPendingInvitationsForResource(Invitation.ResourceType resourceType, String resourceName); @@ -286,7 +286,7 @@ public interface InvitationService /** * search invitation * - * @param criteria + * @param criteria InvitationSearchCriteria * @return the list of invitations */ @NotAuditable diff --git a/source/java/org/alfresco/service/cmr/lock/LockService.java b/source/java/org/alfresco/service/cmr/lock/LockService.java index f403922265..888b464f32 100644 --- a/source/java/org/alfresco/service/cmr/lock/LockService.java +++ b/source/java/org/alfresco/service/cmr/lock/LockService.java @@ -43,12 +43,12 @@ public interface LockService *

      * The lock will be owned by the current user. *

      - * A lock made with this call will never expire. - * - * @param nodeRef a reference to a node - * @param lockType the lock type - * @throws UnableToAquireLockException - * thrown if the lock could not be obtained + * A lock made with this call will never expire. + * + * @param nodeRef a reference to a node + * @param lockType the lock type + * @throws UnableToAquireLockException + * thrown if the lock could not be obtained */ @Auditable(parameters = {"nodeRef", "lockType"}) public void lock(NodeRef nodeRef, LockType lockType) @@ -262,35 +262,35 @@ public interface LockService * process will continue without an error. *

      * If the lock on any one of the nodes cannot be released than an exception - * will be raised and the process rolled back. - * - * @param nodeRefs the node references - * @throws UnableToReleaseLockException - * thrown if the lock could not be released - */ + * will be raised and the process rolled back. + * + * @param nodeRefs the node references + * @throws UnableToReleaseLockException + * thrown if the lock could not be released + */ @Auditable(parameters = {"nodeRefs"}) public void unlock(Collection nodeRefs) throws UnableToReleaseLockException; - /** - * Gets the lock status for the node reference relative to the current user. - * - * @see LockService#getLockStatus(NodeRef) - * - * @param nodeRef the node reference - * @return the lock status + /** + * Gets the lock status for the node reference relative to the current user. + * + * @see LockService#getLockStatus(NodeRef) + * + * @param nodeRef the node reference + * @return the lock status */ @Auditable(parameters = {"nodeRef"}) public LockStatus getLockStatus(NodeRef nodeRef); - /** - * Gets the lock status for the node reference for the specified user. - * - * @see LockService#getLockStatus(NodeRef) - * - * @param nodeRef the node reference - * @param userName the user name + /** + * Gets the lock status for the node reference for the specified user. + * + * @see LockService#getLockStatus(NodeRef) + * + * @param nodeRef the node reference + * @param userName the user name * @return the lock status */ @Auditable(parameters = {"nodeRef", "userName"}) @@ -341,7 +341,7 @@ public interface LockService /** * Retrieve the additional lock info associated with a node ref. *

      - * @param nodeRef + * @param nodeRef NodeRef * @return Additional info string or null */ public String getAdditionalInfo(NodeRef nodeRef); @@ -355,7 +355,7 @@ public interface LockService * The returned data is intended for information purposes only, e.g. returning the timeout * in a WebDAV response. * - * @param nodeRef + * @param nodeRef NodeRef * @return LockState */ public LockState getLockState(NodeRef nodeRef); @@ -365,7 +365,7 @@ public interface LockService * will be honoured. Requests for ephemeral locks with expiry times greater than * this value will be automatically converted to a request for a persistent lock. * - * @param threshSecs + * @param threshSecs int */ public void setEphemeralExpiryThreshold(int threshSecs); } diff --git a/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java b/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java index c4420dc89d..6ba931631d 100644 --- a/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java +++ b/source/java/org/alfresco/service/cmr/ml/ContentFilterLanguagesService.java @@ -44,8 +44,8 @@ public interface ContentFilterLanguagesService /** * Get the order of the specified language code * - * @param code - * @return + * @param code String + * @return int * @throws AlfrescoRuntimeException if the code doesn't exist */ @NotAuditable @@ -54,8 +54,8 @@ public interface ContentFilterLanguagesService /** * Get the language of the specified language code * - * @param code - * @return + * @param code String + * @return String * @throws AlfrescoRuntimeException if the code doesn't exist */ @NotAuditable @@ -73,7 +73,7 @@ public interface ContentFilterLanguagesService * Get the the odered filter which results form an extract of availableLanguages on the filterLanguages * * @param availableLanguages the languages list whose will be removed from the filterLanguages - * @return + * @return List */ @Auditable public List getMissingLanguages(List availableLanguages); diff --git a/source/java/org/alfresco/service/cmr/ml/EditionService.java b/source/java/org/alfresco/service/cmr/ml/EditionService.java index d563f0d0c5..b689e57c51 100644 --- a/source/java/org/alfresco/service/cmr/ml/EditionService.java +++ b/source/java/org/alfresco/service/cmr/ml/EditionService.java @@ -72,12 +72,6 @@ public interface EditionService * Get the the versioned metadata of a specific cm:mlDocument transalation version or a specific * cm:mlContainer version * - * @see org.alfresco.repo.model.ml.MultilingualDocumentAspect.PROPERTIES_TO_VERSION the versioned metadata - * of a cm:mlDocument transalation added to the usual metadata versioned for a normal node. - * - * @see org.alfresco.repo.model.ml.MLContainerType.PROPERTIES_TO_VERSION the versioned metadata - * of a cm:mlContainer added to the usual metadata versioned for a normal node. - * * @param version An existing version of a cm:mlDocument translation version or * an existing version of a cm:mlContainer version. * @return The versioned metadata diff --git a/source/java/org/alfresco/service/cmr/model/FileFolderService.java b/source/java/org/alfresco/service/cmr/model/FileFolderService.java index 5954ec1228..bc198f2873 100644 --- a/source/java/org/alfresco/service/cmr/model/FileFolderService.java +++ b/source/java/org/alfresco/service/cmr/model/FileFolderService.java @@ -60,7 +60,7 @@ public interface FileFolderService * Lists page of immediate child files and/or folders of the given context node * with optional filtering (exclusion of certain child file/folder subtypes) and sorting * - * @author janv + *

      author janv * @since 4.0 */ @Auditable(parameters = {"contextNodeRef", "files", "folders", "ignoreTypeQNames", "sortProps", "pagingRequest"}) @@ -90,13 +90,13 @@ public interface FileFolderService /** * Lists all immediate child files of the given context node - * - * Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request. - * - * @param contextNodeRef the folder nodeRef to start searching in - * @return Returns a list of matching files - */ - @Auditable(parameters = {"folderNodeRef"}) + * + * Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request. + * + * @param contextNodeRef the folder nodeRef to start searching in + * @return Returns a list of matching files + */ + @Auditable(parameters = {"folderNodeRef"}) public List listFiles(NodeRef contextNodeRef); /** @@ -284,7 +284,6 @@ public interface FileFolderService * @return Returns the new node's file information * @throws FileExistsException * - * @see {@link #create(NodeRef, String, QName, QName)} */ @Auditable(parameters = {"parentNodeRef", "name", "typeQName"}) public FileInfo create(NodeRef parentNodeRef, String name, QName typeQName) throws FileExistsException; @@ -433,11 +432,11 @@ public interface FileFolderService /** * Lists page of immediate child objects of the given context node * with specification of which types to list and optional filtering (exclusion of certain child file/folder subtypes) and sorting - * @param rootNodeRef + * @param rootNodeRef NodeRef * @param searchTypeQNames QNames of types to list - * @param ignoreAspectQNames - * @param sortProps - * @param pagingRequest + * @param ignoreAspectQNames Set + * @param sortProps List> + * @param pagingRequest PagingRequest * @return list of node refs, never null */ @Auditable(parameters = {"rootNodeRef"}) @@ -447,7 +446,7 @@ public interface FileFolderService /** * Helper method to transform a list of {@link NodeRef} to a list of {@link FileInfo} * - * @param nodeRefs + * @param nodeRefs List * @return list of {@link FileInfo} */ @Auditable(parameters = {"nodeRefs"}) diff --git a/source/java/org/alfresco/service/cmr/model/FileFolderUtil.java b/source/java/org/alfresco/service/cmr/model/FileFolderUtil.java index 33c34f0335..e27863e904 100644 --- a/source/java/org/alfresco/service/cmr/model/FileFolderUtil.java +++ b/source/java/org/alfresco/service/cmr/model/FileFolderUtil.java @@ -67,13 +67,13 @@ public class FileFolderUtil /** * Same as above, with option to disable parent behaviour(s) when creating sub-folder * - * @param service - * @param parentNodeRef - * @param pathElements - * @param folderTypeQName - * @param behaviourFilter - * @param parentBehavioursToDisable - * @return + * @param service FileFolderService + * @param parentNodeRef NodeRef + * @param pathElements List + * @param folderTypeQName QName + * @param behaviourFilter BehaviourFilter + * @param parentBehavioursToDisable Set + * @return FileInfo */ public static FileInfo makeFolders(FileFolderService service, NodeRef parentNodeRef, List pathElements, QName folderTypeQName, BehaviourFilter behaviourFilter, Set parentBehavioursToDisable) diff --git a/source/java/org/alfresco/service/cmr/model/SubFolderFilter.java b/source/java/org/alfresco/service/cmr/model/SubFolderFilter.java index cc1ea2c5bc..abd26c33c2 100644 --- a/source/java/org/alfresco/service/cmr/model/SubFolderFilter.java +++ b/source/java/org/alfresco/service/cmr/model/SubFolderFilter.java @@ -8,7 +8,7 @@ import org.alfresco.service.cmr.repository.ChildAssociationRef; /** * Interface to determine which sub-folders to search during deep listing. * - * @See FileFolderService + * @see FileFolderService */ @AlfrescoPublicApi public interface SubFolderFilter diff --git a/source/java/org/alfresco/service/cmr/preference/PreferenceService.java b/source/java/org/alfresco/service/cmr/preference/PreferenceService.java index 1087265d32..af92773834 100644 --- a/source/java/org/alfresco/service/cmr/preference/PreferenceService.java +++ b/source/java/org/alfresco/service/cmr/preference/PreferenceService.java @@ -37,7 +37,7 @@ public interface PreferenceService * Get all preferences for a particular user * * @param userName the user name - * @return Map a map containing the preference values, empty if none + * @return a map containing the preference values, empty if none */ @Auditable(parameters = {"userName"}) Map getPreferences(String userName); @@ -55,7 +55,7 @@ public interface PreferenceService * * @param userName the user name * @param preferenceFilter the preference filter - * @return Map a map containing the preference values, empty if none + * @return a map containing the preference values, empty if none */ @Auditable(parameters = {"userName", "preferenceFilter"}) Map getPreferences(String userName, String preferenceFilter); diff --git a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java index a4481963ed..74415c6b2b 100644 --- a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java +++ b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java @@ -26,12 +26,12 @@ import org.alfresco.service.cmr.repository.NodeRef; * @since 4.0 */ public class NodePublishStatusNotPublished extends BaseNodePublishStatus -{ - /** - * @param node - * @param channelName TODO - */ - public NodePublishStatusNotPublished(NodeRef node, String channelName) +{ + /** + * @param node NodeRef + * @param channelName TODO + */ + public NodePublishStatusNotPublished(NodeRef node, String channelName) { super(node, channelName); } diff --git a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublished.java b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublished.java index dfe782eb4c..81a5673fde 100644 --- a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublished.java +++ b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublished.java @@ -47,7 +47,7 @@ public class NodePublishStatusPublished extends BaseNodePublishStatus /** * Retrieve the most recent publishing event that affected (created or updated) the node relevant to this status. - * @return + * @return PublishingEvent */ public PublishingEvent getLatestPublishingEvent() { diff --git a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java index 9a1f1aaadf..5349f2a89d 100644 --- a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java +++ b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java @@ -30,12 +30,12 @@ public class NodePublishStatusPublishedAndOnQueue extends BaseNodePublishStatus private final PublishingEvent queuedPublishingEvent; private final PublishingEvent latestPublishingEvent; - - /** - * @param nodeRef - * @param channelName TODO - * @param queuedPublishingEvent The next scheduled {@link PublishingEvent} on the {@link PublishingQueue} - * @param latestPublishingEvent The last {@link PublishingEvent} to successfully publish the node. + + /** + * @param nodeRef NodeRef + * @param channelName TODO + * @param queuedPublishingEvent The next scheduled {@link PublishingEvent} on the {@link PublishingQueue} + * @param latestPublishingEvent The last {@link PublishingEvent} to successfully publish the node. */ public NodePublishStatusPublishedAndOnQueue(NodeRef nodeRef, String channelName, PublishingEvent queuedPublishingEvent, PublishingEvent latestPublishingEvent) @@ -61,7 +61,7 @@ public class NodePublishStatusPublishedAndOnQueue extends BaseNodePublishStatus /** * Retrieve the most recent publishing event that affected (created or updated) the node relevant to this status. - * @return + * @return PublishingEvent */ public PublishingEvent getLatestPublishingEvent() { diff --git a/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java b/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java index 5076e9440d..8b5898c04d 100644 --- a/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java +++ b/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java @@ -45,19 +45,19 @@ public interface Channel /** * Retrieve the node ref of the node that represents this channel object in the repository - * @return + * @return NodeRef */ NodeRef getNodeRef(); /** * Retrieve the name of this channel - * @return + * @return String */ String getName(); /** * Retrieve the properties defined on this channel. - * @return + * @return Map */ Map getProperties(); @@ -71,13 +71,13 @@ public interface Channel * will be truncated in preference to the URL. This argument may be null. */ void sendStatusUpdate(String status, String urlToAppend); - - /** - * Returns the URL for the specified node on this channel. - * @param publishedNode The content node whose published URL is being requested. - * @return a URL for the published content. May return null if the specified node has not - * been published to this channel. - */ + + /** + * Returns the URL for the specified node on this channel. + * @param publishedNode The content node whose published URL is being requested. + * @return a URL for the published content. May return null if the specified node has not + * been published to this channel. + */ String getUrl(NodeRef publishedNode); /** @@ -96,7 +96,7 @@ public interface Channel * If the {@link ChannelType} does not support publishing, if the {@link Channel} is not authorised or if the * currently authenticated user does not have permission to publish to this {@link Channel} then this * method will return false. - * @return + * @return boolean */ boolean canPublish(); @@ -105,7 +105,7 @@ public interface Channel * If the {@link ChannelType} does not support unpublishing, if the {@link Channel} is not authorised or if the * currently authenticated user does not have permission to publish to this {@link Channel} then this method * will return false. - * @return + * @return boolean */ boolean canUnpublish(); @@ -114,7 +114,7 @@ public interface Channel * If the {@link ChannelType} does not support publishing of status updates, if the {@link Channel} is not authorised * or if the currently authenticated user does not have permission to publish to this {@link Channel} then this method * will return false. - * @return + * @return boolean */ boolean canPublishStatusUpdates(); diff --git a/source/java/org/alfresco/service/cmr/publishing/channels/ChannelService.java b/source/java/org/alfresco/service/cmr/publishing/channels/ChannelService.java index bd0ee3d488..4a0e596bad 100644 --- a/source/java/org/alfresco/service/cmr/publishing/channels/ChannelService.java +++ b/source/java/org/alfresco/service/cmr/publishing/channels/ChannelService.java @@ -119,8 +119,8 @@ public interface ChannelService /** * Returns a list of all the channels that are capable of publishing the specified NodeRef. - * @param nodeToPublish - * @return + * @param nodeToPublish NodeRef + * @return List */ @NotAuditable List getRelevantPublishingChannels(NodeRef nodeToPublish); @@ -129,7 +129,7 @@ public interface ChannelService * Returns a list of all the channels that are capable of publishing in the specified Share site. * @param filterByPublishPermission If true then the returned channels are filtered to include only those * to which the authenticated user can publish - * @return + * @return List */ @NotAuditable List getPublishingChannels(boolean filterByPublishPermission); @@ -138,7 +138,7 @@ public interface ChannelService * Returns all {@link Channel}s cpaable of performing a status update for the given Share Site. * @param filterByPublishPermission If true then the returned channels are filtered to include only those * to which the authenticated user can post status updates - * @return + * @return List */ @NotAuditable List getStatusUpdateChannels(boolean filterByPublishPermission); diff --git a/source/java/org/alfresco/service/cmr/publishing/channels/ChannelType.java b/source/java/org/alfresco/service/cmr/publishing/channels/ChannelType.java index 6e7bdb3612..49d96e49ed 100644 --- a/source/java/org/alfresco/service/cmr/publishing/channels/ChannelType.java +++ b/source/java/org/alfresco/service/cmr/publishing/channels/ChannelType.java @@ -57,47 +57,47 @@ public interface ChannelType /** * Returns the unique identifier of this channel type - * @return + * @return String */ String getId(); /** * Returns the title (display name) of this channel type. * The title may be localised, but this is implementation specific - * @return + * @return String */ String getTitle(); /** * Each channel is stored in the repository as a node. This operation returns * the qualified name of the type of that node. - * @return + * @return QName */ QName getChannelNodeType(); /** * Does this channel type support publishing content? - * @return + * @return boolean */ boolean canPublish(); /** * Does this channel type support unpublishing content? That is to say, once content has been published * to a channel of this type, can it later be removed from that channel? - * @return + * @return boolean */ boolean canUnpublish(); /** * Does this channel type support status updates? - * @return + * @return boolean */ boolean canPublishStatusUpdates(); /** * Send the specified status update to the specified channel - * @param channel - * @param status + * @param channel Channel + * @param status String */ void sendStatusUpdate(Channel channel, String status); diff --git a/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java b/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java index 3e7ec13dce..808d554ddc 100644 --- a/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java +++ b/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java @@ -45,24 +45,24 @@ public interface QuickShareService /** * Get QuickShare related metadata for the given node. * - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return Map */ public Map getMetaData(NodeRef nodeRef) throws QuickShareDisabledException, InvalidNodeRefException; /** * Get QuickShare related metadata for the given shareId. - * - * @param shareId - * @return + * + * @param shareId String + * @return Map */ public Map getMetaData(String shareId) throws QuickShareDisabledException, InvalidSharedIdException; /** * Get the tenant domain and node reference for the the given share id. * - * @param sharedId - * @return + * @param sharedId String + * @return Pair */ public Pair getTenantNodeRefFromSharedId(String sharedId) throws QuickShareDisabledException, InvalidSharedIdException; diff --git a/source/java/org/alfresco/service/cmr/rendition/RenditionService.java b/source/java/org/alfresco/service/cmr/rendition/RenditionService.java index 42f6619897..8738b4ffb3 100644 --- a/source/java/org/alfresco/service/cmr/rendition/RenditionService.java +++ b/source/java/org/alfresco/service/cmr/rendition/RenditionService.java @@ -162,7 +162,7 @@ public interface RenditionService extends RenditionDefinitionPersister * rendition node, else false. A nodeRef is a rendition node * if it has the rn:rendition aspect (or sub-aspect) applied. * - * @param node + * @param node NodeRef * @return true if a rendition, else false */ @NotAuditable diff --git a/source/java/org/alfresco/service/cmr/repository/AbstractTransformationSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/AbstractTransformationSourceOptions.java index 26c78823fc..4d99d6e061 100644 --- a/source/java/org/alfresco/service/cmr/repository/AbstractTransformationSourceOptions.java +++ b/source/java/org/alfresco/service/cmr/repository/AbstractTransformationSourceOptions.java @@ -86,7 +86,7 @@ public abstract class AbstractTransformationSourceOptions implements Transformat * one, merging any non-null overriding fields in the given * overridingOptions * - * @param overridingOptions + * @param overridingOptions TransformationSourceOptions * @return a merged TransformationSourceOptions object */ public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions) @@ -108,9 +108,9 @@ public abstract class AbstractTransformationSourceOptions implements Transformat /** * Adds the given paramValue to the given params if it's not null. * - * @param paramName - * @param paramValue - * @param params + * @param paramName String + * @param paramValue Serializable + * @param params Map */ protected void putParameterIfNotNull(String paramName, Serializable paramValue, Map params) { diff --git a/source/java/org/alfresco/service/cmr/repository/ContentService.java b/source/java/org/alfresco/service/cmr/repository/ContentService.java index 8185b75545..6ba3000900 100644 --- a/source/java/org/alfresco/service/cmr/repository/ContentService.java +++ b/source/java/org/alfresco/service/cmr/repository/ContentService.java @@ -167,35 +167,35 @@ public interface ContentService @Auditable(parameters = {"reader", "writer"}) public void transform(ContentReader reader, ContentWriter writer) throws NoTransformerException, ContentIOException; - - - /** - * @see ContentService#transform(ContentReader, ContentWriter) - * @see ContentService#transform(ContentReader, ContentWriter, TransformationOptions) - * - * A map of transform options can be provided. - * + + + /** + * @see ContentService#transform(ContentReader, ContentWriter) + * @see ContentService#transform(ContentReader, ContentWriter, TransformationOptions) + * + * A map of transform options can be provided. + * * @param reader the source content location and mimetype * @param writer the target content location and mimetype * @param options the options for the transformation * @throws NoTransformerException if no transformer exists for the - * given source and target mimetypes of the reader and writer - * @throws ContentIOException if the transformation fails - * - * @deprecated - * As of release 3.0 the TransformOptions class should be used to pass transformation options - * to a transformation execution. - */ + * given source and target mimetypes of the reader and writer + * @throws ContentIOException if the transformation fails + * + * @deprecated + * As of release 3.0 the TransformOptions class should be used to pass transformation options + * to a transformation execution. + */ @Auditable(parameters = {"reader", "writer", "options"}) @Deprecated public void transform(ContentReader reader, ContentWriter writer, Map options) - throws NoTransformerException, ContentIOException; - - /** - * @see ContentService#transform(ContentReader, ContentWriter) - * - * A transformation options can be provided. - * + throws NoTransformerException, ContentIOException; + + /** + * @see ContentService#transform(ContentReader, ContentWriter) + * + * A transformation options can be provided. + * * @param reader the source content location and mimetype * @param writer the target content location and mimetype * @param options the options for the transformation @@ -211,17 +211,17 @@ public interface ContentService * Fetch the transformer that is capable of transforming the content in the * given source mimetype to the given target mimetype. *

      - * Since no transformation options are provided only the source and destination mimetypes are - * considered when getting the correct transformer. - * - * @param sourceMimetype the source mimetype - * @param targetMimetype the target mimetype - * @return Returns a transformer that can be used, or null if one was not available - * - * @see ContentService#getTransformer(String, String, long, String, TransformationOptions) - * @see ContentAccessor#getMimetype() - */ - @Auditable(parameters = {"sourceMimetype", "targetMimetype"}) + * Since no transformation options are provided only the source and destination mimetypes are + * considered when getting the correct transformer. + * + * @param sourceMimetype the source mimetype + * @param targetMimetype the target mimetype + * @return Returns a transformer that can be used, or null if one was not available + * + * @see ContentService#getTransformer(String, String, long, String, TransformationOptions) + * @see ContentAccessor#getMimetype() + */ + @Auditable(parameters = {"sourceMimetype", "targetMimetype"}) public ContentTransformer getTransformer(String sourceMimetype, String targetMimetype); /** @@ -269,26 +269,26 @@ public interface ContentService */ public ContentTransformer getTransformer(String sourceMimetype, String targetMimetype, TransformationOptions options); - /** - * Returns the maximum source size of any content that may transformed between the supplied - * mimetypes using the supplied options. - * @param sourceMimetype source mime type - * @param targetMimetype target mime type - * @param options transformation options - * @return 0 if there are no transformers, -1 if there is no limit or if positive number the size in bytes. - */ - @Auditable(parameters = {"sourceMimetype", "targetMimetype", "options"}) + /** + * Returns the maximum source size of any content that may transformed between the supplied + * mimetypes using the supplied options. + * @param sourceMimetype source mime type + * @param targetMimetype target mime type + * @param options transformation options + * @return 0 if there are no transformers, -1 if there is no limit or if positive number the size in bytes. + */ + @Auditable(parameters = {"sourceMimetype", "targetMimetype", "options"}) public long getMaxSourceSizeBytes(String sourceMimetype, String targetMimetype, TransformationOptions options); /** - * @deprecated use {@link #getTransformers(String, String, long, String, TransformationOptions). + * @deprecated use {@link #getTransformers(String, String, long, String, TransformationOptions)}. * @since 3.5 */ @Auditable(parameters = {"sourceMimetype", "sourceSize", "targetMimetype", "options"}) public List getActiveTransformers(String sourceMimetype, long sourceSize, String targetMimetype, TransformationOptions options); /** - * @deprecated use {@link #getTransformers(String, String, long, String, TransformationOptions). + * @deprecated use {@link #getTransformers(String, String, long, String, TransformationOptions)}. */ public List getActiveTransformers(String sourceMimetype, String targetMimetype, TransformationOptions options); @@ -298,13 +298,13 @@ public interface ContentService * @return Returns a transformer that can be used, or null if one was not available */ @Auditable - public ContentTransformer getImageTransformer(); - - /** - * @deprecated use {@link #isTransformable(ContentReader, ContentWriter, TransformationOptions). - */ - @Auditable(parameters = {"reader", "writer"}) - public boolean isTransformable(ContentReader reader, ContentWriter writer); + public ContentTransformer getImageTransformer(); + + /** + * @deprecated use {@link #isTransformable(ContentReader, ContentWriter, TransformationOptions)}. + */ + @Auditable(parameters = {"reader", "writer"}) + public boolean isTransformable(ContentReader reader, ContentWriter writer); /** * Returns whether a transformer exists that can read the content from diff --git a/source/java/org/alfresco/service/cmr/repository/ScriptService.java b/source/java/org/alfresco/service/cmr/repository/ScriptService.java index 2bb450f608..d28e07ed62 100644 --- a/source/java/org/alfresco/service/cmr/repository/ScriptService.java +++ b/source/java/org/alfresco/service/cmr/repository/ScriptService.java @@ -172,7 +172,7 @@ public interface ScriptService /** * Registers a script processor with the script service * - * @param scriptProcessor + * @param scriptProcessor ScriptProcessor */ @Auditable(parameters = {"scriptProcessor"}) public void registerScriptProcessor(ScriptProcessor scriptProcessor); @@ -188,7 +188,6 @@ public interface ScriptService * Add core data-model to provided Map * * @param inputMap initial Map of global scope scriptable Node objects - * @return A Map of global scope scriptable Node objects */ @Auditable(parameters = {"inputMap"}) public void buildCoreModel(Map inputMap); diff --git a/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java b/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java index d4be73009f..25bf82196e 100644 --- a/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java +++ b/source/java/org/alfresco/service/cmr/repository/SerializedTransformationOptionsAccessor.java @@ -48,10 +48,10 @@ public interface SerializedTransformationOptionsAccessor * throws a {@link RenditionServiceException} if it isn't. Returns * defaultValue if the parameter value is null * - * @param - * @param paramName - * @param defaultValue - * @return + * @param + * @param paramName String + * @param defaultValue + * @return */ public T getParamWithDefault(String paramName, T defaultValue); @@ -59,9 +59,9 @@ public interface SerializedTransformationOptionsAccessor * Gets the int value for the named parameter. Returns * defaultValue if the parameter value is null. * - * @param key - * @param defaultValue - * @return + * @param key String + * @param defaultValue int + * @return int */ public int getIntegerParam(String key, int defaultValue); diff --git a/source/java/org/alfresco/service/cmr/repository/TemplateException.java b/source/java/org/alfresco/service/cmr/repository/TemplateException.java index c0a1005ec7..c73fbf4f8c 100644 --- a/source/java/org/alfresco/service/cmr/repository/TemplateException.java +++ b/source/java/org/alfresco/service/cmr/repository/TemplateException.java @@ -28,7 +28,7 @@ public class TemplateException extends AlfrescoRuntimeException private static final long serialVersionUID = 2863142603098852564L; /** - * @param msgId + * @param msgId String */ public TemplateException(String msgId) { @@ -36,8 +36,8 @@ public class TemplateException extends AlfrescoRuntimeException } /** - * @param msgId - * @param cause + * @param msgId String + * @param cause Throwable */ public TemplateException(String msgId, Throwable cause) { @@ -45,8 +45,8 @@ public class TemplateException extends AlfrescoRuntimeException } /** - * @param msgId - * @param params + * @param msgId String + * @param params Object[] */ public TemplateException(String msgId, Object[] params) { @@ -54,9 +54,9 @@ public class TemplateException extends AlfrescoRuntimeException } /** - * @param msgId - * @param msgParams - * @param cause + * @param msgId String + * @param msgParams Object[] + * @param cause Throwable */ public TemplateException(String msgId, Object[] msgParams, Throwable cause) { diff --git a/source/java/org/alfresco/service/cmr/repository/TemplateService.java b/source/java/org/alfresco/service/cmr/repository/TemplateService.java index 080be0b22f..9d6cf88d9e 100644 --- a/source/java/org/alfresco/service/cmr/repository/TemplateService.java +++ b/source/java/org/alfresco/service/cmr/repository/TemplateService.java @@ -176,7 +176,7 @@ public interface TemplateService * @param userHome the user home node reference * @param template the node ref for the template (optional) * @param imageResolver the image resolver (optional) - * @return + * @return Map */ @Auditable(parameters = {"person", "companyHome", "userHome", "template", "imageResolver"}) public Map buildDefaultModel( diff --git a/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java index 284f28c807..4df4f5943b 100644 --- a/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java +++ b/source/java/org/alfresco/service/cmr/repository/TemporalSourceOptions.java @@ -73,7 +73,7 @@ public class TemporalSourceOptions extends AbstractTransformationSourceOptions * Sets the offset time code from which to start the transformation * with a format of hh:mm:ss[.xxx] * - * @param offset + * @param offset String */ public void setOffset(String offset) { @@ -85,7 +85,7 @@ public class TemporalSourceOptions extends AbstractTransformationSourceOptions * Gets the duration of the source to read * with a format of hh:mm:ss[.xxx] * - * @return + * @return String */ public String getDuration() { @@ -96,7 +96,7 @@ public class TemporalSourceOptions extends AbstractTransformationSourceOptions * Sets the duration of the source to read * with a format of hh:mm:ss[.xxx] * - * @param duration + * @param duration String */ public void setDuration(String duration) { @@ -107,7 +107,7 @@ public class TemporalSourceOptions extends AbstractTransformationSourceOptions /** * Validates that the given value is of the form hh:mm:ss[.xxx] * - * @param value + * @param value String */ public static void validateTimeString(String value) { diff --git a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java index 8949958612..ccd31d776c 100644 --- a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java +++ b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java @@ -157,7 +157,7 @@ public class TransformationOptions implements Cloneable /** * Sets options from the supplied map. - * @param optionsMap + * @param optionsMap Map */ public void set(Map optionsMap) { @@ -505,7 +505,7 @@ public class TransformationOptions implements Cloneable * Note that if source options of the same class already exists a new * merged source options object is added. * - * @param sourceOptions + * @param sourceOptions TransformationSourceOptions */ public void addSourceOptions(TransformationSourceOptions sourceOptions) { @@ -525,7 +525,7 @@ public class TransformationOptions implements Cloneable /** * Gets the appropriate source options for the given mimetype if available. * - * @param clazz + * @param clazz Class * @return the source options for the mimetype */ @SuppressWarnings("unchecked") diff --git a/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java b/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java index 34d40e8da4..dc46ef79c3 100644 --- a/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java +++ b/source/java/org/alfresco/service/cmr/repository/TransformationSourceOptions.java @@ -69,7 +69,7 @@ public interface TransformationSourceOptions * one, merging any non-null overriding fields in the given * overridingOptions * - * @param overridingOptions + * @param overridingOptions TransformationSourceOptions * @return a merged TransformationSourceOptions object */ public TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions); @@ -96,15 +96,15 @@ public interface TransformationSourceOptions /** * Serializes the given transformation source options into the given parameter map. * - * @param transformationSourceOptions - * @param parameters + * @param transformationSourceOptions TransformationSourceOptions + * @param parameters Map */ public void serialize(TransformationSourceOptions transformationSourceOptions, Map parameters); /** * Gets the parameters from the serialized options accessor and builds a source options object. * - * @param serializedOptions + * @param serializedOptions SerializedTransformationOptionsAccessor * @return the deserialized source options */ public TransformationSourceOptions deserialize(SerializedTransformationOptionsAccessor serializedOptions); diff --git a/source/java/org/alfresco/service/cmr/rule/RuleService.java b/source/java/org/alfresco/service/cmr/rule/RuleService.java index 526fe6190b..37f8fc1f91 100644 --- a/source/java/org/alfresco/service/cmr/rule/RuleService.java +++ b/source/java/org/alfresco/service/cmr/rule/RuleService.java @@ -107,7 +107,7 @@ public interface RuleService /** * Disables a rule, preventing it from being fired. * - * @See enableRule + * @see #enableRule(Rule) * * @param rule the rule to disable */ @@ -117,7 +117,7 @@ public interface RuleService /** * Enables a rule previously disabled. * - * @See diableRule + * @see #disableRule(Rule) * * @param rule the rule to enable */ @@ -223,35 +223,35 @@ public interface RuleService * If the rule is already associated with the node, the details are updated * with those specified. * - * @param nodeRef - * @param rule + * @param nodeRef NodeRef + * @param rule Rule */ @Auditable(parameters = {"nodeRef", "rule"}) public void saveRule(NodeRef nodeRef, Rule rule); /** * - * @param nodeRef - * @param rule - * @param index + * @param nodeRef NodeRef + * @param rule Rule + * @param index int */ @Auditable(parameters = {"nodeRef", "rule", "index"}) public void saveRule(NodeRef nodeRef, Rule rule, int index); /** * - * @param nodeRef - * @param ruleNodeRef - * @param index + * @param nodeRef NodeRef + * @param ruleNodeRef NodeRef + * @param index int */ @Auditable(parameters = {"nodeRef", "ruleNodeRef", "index"}) public void setRulePosition(NodeRef nodeRef, NodeRef ruleNodeRef, int index); /** * - * @param nodeRef - * @param rule - * @param index + * @param nodeRef NodeRef + * @param rule Rule + * @param index int */ @Auditable(parameters = {"nodeRef", "rule", "index"}) public void setRulePosition(NodeRef nodeRef, Rule rule, int index); diff --git a/source/java/org/alfresco/service/cmr/rule/RuleType.java b/source/java/org/alfresco/service/cmr/rule/RuleType.java index 605c40b187..3b31efcbb2 100644 --- a/source/java/org/alfresco/service/cmr/rule/RuleType.java +++ b/source/java/org/alfresco/service/cmr/rule/RuleType.java @@ -56,7 +56,7 @@ public interface RuleType * * @param nodeRef the node ref whos rule of rule type are to be triggered * @param actionedUponNodeRef the node ref that the triggered rule will action upon - * @prarm executeRuleImmediately indicates whether the rule should be executed immediately or not + * @param executeRuleImmediately indicates whether the rule should be executed immediately or not */ public void triggerRuleType(NodeRef nodeRef, NodeRef actionedUponNodeRef, boolean executeRuleImmediately); } \ No newline at end of file diff --git a/source/java/org/alfresco/service/cmr/search/CategoryService.java b/source/java/org/alfresco/service/cmr/search/CategoryService.java index 39124104f2..4c75c1c422 100644 --- a/source/java/org/alfresco/service/cmr/search/CategoryService.java +++ b/source/java/org/alfresco/service/cmr/search/CategoryService.java @@ -79,7 +79,8 @@ public interface CategoryService * Get a list of all the categories appropriate for a given property. * The full list of categories that may be assigned for this aspect. * - * @param aspectQName + * @param storeRef StoreRef + * @param aspectQName QName * @param depth - the enumeration depth for what level to recover * @return a collection of all the nodes found identified by their ChildAssocRef's */ @@ -89,7 +90,7 @@ public interface CategoryService /** * Get all the classification entries * - * @return + * @return Collection */ @Auditable(parameters = {"storeRef"}) public Collection getClassifications(StoreRef storeRef); @@ -97,9 +98,9 @@ public interface CategoryService /** * Get the root categories for an aspect/classification * - * @param storeRef - * @param aspectName - * @return + * @param storeRef StoreRef + * @param aspectName QName + * @return Collection */ @Auditable(parameters = {"storeRef", "aspectName"}) public Collection getRootCategories(StoreRef storeRef, QName aspectName); @@ -107,9 +108,11 @@ public interface CategoryService /** * Get a paged list of the root categories for an aspect/classification * - * @param storeRef - * @param aspectName - * @return + * @param storeRef StoreRef + * @param aspectName QName + * @param pagingRequest PagingRequest + * @param sortByName boolean + * @return PagingResults */ @Auditable(parameters = {"storeRef", "aspectName", "pagingRequest", "sortByName"}) PagingResults getRootCategories(StoreRef storeRef, QName aspectName, PagingRequest pagingRequest, boolean sortByName); @@ -117,10 +120,10 @@ public interface CategoryService /** * Get the root categories for an aspect/classification with names that start with filter * - * @param storeRef - * @param aspectName - * @param filter - * @return + * @param storeRef StoreRef + * @param aspectName QName + * @param filter String + * @return Collection */ @Auditable(parameters = {"storeRef", "aspectName"}) public Collection getRootCategories(StoreRef storeRef, QName aspectName, String filter); @@ -161,7 +164,7 @@ public interface CategoryService /** * Get all the types that represent categories * - * @return + * @return Collection */ @Auditable public Collection getClassificationAspects(); @@ -172,8 +175,9 @@ public interface CategoryService * This will extend the category types in the data dictionary * All it needs is the type name and the attribute in which to store noderefs to categories. * - * @param aspectName - * @param attributeName + * @param storeRef StoreRef + * @param aspectName QName + * @param attributeName String */ @Auditable(parameters = {"storeRef", "aspectName", "attributeName"}) public NodeRef createClassification(StoreRef storeRef, QName aspectName, String attributeName); @@ -181,10 +185,10 @@ public interface CategoryService /** * Create a new root category in the given classification * - * @param storeRef - * @param aspectName - * @param name - * @return + * @param storeRef StoreRef + * @param aspectName QName + * @param name String + * @return NodeRef */ @Auditable(parameters = {"storeRef", "aspectName", "name"}) public NodeRef createRootCategory(StoreRef storeRef, QName aspectName, String name); @@ -192,9 +196,9 @@ public interface CategoryService /** * Create a new category. * - * @param parent - * @param name - * @return + * @param parent NodeRef + * @param name String + * @return NodeRef */ @Auditable(parameters = {"parent", "name"}) public NodeRef createCategory(NodeRef parent, String name); @@ -202,8 +206,8 @@ public interface CategoryService /** * Delete a classification * - * @param storeRef - * @param aspectName + * @param storeRef StoreRef + * @param aspectName QName */ @Auditable(parameters = {"storeRef", "aspectName"}) public void deleteClassification(StoreRef storeRef, QName aspectName); @@ -211,7 +215,7 @@ public interface CategoryService /** * Delete a category * - * @param nodeRef + * @param nodeRef NodeRef */ @Auditable(parameters = {"nodeRef"}) public void deleteCategory(NodeRef nodeRef); @@ -219,10 +223,10 @@ public interface CategoryService /** * Get the most polular categories * - * @param storeRef - * @param aspectName - * @param count - * @return + * @param storeRef StoreRef + * @param aspectName QName + * @param count int + * @return List */ @Auditable(parameters = {"storeRef", "aspectName", "count"}) public List> getTopCategories(StoreRef storeRef, QName aspectName, int count); diff --git a/source/java/org/alfresco/service/cmr/search/SuggesterResult.java b/source/java/org/alfresco/service/cmr/search/SuggesterResult.java index 2627caaeed..57b21cc38b 100644 --- a/source/java/org/alfresco/service/cmr/search/SuggesterResult.java +++ b/source/java/org/alfresco/service/cmr/search/SuggesterResult.java @@ -35,7 +35,7 @@ public interface SuggesterResult /** * Get the number of suggestions * - * @return + * @return long */ long getNumberFound(); diff --git a/source/java/org/alfresco/service/cmr/security/AuthenticationService.java b/source/java/org/alfresco/service/cmr/security/AuthenticationService.java index 04cfd292bd..6c7dbc1c3e 100644 --- a/source/java/org/alfresco/service/cmr/security/AuthenticationService.java +++ b/source/java/org/alfresco/service/cmr/security/AuthenticationService.java @@ -78,7 +78,7 @@ public interface AuthenticationService /** * Get the name of the currently authenticated user. * - * @return + * @return String * @throws AuthenticationException */ @Auditable @@ -93,7 +93,7 @@ public interface AuthenticationService /** * Invalidate a single ticket by ID * - * @param ticket + * @param ticket String * @throws AuthenticationException */ @Auditable(parameters = {"ticket"}, recordable = {false}) @@ -102,7 +102,7 @@ public interface AuthenticationService /** * Validate a ticket. Set the current user name accordingly. * - * @param ticket + * @param ticket String * @throws AuthenticationException */ @Auditable(parameters = {"ticket"}, recordable = {false}) @@ -110,14 +110,14 @@ public interface AuthenticationService /** * Get the current ticket as a string - * @return + * @return String */ @Auditable public String getCurrentTicket(); /** * Get a new ticket as a string - * @return + * @return String */ @Auditable public String getNewTicket(); diff --git a/source/java/org/alfresco/service/cmr/security/AuthorityService.java b/source/java/org/alfresco/service/cmr/security/AuthorityService.java index 3eba09efe8..3990d89f8a 100644 --- a/source/java/org/alfresco/service/cmr/security/AuthorityService.java +++ b/source/java/org/alfresco/service/cmr/security/AuthorityService.java @@ -145,13 +145,13 @@ public interface AuthorityService * See also "getAuthorities" (paged) alternative * * @param type the type of authorities - cannot be null - * @return all authorities by type - * - * @deprecated use {@link #getAuthorities(AuthorityType, String, String, boolean, boolean, PagingRequest)} at least - * @see #getAuthorities (paged) - */ - @Auditable(parameters = {"type"}) - @Deprecated + * @return all authorities by type + * + * @deprecated use {@link #getAuthorities(AuthorityType, String, String, boolean, boolean, PagingRequest)} at least + * @see #getAuthorities (paged) + */ + @Auditable(parameters = {"type"}) + @Deprecated public Set getAllAuthorities(AuthorityType type); /** @@ -162,13 +162,13 @@ public interface AuthorityService * @param displayNameFilter optional filter (startsWith / ignoreCase) for authority display name (note: implied trailing "*") * @param sortBy either "displayName", "shortName", "authorityName" or null if no sorting. * note: for users, displayName/shortName is equivalent to the userName, for groups if the display is null then use the short name - * @param sortAscending if true then sort ascending else sort descending (ignore if sortByDisplayName is false) - * @param pagingRequest the requested page (skipCount, maxItems, queryExectionId) - * - * @throws org.alfresco.repo.security.authority.UnknownAuthorityException - if zoneName is not null and does not exist - * - * @author janv - * @since 4.0 + * @param sortAscending if true then sort ascending else sort descending (ignore if sortByDisplayName is false) + * @param pagingRequest the requested page (skipCount, maxItems, queryExectionId) + * + * @throws org.alfresco.repo.security.authority.UnknownAuthorityException - if zoneName is not null and does not exist + * + *

      author janv + * @since 4.0 */ @Auditable(parameters = {"type", "zoneName", "displayNameFilter", "sortByDisplayName", "sortAscending", "pagingRequest"}) public PagingResults getAuthoritiesInfo(AuthorityType type, String zoneName, String displayNameFilter, String sortBy, boolean sortAscending, PagingRequest pagingRequest); @@ -181,13 +181,13 @@ public interface AuthorityService * @param displayNameFilter optional filter (startsWith / ignoreCase) for authority display name (note: implied trailing "*") * @param sortByDisplayName if true then sort (ignoring case) by the authority display name, if false then unsorted * note: for users, displayName/shortName is equivalent to the userName, for groups if the display is null then use the short name - * @param sortAscending if true then sort ascending else sort descending (ignore if sortByDisplayName is false) - * @param pagingRequest the requested page (skipCount, maxItems, queryExectionId) - * - * @throws org.alfresco.repo.security.authority.UnknownAuthorityException - if zoneName is not null and does not exist - * - * @author janv - * @since 4.0 + * @param sortAscending if true then sort ascending else sort descending (ignore if sortByDisplayName is false) + * @param pagingRequest the requested page (skipCount, maxItems, queryExectionId) + * + * @throws org.alfresco.repo.security.authority.UnknownAuthorityException - if zoneName is not null and does not exist + * + *

      author janv + * @since 4.0 */ @Auditable(parameters = {"type", "zoneName", "displayNameFilter", "sortByDisplayName", "sortAscending", "pagingRequest"}) public PagingResults getAuthorities(AuthorityType type, String zoneName, String displayNameFilter, boolean sortByDisplayName, boolean sortAscending, PagingRequest pagingRequest); @@ -224,13 +224,13 @@ public interface AuthorityService * @param type * the type of the authority * @param shortName - * the short name of the authority to create - * @param authorityDisplayName - * the display name for the authority - * @param authorityZones - * identifier for external user registry owning the authority or null if not applicable - * @return the full name of the authority (this will be the prefix, if any associated with the type appended with - * the short name) + * the short name of the authority to create + * @param authorityDisplayName + * the display name for the authority + * @param authorityZones + * identifier for external user registry owning the authority or null if not applicable + * @return the full name of the authority (this will be the prefix, if any associated with the type appended with + * the short name) */ @Auditable(parameters = {"type", "shortName", "authorityDisplayName", "authorityZones"}) public String createAuthority(AuthorityType type, String shortName, String authorityDisplayName, Set authorityZones); @@ -276,7 +276,7 @@ public interface AuthorityService /** * Delete an authority and all its relationships. Note child authorities are not deleted. * - * @param name + * @param name String */ @Auditable(parameters = {"name"}) public void deleteAuthority(String name); @@ -306,19 +306,19 @@ public interface AuthorityService * @param immediate - * if true, limit the depth to just immediate child, if false * find authorities at any depth - * @return + * @return Set */ @Auditable(parameters = {"type", "name", "immediate"}) public Set getContainedAuthorities(AuthorityType type, String name, boolean immediate); /** - * Get the authorities that contain the given authority, - * but use {@code getAuthoritiesForUser(userName).contains(authority)} rather than - * {@code getContainingAuthorities(type, userName, false).contains(authority)} or - * use {@link #getContainingAuthoritiesInZone(AuthorityType, String, AuthorityService#ZONE_APP_DEFAULT, AuthorityFilter, int)} - * as they will be much faster. - * - * For example, this method can be used find out all the authorities that contain a + * Get the authorities that contain the given authority, + * but use {@code getAuthoritiesForUser(userName).contains(authority)} rather than + * {@code getContainingAuthorities(type, userName, false).contains(authority)} or + * use {@link #getContainingAuthoritiesInZone(AuthorityType, String, String, AuthorityFilter, int)} + * as they will be much faster. + * + * For example, this method can be used find out all the authorities that contain a * group. * * @param type - @@ -328,7 +328,7 @@ public interface AuthorityService * are required. * @param immediate - * limit to immediate parents or any ancestor. - * @return + * @return Set */ @Auditable(parameters = {"type", "name", "immediate"}) public Set getContainingAuthorities(AuthorityType type, String name, boolean immediate); @@ -361,8 +361,8 @@ public interface AuthorityService /** * Extract the short name of an authority from its full identifier. * - * @param name - * @return + * @param name String + * @return String */ @Auditable(parameters = {"name"}) public String getShortName(String name); @@ -371,9 +371,9 @@ public interface AuthorityService * Create the full identifier for an authority given its short name and * type. * - * @param type - * @param shortName - * @return + * @param type AuthorityType + * @param shortName String + * @return String */ @Auditable(parameters = {"type", "shortName"}) public String getName(AuthorityType type, String shortName); @@ -400,8 +400,8 @@ public interface AuthorityService * Set the display name for the given authority. * Setting the display name is only supported for authorities of type group * - * @param authorityName - * @param authorityDisplayName + * @param authorityName String + * @param authorityDisplayName String */ @Auditable(parameters = {"authorityName", "authorityDisplayName"}) public void setAuthorityDisplayName(String authorityName, String authorityDisplayName); @@ -438,13 +438,13 @@ public interface AuthorityService /** * Gets the name of the zone containing the specified authority. - * - * @param name - * the authority long name - * @return the the name of the zone containing the specified authority, {@link AuthorityService#ZONE_APP_DEFAULT} if the - * authority exists but has no zone, or null if the authority does not exist. - */ - @Auditable(parameters = {"name"}) + * + * @param name + * the authority long name + * @return the the name of the zone containing the specified authority, {@link AuthorityService#ZONE_APP_DEFAULT} if the + * authority exists but has no zone, or null if the authority does not exist. + */ + @Auditable(parameters = {"name"}) public Set getAuthorityZones(String name); /** @@ -453,13 +453,13 @@ public interface AuthorityService * See also "getAuthorities" paged alternative (note: in that case, zone must exist) * * @param zoneName the zone name - note: if zone does not exist then will currently return empty set - * @param type the authority type to filter by or null for all authority types - * @return the names of all authorities in a zone, optionally filtered by type - * - * @see #getAuthorities (paged) - */ - @Auditable(parameters = {"zoneName", "type"}) - public Set getAllAuthoritiesInZone(String zoneName, AuthorityType type); + * @param type the authority type to filter by or null for all authority types + * @return the names of all authorities in a zone, optionally filtered by type + * + * @see #getAuthorities (paged) + */ + @Auditable(parameters = {"zoneName", "type"}) + public Set getAllAuthoritiesInZone(String zoneName, AuthorityType type); /** * Gets the names of all root authorities in a zone, optionally filtered by type. @@ -473,21 +473,21 @@ public interface AuthorityService @Auditable(parameters = {"zoneName", "type"}) public Set getAllRootAuthoritiesInZone(String zoneName, AuthorityType type); - /** - * Add a zone to an authority. - * @param authorityName - * @param zones - */ - @Auditable(parameters = {"authorityName", "zones"}) - public void addAuthorityToZones(String authorityName, Set zones); + /** + * Add a zone to an authority. + * @param authorityName String + * @param zones Set + */ + @Auditable(parameters = {"authorityName", "zones"}) + public void addAuthorityToZones(String authorityName, Set zones); - /** - * Remove a zone from an authority - * @param authorityName - * @param zones - */ - @Auditable(parameters = {"authorityName", "zones"}) - public void removeAuthorityFromZones(String authorityName, Set zones); + /** + * Remove a zone from an authority + * @param authorityName String + * @param zones Set + */ + @Auditable(parameters = {"authorityName", "zones"}) + public void removeAuthorityFromZones(String authorityName, Set zones); /** * Get the name of the default zone. @@ -500,12 +500,12 @@ public interface AuthorityService * Search for authorities by pattern matching (* and ?) against the authority name. * Note: This will use a search index to find the results (eg. via Lucene / SOLR). * - * @param type + * @param type AuthorityType * @param parentAuthority if non-null, will look only for authorities who are a child of the named parent * @param immediate if true then only search root groups if parentAuthority is null, or immediate children of parentAuthority if it is non-null. - * @param displayNamePattern + * @param displayNamePattern String * @param zoneName - may be null to indicate all zones - * @return + * @return Set */ @Auditable(parameters = {"type"}) public Set findAuthorities(AuthorityType type, String parentAuthority, boolean immediate, String displayNamePattern, String zoneName); diff --git a/source/java/org/alfresco/service/cmr/security/MutableAuthenticationService.java b/source/java/org/alfresco/service/cmr/security/MutableAuthenticationService.java index fc8b3a0bfb..6543ac905b 100644 --- a/source/java/org/alfresco/service/cmr/security/MutableAuthenticationService.java +++ b/source/java/org/alfresco/service/cmr/security/MutableAuthenticationService.java @@ -50,8 +50,8 @@ public interface MutableAuthenticationService extends AuthenticationService /** * Create an authentication for the given user. * - * @param userName - * @param password + * @param userName String + * @param password char[] * @throws AuthenticationException */ @Auditable(parameters = {"userName", "password"}, recordable = {true, false}) @@ -60,9 +60,9 @@ public interface MutableAuthenticationService extends AuthenticationService /** * Update the login information for the user (typically called by the user) * - * @param userName - * @param oldPassword - * @param newPassword + * @param userName String + * @param oldPassword char[] + * @param newPassword char[] * @throws AuthenticationException */ @Auditable(parameters = {"userName", "oldPassword", "newPassword"}, recordable = {true, false, false}) @@ -71,8 +71,8 @@ public interface MutableAuthenticationService extends AuthenticationService /** * Set the login information for a user (typically called by an admin user) * - * @param userName - * @param newPassword + * @param userName String + * @param newPassword char[] * @throws AuthenticationException */ @Auditable(parameters = {"userName", "newPassword"}, recordable = {true, false}) @@ -82,7 +82,7 @@ public interface MutableAuthenticationService extends AuthenticationService /** * Delete an authentication entry * - * @param userName + * @param userName String * @throws AuthenticationException */ @Auditable(parameters = {"userName"}) @@ -91,8 +91,8 @@ public interface MutableAuthenticationService extends AuthenticationService /** * Enable or disable an authentication entry * - * @param userName - * @param enabled + * @param userName String + * @param enabled boolean */ @Auditable(parameters = {"userName", "enabled"}) public void setAuthenticationEnabled(String userName, boolean enabled) throws AuthenticationException; diff --git a/source/java/org/alfresco/service/cmr/security/OwnableService.java b/source/java/org/alfresco/service/cmr/security/OwnableService.java index 9894c191e2..3956211d4b 100644 --- a/source/java/org/alfresco/service/cmr/security/OwnableService.java +++ b/source/java/org/alfresco/service/cmr/security/OwnableService.java @@ -34,7 +34,7 @@ public interface OwnableService /** * Get the username of the owner of the given object. * - * @param nodeRef + * @param nodeRef NodeRef * @return the username or null if the object has no owner */ @Auditable(parameters = {"nodeRef"}) @@ -43,8 +43,8 @@ public interface OwnableService /** * Set the owner of the object. * - * @param nodeRef - * @param userName + * @param nodeRef NodeRef + * @param userName String */ @Auditable(parameters = {"nodeRef", "userName"}) public void setOwner(NodeRef nodeRef, String userName); @@ -52,7 +52,7 @@ public interface OwnableService /** * Set the owner of the object to be the current user. * - * @param nodeRef + * @param nodeRef NodeRef */ @Auditable(parameters = {"nodeRef"}) public void takeOwnership(NodeRef nodeRef); @@ -60,8 +60,8 @@ public interface OwnableService /** * Does the given node have an owner? * - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return boolean */ @Auditable(parameters = {"nodeRef"}) public boolean hasOwner(NodeRef nodeRef); diff --git a/source/java/org/alfresco/service/cmr/security/PersonService.java b/source/java/org/alfresco/service/cmr/security/PersonService.java index ee2b3211f6..6ce0d443bb 100644 --- a/source/java/org/alfresco/service/cmr/security/PersonService.java +++ b/source/java/org/alfresco/service/cmr/security/PersonService.java @@ -86,7 +86,7 @@ public interface PersonService * Retrieve the person NodeRef for a {@code username}, optionally creating * the home folder if it does not exist and optionally creating the person * if they don't exist AND the PersonService is configured to allow the - * creation of missing persons {@see #setCreateMissingPeople(boolean)}. + * creation of missing persons {@link #setCreateMissingPeople(boolean)}. * * If not allowed to create missing persons and the person does not exist * a {@code NoSuchPersonException} exception will be thrown. @@ -105,13 +105,13 @@ public interface PersonService @Auditable(parameters = {"userName", "autoCreate"}) public NodeRef getPerson(final String userName, final boolean autoCreateHomeFolderAndMissingPersonIfAllowed); - /** - * Retrieve the person info for an existing {@code person NodeRef} - * - * @param personRef NodeRef - * @return PersonInfo (username, firstname, lastname) - * @throws NoSuchPersonException if the person doesn't exist - */ + /** + * Retrieve the person info for an existing {@code person NodeRef} + * + * @param personRef NodeRef + * @return PersonInfo (username, firstname, lastname) + * @throws NoSuchPersonException if the person doesn't exist + */ @Auditable(parameters = {"personRef"}) public PersonInfo getPerson(NodeRef personRef) throws NoSuchPersonException; @@ -194,8 +194,8 @@ public interface PersonService * Create a new person with the given properties. The userName is one of the * properties. Users with duplicate userNames are not allowed. * - * @param properties - * @return + * @param properties Map + * @return NodeRef */ @Auditable(parameters = {"properties"}) public NodeRef createPerson(Map properties); @@ -232,7 +232,7 @@ public interface PersonService /** * Delete the person identified by the given user name. * - * @param userName + * @param userName String */ @Auditable(parameters = {"userName"}) public void deletePerson(String userName); @@ -240,7 +240,7 @@ public interface PersonService /** * Delete the person identified by the given ref. * - * @param personRef + * @param personRef NodeRef */ @Auditable(parameters = {"personRef"}) public void deletePerson(NodeRef personRef); @@ -249,8 +249,8 @@ public interface PersonService * Delete the person identified by the given ref, and optionally delete * the associated authentication, if one. * - * @param personRef - * @param deleteAuthentication + * @param personRef NodeRef + * @param deleteAuthentication boolean */ @Auditable(parameters = {"personRef", "deleteAuthentication"}) public void deletePerson(NodeRef personRef, boolean deleteAuthentication); @@ -318,42 +318,42 @@ public interface PersonService * @param filterProps list of filter properties (these are OR'ed) * @param sortProps sort property, eg. cm:username ascending * @param pagingRequest skip, max + optional query execution id - * @return + * @return PagingResults * - * @author janv + *

      author janv * @since 4.1.2 */ @Auditable(parameters = {"pattern", "filterProps", "sortProps", "pagingRequest"}) public PagingResults getPeople(String pattern, List filterProps, List> sortProps, PagingRequest pagingRequest); - /** - * Get paged list of people optionally filtered and/or sorted - * - * @param stringPropFilters list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ... - * @param filterIgnoreCase true to ignore case when filtering, false to be case-sensitive when filtering - * @param sortProps sort property, eg. cm:username ascending - * @param pagingRequest skip, max + optional query execution id + /** + * Get paged list of people optionally filtered and/or sorted + * + * @param stringPropFilters list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ... + * @param filterIgnoreCase true to ignore case when filtering, false to be case-sensitive when filtering + * @param sortProps sort property, eg. cm:username ascending + * @param pagingRequest skip, max + optional query execution id * - * @author janv + *

      author janv * @since 4.0 * @deprecated see getPeople(String pattern, List filterProps, List> sortProps, PagingRequest pagingRequest) */ @Auditable(parameters = {"stringPropFilters", "filterIgnoreCase", "sortProps", "pagingRequest"}) public PagingResults getPeople(List> stringPropFilters, boolean filterIgnoreCase, List> sortProps, PagingRequest pagingRequest); - /** - * Get paged list of people optionally filtered and/or sorted - * - * @param pattern - * @param filterStringProps list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ... - * @param inclusiveAspects if set, filter out any people that don't have one of these aspects - * @param exclusiveAspects if set, filter out any people that do have one of these aspects - * @param includeAdministraotrs true to include administrators in the results. - * @param sortProps sort property, eg. cm:username ascending - * @param pagingRequest skip, max + optional query execution id - * - * @author Alex Miller + /** + * Get paged list of people optionally filtered and/or sorted + * + * @param pattern String + * @param filterStringProps list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ... + * @param inclusiveAspects if set, filter out any people that don't have one of these aspects + * @param exclusiveAspects if set, filter out any people that do have one of these aspects + * @param includeAdministraotrs true to include administrators in the results. + * @param sortProps sort property, eg. cm:username ascending + * @param pagingRequest skip, max + optional query execution id + * + * @code Alex Miller * @since 4.0 */ @Auditable(parameters = {"stringPropFilters", "filterIgnoreCase", "inclusiveAspect", "exclusiveAspects", "sortProps", "pagingRequest"}) @@ -376,7 +376,7 @@ public interface PersonService /** * Return the container that stores people. * - * @return + * @return NodeRef */ @Auditable public NodeRef getPeopleContainer(); @@ -384,7 +384,7 @@ public interface PersonService /** * Are user names case sensitive? * - * @return + * @return boolean */ @Auditable public boolean getUserNamesAreCaseSensitive(); @@ -395,8 +395,8 @@ public interface PersonService * If case insentive it will return the common object. * If the user does not exist it will return null; * - * @param caseSensitiveUserName - * @return + * @param caseSensitiveUserName String + * @return String */ @NotAuditable public String getUserIdentifier(String caseSensitiveUserName); @@ -404,7 +404,7 @@ public interface PersonService /** * Counts the number of persons registered with the system. * - * @return + * @return int */ @NotAuditable public int countPeople(); diff --git a/source/java/org/alfresco/service/cmr/site/SiteInfo.java b/source/java/org/alfresco/service/cmr/site/SiteInfo.java index 40c42268c8..7dced406b8 100644 --- a/source/java/org/alfresco/service/cmr/site/SiteInfo.java +++ b/source/java/org/alfresco/service/cmr/site/SiteInfo.java @@ -113,7 +113,7 @@ public interface SiteInfo extends PermissionCheckValue /** * Get the custom property values * - * @return Map map of custom property names and values + * @return map of custom property names and values */ public abstract Map getCustomProperties(); diff --git a/source/java/org/alfresco/service/cmr/site/SiteService.java b/source/java/org/alfresco/service/cmr/site/SiteService.java index 5a1d8abf17..d6790ecdc1 100644 --- a/source/java/org/alfresco/service/cmr/site/SiteService.java +++ b/source/java/org/alfresco/service/cmr/site/SiteService.java @@ -59,7 +59,7 @@ public interface SiteService /** * Return true to break out of the loop early. - * @return + * @return boolean */ public boolean isDone(); } @@ -225,8 +225,8 @@ public interface SiteService /** * Lists all the memberships in sites that the specified user is in. * - * @param userName - * @param size + * @param userName String + * @param size int * @return a list of SiteMembership objects */ @NotAuditable @@ -324,7 +324,7 @@ public interface SiteService * @param nameFilter name filter * @param roleFilter role filter * @param size max results size crop if >0 - * @return Map the authority name and their role + * @return the authority name and their role */ @NotAuditable Map listMembers(String shortName, String nameFilter, String roleFilter, int size); @@ -338,7 +338,7 @@ public interface SiteService * @param roleFilter role filter * @param size max results size crop if >0 * @param collapseGroups true if collapse member groups into user list, false otherwise - * @return Map the authority name and their role + * @return the authority name and their role */ @NotAuditable Map listMembers(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups); @@ -367,7 +367,7 @@ public interface SiteService * @param collapseGroups true if collapse member groups into user list, false otherwise * @param pagingRequest the paging request * - * @return Map the authority name and their role + * @return the authority name and their role */ @NotAuditable PagingResults listMembersPaged(String shortName, boolean collapseGroups, List> sortProps, PagingRequest pagingRequest); @@ -513,8 +513,8 @@ public interface SiteService * node is moved or copied from one site to another. Permissions relating to the former site are * removed and the node is given the default permissions for its new site. * - * @param relocatedNode - * @param containingSite + * @param relocatedNode NodeRef + * @param containingSite SiteInfo * @since 3.4.2 */ public void cleanSitePermissions(NodeRef relocatedNode, SiteInfo containingSite); diff --git a/source/java/org/alfresco/service/cmr/tagging/TaggingService.java b/source/java/org/alfresco/service/cmr/tagging/TaggingService.java index f8e3f6d3fb..150e22a37b 100644 --- a/source/java/org/alfresco/service/cmr/tagging/TaggingService.java +++ b/source/java/org/alfresco/service/cmr/tagging/TaggingService.java @@ -60,9 +60,9 @@ public interface TaggingService /** * Get a paged list of all the tags currently available * - * @param storeRef - * @param pagingRequest - * @return + * @param storeRef StoreRef + * @param pagingRequest PagingRequest + * @return PagingResults */ @NotAuditable PagingResults> getTags(StoreRef storeRef, PagingRequest pagingRequest); @@ -284,7 +284,7 @@ public interface TaggingService * @param storeRef node reference * @param fromTag offset * @param pageSize page size - * @return Pair, Integer> pair of tag names and total count + * @return pair of tag names and total count */ @NotAuditable Pair, Integer> getPagedTags(StoreRef storeRef, int fromTag, int pageSize); @@ -295,7 +295,7 @@ public interface TaggingService * @param filter tag filter * @param fromTag page offset * @param pageSize page size - * @return Pair, Integer> pair of tag names and total count + * @return pair of tag names and total count */ @NotAuditable Pair, Integer> getPagedTags(StoreRef storeRef, String filter, int fromTag, int pageSize); diff --git a/source/java/org/alfresco/service/cmr/thumbnail/FailedThumbnailInfo.java b/source/java/org/alfresco/service/cmr/thumbnail/FailedThumbnailInfo.java index 9f0d03049a..2613400552 100644 --- a/source/java/org/alfresco/service/cmr/thumbnail/FailedThumbnailInfo.java +++ b/source/java/org/alfresco/service/cmr/thumbnail/FailedThumbnailInfo.java @@ -68,7 +68,7 @@ public class FailedThumbnailInfo /** * Get the total number of failed attempts which have been made to produce a thumbnail. - * @return + * @return int */ public int getFailureCount() { diff --git a/source/java/org/alfresco/service/cmr/transfer/NodeFilter.java b/source/java/org/alfresco/service/cmr/transfer/NodeFilter.java index 098f6786c3..3e876cdf56 100644 --- a/source/java/org/alfresco/service/cmr/transfer/NodeFilter.java +++ b/source/java/org/alfresco/service/cmr/transfer/NodeFilter.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2009-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) 2009-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 . */ @@ -31,7 +31,7 @@ public interface NodeFilter /** * Examines the supplied node and indicates whether it has been accepted by the filter. - * @param thisNode + * @param thisNode NodeRef * @return true if the supplied node matches the criteria specified on this filter, and false * otherwise. */ diff --git a/source/java/org/alfresco/service/cmr/transfer/RangedTransferEvent.java b/source/java/org/alfresco/service/cmr/transfer/RangedTransferEvent.java index 10d33b3d8e..7259a36594 100644 --- a/source/java/org/alfresco/service/cmr/transfer/RangedTransferEvent.java +++ b/source/java/org/alfresco/service/cmr/transfer/RangedTransferEvent.java @@ -30,13 +30,13 @@ public interface RangedTransferEvent extends TransferEvent { /** * The position in the range - * @return + * @return long */ long getPosition(); /** * The maximum range - * @return + * @return long */ long getRange(); diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferCallback.java b/source/java/org/alfresco/service/cmr/transfer/TransferCallback.java index cb2cc00122..260b04deff 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferCallback.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferCallback.java @@ -29,7 +29,7 @@ public interface TransferCallback { /** * processEvent - * @param event + * @param event TransferEvent */ public void processEvent(TransferEvent event); diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferDefinition.java b/source/java/org/alfresco/service/cmr/transfer/TransferDefinition.java index e9fa6da915..949098d84e 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferDefinition.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferDefinition.java @@ -72,7 +72,7 @@ public class TransferDefinition implements Serializable /** * Set which nodes to transfer - * @param nodes + * @param nodes Collection */ public void setNodes(Collection nodes) { @@ -86,7 +86,7 @@ public class TransferDefinition implements Serializable /** * Set nodes that are to be explicitly removed from the the target repository - * @param nodes + * @param nodes Collection */ public void setNodesToRemove(Collection nodes) { @@ -95,7 +95,7 @@ public class TransferDefinition implements Serializable /** * Set nodes that are to be explicitly removed from the the target repository - * @param nodes + * @param nodes NodeRef... */ public void setNodesToRemove(NodeRef...nodes) { @@ -104,7 +104,7 @@ public class TransferDefinition implements Serializable /** * Get which nodes to transfer - * @return + * @return Set */ public Set getNodes() { @@ -113,7 +113,7 @@ public class TransferDefinition implements Serializable /** * Get the list of nodes that are to be explicitly removed from the target repository - * @return + * @return Set */ public Set getNodesToRemove() { diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java b/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java index ab19d123c8..fc1ac5c7e2 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java @@ -51,7 +51,7 @@ public interface TransferEvent /** * Get a human readable message for this event - * @return + * @return String */ String getMessage(); diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferReceiver.java b/source/java/org/alfresco/service/cmr/transfer/TransferReceiver.java index d3055df863..e619cfbdeb 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferReceiver.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferReceiver.java @@ -34,15 +34,15 @@ public interface TransferReceiver { /** * - * @param transferId - * @return + * @param transferId String + * @return File */ File getStagingFolder(String transferId); /** * - * @param transferId - * @return + * @param transferId String + * @return NodeRef */ NodeRef getTempFolder(String transferId); @@ -76,9 +76,9 @@ public interface TransferReceiver /** * Save a content item - * @param transferId - * @param contentId - * @param contentStream + * @param transferId String + * @param contentId String + * @param contentStream InputStream * @throws TransferException */ void saveContent(String transferId, String contentId, InputStream contentStream) throws TransferException; @@ -92,35 +92,35 @@ public interface TransferReceiver /** * Prepare - * @param transferId + * @param transferId String * @throws TransferException */ void prepare(String transferId) throws TransferException; /** * Abort - * @param transferId + * @param transferId String * @throws TransferException */ void cancel(String transferId) throws TransferException; /** * Commit asynchronously - * @param transferId + * @param transferId String * @throws TransferException */ void commitAsync(String transferId) throws TransferException; /** * Commit - * @param transferId + * @param transferId String * @throws TransferException */ void commit(String transferId) throws TransferException; /** * - * @param transferId + * @param transferId String * @return the trabsfer progress * @throws TransferException */ @@ -133,19 +133,19 @@ public interface TransferReceiver /** * - * @return + * @return TransferProgressMonitor */ TransferProgressMonitor getProgressMonitor(); /** * get the transfer report for the specified transfer - * @param transferId + * @param transferId String */ InputStream getTransferReport(String transferId); /** * set the root node for the file system receiver - * @param rootFileSystem + * @param rootFileSystem String */ void setTransferRootNode(String rootFileSystem); } \ No newline at end of file diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferService.java b/source/java/org/alfresco/service/cmr/transfer/TransferService.java index 60f9106735..c67407406b 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferService.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferService.java @@ -46,7 +46,7 @@ public interface TransferService * * @param targetName the name of the target to transfer to * The following properties must be set, nodes - * @param definition, the definition of the transfer. Specifies which nodes to transfer. + * @param definition the definition of the transfer. Specifies which nodes to transfer. * @throws TransferException * @return the node reference of the transfer report */ @@ -129,15 +129,15 @@ public interface TransferService /** * Create and save a new transfer target. Creates and saves a new transfer target with a single, but long, method call. * - * @param name, the name of this transfer target, which must be unique - * @param title, the display name of this transfer target - * @param description, - * @param endpointProtocol, either http or https - * @param endpointHost, - * @param endpointPort, - * @param endpointPath, - * @param username, - * @param password, + * @param name the name of this transfer target, which must be unique + * @param title the display name of this transfer target + * @param description String + * @param endpointProtocol either http or https + * @param endpointHost String + * @param endpointPort int + * @param endpointPath String + * @param username String + * @param password char[] * @return the newly created transfer target. */ @Auditable @@ -170,7 +170,7 @@ public interface TransferService /** * Get All the transfer targets for a particular transfer target group. - * @param groupName, the name of the transfer group + * @param groupName the name of the transfer group */ @NotAuditable public SetgetTransferTargets(String groupName) throws TransferException; @@ -184,7 +184,7 @@ public interface TransferService /** * Test to see if the target with the specified name exists - * @param name + * @param name String * @return true if the specified target exists, and false otherwise */ @NotAuditable @@ -193,7 +193,7 @@ public interface TransferService /** * Delete a transfer target. After calling this method the transfer target will no longer exist. * @throws TransferException - target does not exist - * @param name, the name of this transfer target, + * @param name the name of this transfer target, */ @Auditable(parameters={"name"}) public void deleteTransferTarget(String name) throws TransferException; @@ -215,7 +215,7 @@ public interface TransferService * name, must be specified. * nodeRef, if specified will be ignored. * - * @param update + * @param update TransferTarget */ @Auditable public TransferTarget saveTransferTarget(TransferTarget update) throws TransferException; @@ -244,7 +244,7 @@ public interface TransferService * * @param transferId the unique identifier of the transfer to cancel. * - * @see TransferEventBegin; + * @see org.alfresco.service.cmr.transfer.TransferEventBegin */ @Auditable(parameters={"transferId"}) public void cancelAsync(String transferId); diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferService2.java b/source/java/org/alfresco/service/cmr/transfer/TransferService2.java index 5174a2231e..ebb3acfbce 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferService2.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferService2.java @@ -111,15 +111,15 @@ public interface TransferService2 /** * Create and save a new transfer target. Creates and saves a new transfer target with a single, but long, method call. * - * @param name, the name of this transfer target, which must be unique - * @param title, the display name of this transfer target - * @param description, - * @param endpointProtocol, either http or https - * @param endpointHost, - * @param endpointPort, - * @param endpointPath, - * @param username, - * @param password, + * @param name the name of this transfer target, which must be unique + * @param title the display name of this transfer target + * @param description String + * @param endpointProtocol either http or https + * @param endpointHost String + * @param endpointPort int + * @param endpointPath String + * @param username String + * @param password char[] * @return the newly created transfer target. */ @Auditable @@ -152,7 +152,7 @@ public interface TransferService2 /** * Get All the transfer targets for a particular transfer target group. - * @param groupName, the name of the transfer group + * @param groupName the name of the transfer group */ @NotAuditable public SetgetTransferTargets(String groupName) throws TransferException; @@ -166,7 +166,7 @@ public interface TransferService2 /** * Test to see if the target with the specified name exists - * @param name + * @param name String * @return true if the specified target exists, and false otherwise */ @NotAuditable @@ -175,7 +175,7 @@ public interface TransferService2 /** * Delete a transfer target. After calling this method the transfer target will no longer exist. * @throws TransferException - target does not exist - * @param name, the name of this transfer target, + * @param name the name of this transfer target, */ @Auditable(parameters={"name"}) public void deleteTransferTarget(String name) throws TransferException; @@ -197,7 +197,7 @@ public interface TransferService2 * name, must be specified. * nodeRef, if specified will be ignored. * - * @param update + * @param update TransferTarget */ @Auditable public TransferTarget saveTransferTarget(TransferTarget update) throws TransferException; @@ -226,7 +226,7 @@ public interface TransferService2 * * @param transferId the unique identifier of the transfer to cancel. * - * @see TransferEventBegin; + * @see TransferEventBegin */ @Auditable(parameters={"transferId"}) public void cancelAsync(String transferId); diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferTarget.java b/source/java/org/alfresco/service/cmr/transfer/TransferTarget.java index 14c44a5164..26c4459b40 100644 --- a/source/java/org/alfresco/service/cmr/transfer/TransferTarget.java +++ b/source/java/org/alfresco/service/cmr/transfer/TransferTarget.java @@ -29,61 +29,61 @@ public interface TransferTarget { /** * read only - get the node reference of the underlying transfer target node. - * @return + * @return NodeRef */ public NodeRef getNodeRef(); /** * Get the name of this transfer target - * @return + * @return String */ public String getName(); /** * Get the description for this transfer target - * @return + * @return String */ public String getDescription(); /** * Set the decription for this transfer target - * @param description + * @param description String */ public void setDescription(String description); /** * Get the title of this transfer target - * @return + * @return String */ String getTitle(); /** * Set the title for this transfer target - * @param title + * @param title String */ public void setTitle(String title); /** * Get the endpoint host - * @return + * @return String */ public String getEndpointHost(); /** * Set the endpoint host - * @param endpointHost + * @param endpointHost String */ public void setEndpointHost(String endpointHost); /** * Get the endpoint port - * @return + * @return int */ int getEndpointPort(); /** * Set the endpoint port - * @param endpointPort + * @param endpointPort int */ public void setEndpointPort(int endpointPort); @@ -94,7 +94,7 @@ public interface TransferTarget /** * Set the endpoint protocol. - * @param endpointProtocol + * @param endpointProtocol String */ public void setEndpointProtocol(String endpointProtocol); @@ -106,26 +106,26 @@ public interface TransferTarget /** * The username used to authenticate with the transfer target - * @return + * @return String */ String getUsername(); /** * The username used to authenticate with the transfer target - * @param userName + * @param userName String */ void setUsername(String userName); /** * Get the cleartext password - * @return + * @return char[] */ char[] getPassword(); /** * The location of the transfer service on the target endpoint host * Defaults to "/alfresco/service/api/transfer", and this shouldn't typically need to change - * @return + * @return String */ String getEndpointPath(); diff --git a/source/java/org/alfresco/service/cmr/transfer/package-info.java b/source/java/org/alfresco/service/cmr/transfer/package-info.java index 89ce6bd197..a7c3a89267 100644 --- a/source/java/org/alfresco/service/cmr/transfer/package-info.java +++ b/source/java/org/alfresco/service/cmr/transfer/package-info.java @@ -27,10 +27,10 @@ *

      * The NodeCrawler provides the ability to find a set of nodes to give to the transfer service. * - * @see org.alfresco.service.cmr.transferTransferService + * @see org.alfresco.service.cmr.transfer.TransferService * @since 3.3 */ -@PackageMarker +@PackageMarker package org.alfresco.service.cmr.transfer; import org.alfresco.util.PackageMarker; diff --git a/source/java/org/alfresco/service/cmr/view/Exporter.java b/source/java/org/alfresco/service/cmr/view/Exporter.java index 20599b51e2..3423538ce6 100644 --- a/source/java/org/alfresco/service/cmr/view/Exporter.java +++ b/source/java/org/alfresco/service/cmr/view/Exporter.java @@ -86,7 +86,7 @@ public interface Exporter /** * Start export of aspects * - * @param nodeRef + * @param nodeRef NodeRef */ public void startAspects(NodeRef nodeRef); @@ -109,7 +109,7 @@ public interface Exporter /** * End export of aspects * - * @param nodeRef + * @param nodeRef NodeRef */ public void endAspects(NodeRef nodeRef); @@ -177,14 +177,15 @@ public interface Exporter * Start export MLText * * @param nodeRef the node reference - * @param locale + * @param locale Locale + * @param isNull boolean */ public void startValueMLText(NodeRef nodeRef, Locale locale, boolean isNull); /** * End export MLText * - * @param nodeRef + * @param nodeRef NodeRef */ public void endValueMLText(NodeRef nodeRef); @@ -220,7 +221,7 @@ public interface Exporter /** * Start export of associations * - * @param nodeRef + * @param nodeRef NodeRef */ public void startAssocs(NodeRef nodeRef); @@ -243,7 +244,7 @@ public interface Exporter /** * End export of associations * - * @param nodeRef + * @param nodeRef NodeRef */ public void endAssocs(NodeRef nodeRef); diff --git a/source/java/org/alfresco/service/cmr/view/ExporterContext.java b/source/java/org/alfresco/service/cmr/view/ExporterContext.java index c3a6e5fb2a..aef46a6ae0 100644 --- a/source/java/org/alfresco/service/cmr/view/ExporterContext.java +++ b/source/java/org/alfresco/service/cmr/view/ExporterContext.java @@ -27,22 +27,22 @@ public interface ExporterContext { /** * Gets who initiated the export - * - * @return + * + * @return String */ public String getExportedBy(); /** * Gets date at which export occured * - * @return + * @return Date */ public Date getExportedDate(); /** * Gets version number of exporter * - * @return + * @return String */ public String getExporterVersion(); @@ -77,14 +77,14 @@ public interface ExporterContext /** * Return true if there is active node for export * - * @return + * @return boolean */ public boolean canRetrieve(); /** * Set next active node from list * - * @return + * @return int */ public int setNextValue(); diff --git a/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java b/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java index bbef7f3d28..e23fa984c2 100644 --- a/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java +++ b/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java @@ -57,7 +57,7 @@ public class ExporterCrawlerParameters /** * Sets whether to crawl child nodes * - * @param crawlChildNodes + * @param crawlChildNodes boolean */ public void setCrawlChildNodes(boolean crawlChildNodes) { @@ -77,7 +77,7 @@ public class ExporterCrawlerParameters /** * Sets whether to crawl associations * - * @param crawlAssociations + * @param crawlAssociations boolean */ public void setCrawlAssociations(boolean crawlAssociations) { @@ -97,7 +97,7 @@ public class ExporterCrawlerParameters /** * Sets whether to crawl content * - * @param crawlContent + * @param crawlContent boolean */ public void setCrawlContent(boolean crawlContent) { @@ -117,7 +117,7 @@ public class ExporterCrawlerParameters /** * Sets whether to crawl and export node at export path * - * @param crawlSelf + * @param crawlSelf boolean */ public void setCrawlSelf(boolean crawlSelf) { @@ -137,7 +137,7 @@ public class ExporterCrawlerParameters /** * Sets whether to crawl null properties * - * @param crawlNullProperties + * @param crawlNullProperties boolean */ public void setCrawlNullProperties(boolean crawlNullProperties) { @@ -157,7 +157,7 @@ public class ExporterCrawlerParameters /** * Sets the list of namespace URIs to exclude from the Export * - * @param excludeNamespaceURIs + * @param excludeNamespaceURIs String[] */ public void setExcludeNamespaceURIs(String[] excludeNamespaceURIs) { @@ -177,7 +177,7 @@ public class ExporterCrawlerParameters /** * Sets the list of Aspects to exclude from the Export * - * @param excludeAspects + * @param excludeAspects QName[] */ public void setExcludeAspects(QName[] excludeAspects) { @@ -197,7 +197,7 @@ public class ExporterCrawlerParameters /** * Sets the list of Child Associations to exclude from the Export * - * @param excludeChildAssocs + * @param excludeChildAssocs QName[] */ public void setExcludeChildAssocs(QName[] excludeChildAssocs) { @@ -216,8 +216,8 @@ public class ExporterCrawlerParameters /** * Sets the list of included paths to explicitly include in the Export - * - * @param includedPaths + * + * @param includedPaths String[] */ public void setIncludedPaths(String[] includedPaths) { @@ -237,7 +237,7 @@ public class ExporterCrawlerParameters /** * Sets the path to export from * - * @param exportFrom + * @param exportFrom Location */ public void setExportFrom(Location exportFrom) { @@ -254,13 +254,13 @@ public class ExporterCrawlerParameters return referenceType; } - /** - * Sets the format of exported references (child and association references) - * - * @param referenceType type - */ - public void setReferenceType(ReferenceType referenceType) - { + /** + * Sets the format of exported references (child and association references) + * + * @param referenceType type + */ + public void setReferenceType(ReferenceType referenceType) + { this.referenceType = referenceType; } diff --git a/source/java/org/alfresco/service/cmr/view/Location.java b/source/java/org/alfresco/service/cmr/view/Location.java index 6213e6c91e..5fd336f575 100644 --- a/source/java/org/alfresco/service/cmr/view/Location.java +++ b/source/java/org/alfresco/service/cmr/view/Location.java @@ -40,7 +40,7 @@ public class Location /** * Construct * - * @param nodeRef + * @param nodeRef NodeRef */ public Location(NodeRef nodeRef) { @@ -52,7 +52,7 @@ public class Location /** * Construct * - * @param nodeRefs + * @param nodeRefs NodeRef[] */ public Location(NodeRef[] nodeRefs) { @@ -65,7 +65,7 @@ public class Location /** * Construct * - * @param storeRef + * @param storeRef StoreRef */ public Location(StoreRef storeRef) { diff --git a/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java b/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java index 5b392405c1..2563275550 100644 --- a/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java +++ b/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java @@ -240,8 +240,8 @@ public interface WorkflowService /** * Gets all "in-flight" workflow instances according to the specified workflowInstanceQuery parameter * - * @param workflowInstanceQuery - * @return + * @param workflowInstanceQuery WorkflowInstanceQuery + * @return List */ public List getWorkflows(WorkflowInstanceQuery workflowInstanceQuery); @@ -249,9 +249,9 @@ public interface WorkflowService * Gets maxItems "in-flight" workflow instances according to the specified workflowInstanceQuery parameter * Get maxItems and skipCount parameters form request * - * @param workflowInstanceQuery - * @param maxItems - * @param skipCount + * @param workflowInstanceQuery WorkflowInstanceQuery + * @param maxItems int + * @param skipCount int * @return maxItems workflow instances */ public List getWorkflows(WorkflowInstanceQuery workflowInstanceQuery, int maxItems, int skipCount); @@ -259,7 +259,7 @@ public interface WorkflowService /** * Get count of workflow instances * - * @param workflowInstanceQuery + * @param workflowInstanceQuery WorkflowInstanceQuery * @return count of workflow instances */ public long countWorkflows(WorkflowInstanceQuery workflowInstanceQuery); @@ -268,7 +268,7 @@ public interface WorkflowService * Gets all active workflow instances. * * @return the list of "in-flight" workflow instances - * @since4.0 + * @since 4.0 */ @Auditable public List getActiveWorkflows(); @@ -380,8 +380,8 @@ public interface WorkflowService /** * Gets the start task instance for the given workflow instance. * - * @param workflowInstanceId - * @return + * @param workflowInstanceId String + * @return WorkflowTask */ @Auditable(parameters = {"pathId"}) public WorkflowTask getStartTask(String workflowInstanceId); @@ -389,11 +389,11 @@ public interface WorkflowService /** * Gets the start task instances for the given workflow instances. * - * @param workflowInstanceIds + * @param workflowInstanceIds List * @param sameSession indicates that the returned {@link WorkflowTask} elements will be used in * the same session. If {@code true}, the returned List will be a lazy loaded list * providing greater performance. - * @return + * @return List */ @Auditable(parameters = {"pathIds"}) public List getStartTasks(List workflowInstanceIds, boolean sameSession); diff --git a/source/java/org/alfresco/service/cmr/workflow/WorkflowTaskQuery.java b/source/java/org/alfresco/service/cmr/workflow/WorkflowTaskQuery.java index 6063c96a5e..4318ada0d8 100644 --- a/source/java/org/alfresco/service/cmr/workflow/WorkflowTaskQuery.java +++ b/source/java/org/alfresco/service/cmr/workflow/WorkflowTaskQuery.java @@ -78,7 +78,7 @@ public class WorkflowTaskQuery /** - * @param orderBy + * @param orderBy OrderBy[] */ public void setOrderBy(OrderBy[] orderBy) { @@ -86,7 +86,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return OrderBy[] */ public OrderBy[] getOrderBy() { @@ -94,7 +94,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return String */ public String getTaskId() { @@ -102,7 +102,7 @@ public class WorkflowTaskQuery } /** - * @param taskId + * @param taskId String */ public void setTaskId(String taskId) { @@ -110,7 +110,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return Map */ public Map getTaskCustomProps() { @@ -118,7 +118,7 @@ public class WorkflowTaskQuery } /** - * @param taskCustomProps + * @param taskCustomProps Map */ public void setTaskCustomProps(Map taskCustomProps) { @@ -126,7 +126,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return WorkflowTaskState */ public WorkflowTaskState getTaskState() { @@ -134,7 +134,7 @@ public class WorkflowTaskQuery } /** - * @param taskState + * @param taskState WorkflowTaskState */ public void setTaskState(WorkflowTaskState taskState) { @@ -142,7 +142,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return QName */ public QName getTaskName() { @@ -150,7 +150,7 @@ public class WorkflowTaskQuery } /** - * @param taskName + * @param taskName QName */ public void setTaskName(QName taskName) { @@ -158,7 +158,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return String */ public String getActorId() { @@ -166,7 +166,7 @@ public class WorkflowTaskQuery } /** - * @param actorId + * @param actorId String */ public void setActorId(String actorId) { @@ -174,7 +174,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return String */ public String getProcessId() { @@ -183,7 +183,7 @@ public class WorkflowTaskQuery /** * Filters ont he {@link WorkflowInstance} Id. - * @param processId + * @param processId String */ public void setProcessId(String processId) { @@ -191,7 +191,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return QName */ public QName getProcessName() { @@ -204,7 +204,7 @@ public class WorkflowTaskQuery * the method {@link #setWorkflowDefinitionName(String)} should be used * instead of this method. * - * @param processName + * @param processName QName */ @Deprecated public void setProcessName(QName processName) @@ -213,7 +213,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return String */ public String getWorkflowDefinitionName() { @@ -222,7 +222,7 @@ public class WorkflowTaskQuery /** * Filters on the {@link WorkflowDefinition} name. - * @param workflowDefinitionName + * @param workflowDefinitionName String */ public void setWorkflowDefinitionName(String workflowDefinitionName) { @@ -230,7 +230,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return Boolean */ public Boolean isActive() { @@ -238,7 +238,7 @@ public class WorkflowTaskQuery } /** - * @param active + * @param active Boolean */ public void setActive(Boolean active) { @@ -246,7 +246,7 @@ public class WorkflowTaskQuery } /** - * @return + * @return Map */ public Map getProcessCustomProps() { @@ -254,7 +254,7 @@ public class WorkflowTaskQuery } /** - * @param processCustomProps + * @param processCustomProps Map */ public void setProcessCustomProps(Map processCustomProps) { diff --git a/source/java/org/alfresco/util/DatabaseMetaDataHelper.java b/source/java/org/alfresco/util/DatabaseMetaDataHelper.java index 6a352e87cd..943903abd6 100644 --- a/source/java/org/alfresco/util/DatabaseMetaDataHelper.java +++ b/source/java/org/alfresco/util/DatabaseMetaDataHelper.java @@ -47,7 +47,7 @@ public class DatabaseMetaDataHelper { /** * Trys to determine the schema name from the DatabaseMetaData obtained from the Connection. * @param connection A database connection - * @return + * @return String */ private String getSchemaFromConnection(Connection connection) { diff --git a/source/java/org/alfresco/util/JSONtoFmModel.java b/source/java/org/alfresco/util/JSONtoFmModel.java index 242f6f58b8..68adaa2ab3 100644 --- a/source/java/org/alfresco/util/JSONtoFmModel.java +++ b/source/java/org/alfresco/util/JSONtoFmModel.java @@ -51,7 +51,7 @@ public final class JSONtoFmModel /** * Convert JSON Object string to Freemarker-compatible data model * - * @param jsonString + * @param jsonString String * @return model * @throws JSONException */ @@ -104,7 +104,7 @@ public final class JSONtoFmModel /** * Convert JSON Array string to Freemarker-compatible data model * - * @param jsonString + * @param jsonString String * @return model * @throws JSONException */ diff --git a/source/java/org/alfresco/util/ScriptPagingDetails.java b/source/java/org/alfresco/util/ScriptPagingDetails.java index 8d96481ffd..6b4de215d3 100644 --- a/source/java/org/alfresco/util/ScriptPagingDetails.java +++ b/source/java/org/alfresco/util/ScriptPagingDetails.java @@ -30,7 +30,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest; * used with Scripts and WebScripts, and feeds into the * Repository level paging support. * This class is typically used with {@link ModelUtil}. - * Note that {@link org.alfresco.repo.web.paging.Paging} + * Note that {@link org.alfresco.repo.web.util.paging.Paging} * provides an alternate solution for other paging * use cases. * diff --git a/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java b/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java index bad01450ec..0b1ebba54a 100644 --- a/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java +++ b/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java @@ -52,7 +52,7 @@ import org.springframework.beans.factory.InitializingBean; * true *

    • {@link #setWorkQueueSize(int) workQueueSize}: * -1 or less (No upper bound)
    • - *
    • {@link #setRejectedExecutionHandler(RejectedExecutionHandler) rejectedExecutionHandler: + *
    • {@link #setRejectedExecutionHandler(RejectedExecutionHandler) rejectedExecutionHandler}: * ThreadPoolExecutor.CallerRunsPolicy
    • *
    * diff --git a/source/java/org/alfresco/util/TypeConstraint.java b/source/java/org/alfresco/util/TypeConstraint.java index 267b783881..949050ef98 100644 --- a/source/java/org/alfresco/util/TypeConstraint.java +++ b/source/java/org/alfresco/util/TypeConstraint.java @@ -101,8 +101,7 @@ public class TypeConstraint /** * Processes the user-defined list of types into valid QNames & models, it validates them * against the dictionary and also supports wildcards - * @param typeNames - * @return Set Valid type QNames + * @param typeNames List */ protected void preprocessExcludedTypes(List typeNames) { @@ -129,8 +128,7 @@ public class TypeConstraint /** * Processes the user-defined list of types into valid QNames & models, it validates them * against the dictionary and also supports wildcards - * @param typeNames - * @return Set Valid type QNames + * @param typeNames List */ protected void preprocessExpectedTypes(List typeNames) { @@ -179,7 +177,7 @@ public class TypeConstraint /** * Returns true if the nodeRef matches the constraints, false otherwise. * - * @param nodeRef + * @param nodeRef NodeRef * @return returns true if the nodeRef matches the constraints, false otherwise. */ public boolean matches(final NodeRef nodeRef) diff --git a/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java b/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java index 3e6e5b5676..41c9895585 100644 --- a/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java +++ b/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java @@ -33,13 +33,13 @@ import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.util.PropertyCheck; - -/** - * Composite property bean to identify a folder in the repository. This uses the - * {@link #getFolderPath() path} to identify a root and then a - * {@link #getFolderNames() folder-name path} to identify a folder. - * - * @author Derek Hulley + +/** + * Composite property bean to identify a folder in the repository. This uses the + * {@link #getFolderPath() path} to identify a root and then a + * folder-name path to identify a folder. + * + * @author Derek Hulley * @since 3.2 */ public class RepositoryFolderConfigBean extends RepositoryPathConfigBean @@ -66,13 +66,13 @@ public class RepositoryFolderConfigBean extends RepositoryPathConfigBean public String getFolderPath() { return folderPath; - } - - /** - * Set the folder name path relative to the {@link #getFolderPath() path}. - * - * @param folderPath a folder-name path using the '/' path separator e.g. 'IMAP HOME/MAIL-1' - */ + } + + /** + * Set the folder name path relative to the {@link #getFolderPath() path}. + * + * @param folderPath a folder-name path using the '/' path separator e.g. 'IMAP HOME/MAIL-1' + */ public void setFolderPath(String folderPath) { if (!PropertyCheck.isValidPropertyString(folderPath)) @@ -96,13 +96,13 @@ public class RepositoryFolderConfigBean extends RepositoryPathConfigBean } this.folderPath = pathBuff.toString(); } - - /** - * Helper method to find the folder path referenced by this bean. - * The {@link #getFolderPath() path} to the start of the {@link #getFolderNames() folder path} - * must exist. - *

    - * Authentication and transactions are the client's responsibility. + + /** + * Helper method to find the folder path referenced by this bean. + * The {@link #getFolderPath() path} to the start of the folder path + * must exist. + *

    + * Authentication and transactions are the client's responsibility. * * @return Returns an existing folder reference * @throws AlfrescoRuntimeException if path cannot be resolved or found node is not a folder @@ -115,13 +115,13 @@ public class RepositoryFolderConfigBean extends RepositoryPathConfigBean { return getFolderPathImpl(namespaceService, nodeService, searchService, fileFolderService, true); } - - /** - * Helper method to find the folder path referenced by this bean. - * The {@link #getFolderPath() path} to the start of the {@link #getFolderNames() folder path} - * must exist. - *

    - * Authentication and transactions are the client's responsibility. + + /** + * Helper method to find the folder path referenced by this bean. + * The {@link #getFolderPath() path} to the start of the folder path + * must exist. + *

    + * Authentication and transactions are the client's responsibility. * * @return Returns an existing folder reference or null */ @@ -182,13 +182,13 @@ public class RepositoryFolderConfigBean extends RepositoryPathConfigBean } return null; } - - /** - * Helper method to find or create the folder path referenced by this bean. - * The {@link #getFolderPath() path} to the start of the {@link #getFolderNames() folder path} - * must exist. The folder path will be created, if required. - *

    - * Authentication and transactions are the client's responsibility. + + /** + * Helper method to find or create the folder path referenced by this bean. + * The {@link #getFolderPath() path} to the start of the folder path + * must exist. The folder path will be created, if required. + *

    + * Authentication and transactions are the client's responsibility. * * @return Returns an existing or new folder reference */ diff --git a/source/java/org/alfresco/util/debug/NodeStoreInspector.java b/source/java/org/alfresco/util/debug/NodeStoreInspector.java index 7f2156b687..ca9ec666a7 100644 --- a/source/java/org/alfresco/util/debug/NodeStoreInspector.java +++ b/source/java/org/alfresco/util/debug/NodeStoreInspector.java @@ -68,9 +68,9 @@ public class NodeStoreInspector /** * Dumps the contents of a node * - * @param nodeService - * @param nodeRef - * @return + * @param nodeService NodeService + * @param nodeRef NodeRef + * @return String */ public static String dumpNode(NodeService nodeService, NodeRef nodeRef) { @@ -94,10 +94,10 @@ public class NodeStoreInspector /** * Output the node * - * @param iIndent - * @param nodeService - * @param nodeRef - * @return + * @param iIndent int + * @param nodeService NodeService + * @param nodeRef NodeRef + * @return String */ private static String outputNode(int iIndent, NodeService nodeService, NodeRef nodeRef) { diff --git a/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java b/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java index 276b335b62..f41d3ba2eb 100644 --- a/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java +++ b/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java @@ -41,43 +41,43 @@ public interface ComparisonUtils * is significant - if an element E appears in both collections but at different indexes * then it is not considered to be the same item. * - * @param leftProperty - * @param rightProperty - * @param ctx + * @param leftProperty DbProperty + * @param rightProperty DbProperty + * @param ctx DiffContext */ void compareSimpleOrderedLists(DbProperty leftProperty, DbProperty rightProperty, DiffContext ctx); /** - * Compare two collections. Similar to {@link #compareSimpleOrderedLists(DbProperty, DbProperty, DiffContext)} - * except that this method operates on {@link Collection}s and order (and cardinality) is not important. If - * an element E from the reference collection appears one or more times at any position in the target collection - * then that element is said to be {@link org.alfresco.util.schemacomp.Difference.Where#IN_BOTH_NO_DIFFERENCE in both with no difference}. - * - * @param leftProperty - * @param rightProperty - * @param ctx - context - */ - void compareSimpleCollections(DbProperty leftProperty, DbProperty rightProperty, DiffContext ctx); - - /** - * Compare collections of {@link DbObject}s using their {@link DbObject#diff(DbObject, DiffContext)} method. - * - * @param leftCollection - * @param rightCollection - * @param ctx - context - */ - void compareCollections(Collection leftCollection, - Collection rightCollection, DiffContext ctx); + * Compare two collections. Similar to {@link #compareSimpleOrderedLists(DbProperty, DbProperty, DiffContext)} + * except that this method operates on {@link Collection}s and order (and cardinality) is not important. If + * an element E from the reference collection appears one or more times at any position in the target collection + * then that element is said to be {@link org.alfresco.util.schemacomp.Difference.Where#IN_BOTH_NO_DIFFERENCE in both with no difference}. + * + * @param leftProperty DbProperty + * @param rightProperty DbProperty + * @param ctx - context + */ + void compareSimpleCollections(DbProperty leftProperty, DbProperty rightProperty, DiffContext ctx); + + /** + * Compare collections of {@link DbObject}s using their {@link DbObject#diff(DbObject, DiffContext)} method. + * + * @param leftCollection Collection + * @param rightCollection Collection + * @param ctx - context + */ + void compareCollections(Collection leftCollection, + Collection rightCollection, DiffContext ctx); /** * Compare two 'simple' (i.e. non-{@link DbObject}) objects using their {@link Object#equals(Object)} method * to decide if there is a difference. - * - * @param left - * @param right - * @param ctx - context - */ - void compareSimple(DbProperty left, DbProperty right, DiffContext ctx); - + * + * @param left DbProperty + * @param right DbProperty + * @param ctx - context + */ + void compareSimple(DbProperty left, DbProperty right, DiffContext ctx); + } \ No newline at end of file diff --git a/source/java/org/alfresco/util/schemacomp/DbObjectXMLTransformer.java b/source/java/org/alfresco/util/schemacomp/DbObjectXMLTransformer.java index f1b2b72bf6..aa7fdec539 100644 --- a/source/java/org/alfresco/util/schemacomp/DbObjectXMLTransformer.java +++ b/source/java/org/alfresco/util/schemacomp/DbObjectXMLTransformer.java @@ -93,7 +93,7 @@ public class DbObjectXMLTransformer /** - * @param validators + * @param validators List * @throws SAXException */ private void transformValidators(List validators) throws SAXException @@ -132,8 +132,8 @@ public class DbObjectXMLTransformer /** * Add class-specific attributes. * - * @param dbObject - * @param attribs + * @param dbObject DbObject + * @param attribs AttributesImpl */ private void addAttributes(DbObject dbObject, AttributesImpl attribs) { @@ -260,8 +260,8 @@ public class DbObjectXMLTransformer * <tag>content</tag> * * - * @param tag - * @param content + * @param tag String + * @param content String * @throws SAXException */ private void simpleElement(String tag, String content) throws SAXException @@ -289,8 +289,8 @@ public class DbObjectXMLTransformer * provided in each columnname element's order attribute. This parameter may be null * in which case order attributes will be ommitted. * - * @param columnNames - * @param columnOrders + * @param columnNames List + * @param columnOrders List * @throws SAXException */ private void columnNameList(List columnNames, diff --git a/source/java/org/alfresco/util/schemacomp/DbProperty.java b/source/java/org/alfresco/util/schemacomp/DbProperty.java index c8798c2cd1..73286fb30d 100644 --- a/source/java/org/alfresco/util/schemacomp/DbProperty.java +++ b/source/java/org/alfresco/util/schemacomp/DbProperty.java @@ -40,9 +40,11 @@ public class DbProperty *

    * The public constructors provide a more usable API with select sets of arguments. * - * @param dbObject - * @param propertyName - * @param propertyValue + * @param dbObject DbObject + * @param propertyName String + * @param index int + * @param useSuppliedValue boolean + * @param propertyValue Object */ protected DbProperty(DbObject dbObject, String propertyName, int index, boolean useSuppliedValue, Object propertyValue) { @@ -94,7 +96,7 @@ public class DbProperty /** * Construct a pointer to a database object only (no property within). * - * @param dbObject + * @param dbObject DbObject */ public DbProperty(DbObject dbObject) { @@ -105,8 +107,8 @@ public class DbProperty * Create a DbProperty by supplying the DbObject and the property name. The * value at time of creation will be populate automatically. * - * @param dbObject - * @param propertyName + * @param dbObject DbObject + * @param propertyName String */ public DbProperty(DbObject dbObject, String propertyName) { @@ -119,9 +121,9 @@ public class DbProperty * index 4, the propertyName will be converted to "myCollection[4]" and the propertValue * will be populated with the value at index 4 of myCollection. * - * @param dbObject - * @param propertyName - * @param index + * @param dbObject DbObject + * @param propertyName String + * @param index int */ public DbProperty(DbObject dbObject, String propertyName, int index) { diff --git a/source/java/org/alfresco/util/schemacomp/DbToXML.java b/source/java/org/alfresco/util/schemacomp/DbToXML.java index c347be0553..47beb0e9a9 100644 --- a/source/java/org/alfresco/util/schemacomp/DbToXML.java +++ b/source/java/org/alfresco/util/schemacomp/DbToXML.java @@ -66,7 +66,7 @@ public class DbToXML /** * Set an optional default schema name * - * @param dbSchemaName + * @param dbSchemaName String */ public void setDbSchemaName(String dbSchemaName) { diff --git a/source/java/org/alfresco/util/schemacomp/DefaultComparisonUtils.java b/source/java/org/alfresco/util/schemacomp/DefaultComparisonUtils.java index 0ae82bda1d..ad2fcee0a1 100644 --- a/source/java/org/alfresco/util/schemacomp/DefaultComparisonUtils.java +++ b/source/java/org/alfresco/util/schemacomp/DefaultComparisonUtils.java @@ -108,7 +108,7 @@ public class DefaultComparisonUtils implements ComparisonUtils * Ensure the property is carrying a list as its payload. A List is required * rather than a Collection as the latter may not be ordered. * - * @param prop + * @param prop DbProperty */ private void checkPropertyContainsList(DbProperty prop) { @@ -321,7 +321,7 @@ public class DefaultComparisonUtils implements ComparisonUtils /** - * @param obj + * @param obj Object */ private void checkNotDbObject(Object obj) { diff --git a/source/java/org/alfresco/util/schemacomp/DiffContext.java b/source/java/org/alfresco/util/schemacomp/DiffContext.java index b4e818d32b..a20ce59c8e 100644 --- a/source/java/org/alfresco/util/schemacomp/DiffContext.java +++ b/source/java/org/alfresco/util/schemacomp/DiffContext.java @@ -38,10 +38,10 @@ public class DiffContext /** * Constructor. * - * @param dialect - * @param results - * @param referenceSchema - * @param targetSchema + * @param dialect Dialect + * @param results Results + * @param referenceSchema Schema + * @param targetSchema Schema */ public DiffContext(Dialect dialect, Results results, Schema referenceSchema, Schema targetSchema) { @@ -54,9 +54,9 @@ public class DiffContext /** * Constructor. * - * @param dialect - * @param referenceSchema - * @param targetSchema + * @param dialect Dialect + * @param referenceSchema Schema + * @param targetSchema Schema */ public DiffContext(Dialect dialect, Schema referenceSchema, Schema targetSchema) { diff --git a/source/java/org/alfresco/util/schemacomp/ExportDb.java b/source/java/org/alfresco/util/schemacomp/ExportDb.java index a8b7f1e0fb..6a2badc1cc 100644 --- a/source/java/org/alfresco/util/schemacomp/ExportDb.java +++ b/source/java/org/alfresco/util/schemacomp/ExportDb.java @@ -89,16 +89,16 @@ public class ExportDb } - /** - * Create a new instance of the tool within the context of an existing database connection - * - * @param dataSource the database connection to use for metadata queries - * @param dialect the Hibernate dialect - * @param descriptorService descriptorService - * @param databaseMetaDataHelper databaseMetaDataHelper - */ - public ExportDb(final DataSource dataSource, final Dialect dialect, DescriptorService descriptorService, DatabaseMetaDataHelper databaseMetaDataHelper) - { + /** + * Create a new instance of the tool within the context of an existing database connection + * + * @param dataSource the database connection to use for metadata queries + * @param dialect the Hibernate dialect + * @param descriptorService descriptorService + * @param databaseMetaDataHelper databaseMetaDataHelper + */ + public ExportDb(final DataSource dataSource, final Dialect dialect, DescriptorService descriptorService, DatabaseMetaDataHelper databaseMetaDataHelper) + { this.dataSource = dataSource; this.dialect = dialect; this.descriptorService = descriptorService; @@ -131,13 +131,13 @@ public class ExportDb } } - - /** - * Initializes the fields ready to perform the database metadata reading - * @throws NoSuchFieldException - * @throws SecurityException - * @throws IllegalAccessException - * @throws IllegalArgumentException + + /** + * Initializes the fields ready to perform the database metadata reading + * @throws NoSuchFieldException + * @throws SecurityException + * @throws IllegalAccessException + * @throws IllegalArgumentException */ @SuppressWarnings("unchecked") private void attemptInit() throws SecurityException, NoSuchFieldException, IllegalArgumentException, IllegalAccessException @@ -394,7 +394,7 @@ public class ExportDb /** * Convert a boolean string as used in the database, to a boolean value. * - * @param nullableString + * @param nullableString String * @return true if "YES", false if "NO" */ private boolean parseBoolean(String nullableString) diff --git a/source/java/org/alfresco/util/schemacomp/MultiFileDumper.java b/source/java/org/alfresco/util/schemacomp/MultiFileDumper.java index 86e3dbed05..e69c6706dd 100644 --- a/source/java/org/alfresco/util/schemacomp/MultiFileDumper.java +++ b/source/java/org/alfresco/util/schemacomp/MultiFileDumper.java @@ -53,11 +53,11 @@ public class MultiFileDumper /** * Constructor with all available arguments. * - * @param dbPrefixes - * @param directory - * @param fileNameTemplate - * @param dbToXMLFactory - * @param defaultSchemaName + * @param dbPrefixes String[] + * @param directory File + * @param fileNameTemplate String + * @param dbToXMLFactory DbToXMLFactory + * @param defaultSchemaName String */ public MultiFileDumper(String[] dbPrefixes, File directory, String fileNameTemplate, DbToXMLFactory dbToXMLFactory, String defaultSchemaName) { @@ -82,9 +82,9 @@ public class MultiFileDumper /** * Construct a MultiFileDumper with the {@link MultiFileDumper#DEFAULT_PREFIXES}. * - * @param directory - * @param fileNameTemplate - * @param dbToXMLFactory + * @param directory File + * @param fileNameTemplate String + * @param dbToXMLFactory DbToXMLFactory * @param defaultSchemaName can be null */ public MultiFileDumper(File directory, String fileNameTemplate, DbToXMLFactory dbToXMLFactory, String defaultSchemaName) diff --git a/source/java/org/alfresco/util/schemacomp/Result.java b/source/java/org/alfresco/util/schemacomp/Result.java index 883e8da9fe..d7ebbeedbc 100644 --- a/source/java/org/alfresco/util/schemacomp/Result.java +++ b/source/java/org/alfresco/util/schemacomp/Result.java @@ -30,7 +30,7 @@ public abstract class Result * delegates to toString() but this should generally be overridden as toString() * is used in a multitude of contexts. * - * @return + * @return String */ public String describe() { diff --git a/source/java/org/alfresco/util/schemacomp/Results.java b/source/java/org/alfresco/util/schemacomp/Results.java index 8739a7a500..fa29e84ab1 100644 --- a/source/java/org/alfresco/util/schemacomp/Results.java +++ b/source/java/org/alfresco/util/schemacomp/Results.java @@ -71,7 +71,7 @@ public class Results implements Iterable /** * Get the ith result. * - * @param i + * @param i int * @return Result */ public Result get(int i) diff --git a/source/java/org/alfresco/util/schemacomp/SchemaComparator.java b/source/java/org/alfresco/util/schemacomp/SchemaComparator.java index c417d111ac..96c0911d64 100644 --- a/source/java/org/alfresco/util/schemacomp/SchemaComparator.java +++ b/source/java/org/alfresco/util/schemacomp/SchemaComparator.java @@ -40,8 +40,9 @@ public class SchemaComparator * Construct a comparator to compare a target schema against a reference schema. Validators supplied * by the reference schema will be used to validate the target schema. * - * @param referenceSchema - * @param targetSchema + * @param referenceSchema Schema + * @param targetSchema Schema + * @param dialect Dialect */ public SchemaComparator(Schema referenceSchema, Schema targetSchema, Dialect dialect) { diff --git a/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java b/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java index 42838809d6..0ba68a7cbf 100644 --- a/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java +++ b/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java @@ -44,8 +44,8 @@ public abstract class AbstractDbObject implements DbObject /** * Instantiate, giving the object a parent and a name. * - * @param parent - * @param name + * @param parent DbObject + * @param name String */ public AbstractDbObject(DbObject parent, String name) { @@ -158,14 +158,14 @@ public abstract class AbstractDbObject implements DbObject sb.append("]"); return sb.toString(); - } - - /** - * Provides an implementation of {@link DbObject#diff(DbObject, DiffContext)}. The template - * method {@link #doDiff(DbObject, DiffContext)} provides the subclass specific diffing logic, - * whilst this method handles the workflow required in most cases: set the path's prefix that will be - * used to explain where differences occur; compare the name fields of the two objects; delegate to the - * subclass specific diffing (if any); remove the last path addition ready for the next object to perform + } + + /** + * Provides an implementation of {@link DbObject#diff(DbObject, DiffContext)}. The template + * method {@link #doDiff(DbObject, DiffContext)} provides the subclass specific diffing logic, + * whilst this method handles the workflow required in most cases: set the path's prefix that will be + * used to explain where differences occur; compare the name fields of the two objects; delegate to the + * subclass specific diffing (if any); remove the last path addition ready for the next object to perform * its diff correctly. */ @Override @@ -194,13 +194,13 @@ public abstract class AbstractDbObject implements DbObject /** - * Override this method to provide subclass specific diffing logic. - * - * @param right - * @param ctx - */ - protected void doDiff(DbObject right, DiffContext ctx) - { + * Override this method to provide subclass specific diffing logic. + * + * @param right DbObject + * @param ctx DiffContext + */ + protected void doDiff(DbObject right, DiffContext ctx) + { } diff --git a/source/java/org/alfresco/util/schemacomp/model/Column.java b/source/java/org/alfresco/util/schemacomp/model/Column.java index d90d1bf030..25f38554ce 100644 --- a/source/java/org/alfresco/util/schemacomp/model/Column.java +++ b/source/java/org/alfresco/util/schemacomp/model/Column.java @@ -43,10 +43,10 @@ public class Column extends AbstractDbObject /** * Construct a Column. * - * @table the parent table - * @param name - * @param type - * @param nullable + * @param table the parent table + * @param name String + * @param type String + * @param nullable boolean */ public Column(Table table, String name, String type, boolean nullable) { diff --git a/source/java/org/alfresco/util/schemacomp/model/DbObject.java b/source/java/org/alfresco/util/schemacomp/model/DbObject.java index 4b001e3974..a46869542c 100644 --- a/source/java/org/alfresco/util/schemacomp/model/DbObject.java +++ b/source/java/org/alfresco/util/schemacomp/model/DbObject.java @@ -42,8 +42,8 @@ public interface DbObject * a.sameAs(b) == true it makes it easier to show the differences as related, i.e. a and b are * different rather than, a is only in the 'left' tree and b is only in the 'right' tree. * - * @param other - * @return + * @param other DbObject + * @return boolean */ boolean sameAs(DbObject other); @@ -69,7 +69,7 @@ public interface DbObject * Allows a visitor to be invoked against this DbObject. Implementations should ensure that child * objects are visited first (by calling accept on them) before invoking the visitor on itself. * - * @param visitor + * @param visitor DbObjectVisitor */ void accept(DbObjectVisitor visitor); @@ -85,7 +85,7 @@ public interface DbObject * Sets the parent object. * * @see #getParent() - * @param parent + * @param parent DbObject */ void setParent(DbObject parent); @@ -101,7 +101,7 @@ public interface DbObject /** * Set/override the validators associated with this database object. * - * @param validators + * @param validators List */ void setValidators(List validators); @@ -116,7 +116,7 @@ public interface DbObject * Is there at least one validator that assumes object-level validation * that removes the requirement for reporting of differences for this object? * - * @return + * @return boolean */ boolean hasObjectLevelValidator(); diff --git a/source/java/org/alfresco/util/schemacomp/model/ForeignKey.java b/source/java/org/alfresco/util/schemacomp/model/ForeignKey.java index 5a29f1cfff..8f0d5c0ddc 100644 --- a/source/java/org/alfresco/util/schemacomp/model/ForeignKey.java +++ b/source/java/org/alfresco/util/schemacomp/model/ForeignKey.java @@ -45,10 +45,10 @@ public class ForeignKey extends AbstractDbObject * Constructor. * * @param table the parent table - * @param fkName - * @param localColumn - * @param targetTable - * @param targetColumn + * @param fkName String + * @param localColumn String + * @param targetTable String + * @param targetColumn String */ public ForeignKey(Table table, String fkName, String localColumn, String targetTable, String targetColumn) { diff --git a/source/java/org/alfresco/util/schemacomp/model/Index.java b/source/java/org/alfresco/util/schemacomp/model/Index.java index b748b48974..71fdac7030 100644 --- a/source/java/org/alfresco/util/schemacomp/model/Index.java +++ b/source/java/org/alfresco/util/schemacomp/model/Index.java @@ -45,7 +45,7 @@ public class Index extends AbstractDbObject /** * @param table the parent table - * @param columnNames + * @param columnNames List */ public Index(Table table, String name, List columnNames) { @@ -82,7 +82,7 @@ public class Index extends AbstractDbObject /** * @see #isUnique() - * @param unique + * @param unique boolean */ public void setUnique(boolean unique) { diff --git a/source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java b/source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java index 8906a5be1c..e47d65167d 100644 --- a/source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java +++ b/source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java @@ -44,8 +44,9 @@ public class PrimaryKey extends AbstractDbObject /** * Constructor * @param table the parent table - * @param name - * @param columnNames + * @param name String + * @param columnNames List + * @param columnOrders List */ public PrimaryKey(Table table, String name, List columnNames, List columnOrders) { diff --git a/source/java/org/alfresco/util/schemacomp/model/Schema.java b/source/java/org/alfresco/util/schemacomp/model/Schema.java index d97d5717fa..6c56b0d596 100644 --- a/source/java/org/alfresco/util/schemacomp/model/Schema.java +++ b/source/java/org/alfresco/util/schemacomp/model/Schema.java @@ -45,7 +45,7 @@ public class Schema extends AbstractDbObject implements Iterable /** * Construct a schema with the given name and no database prefix. * - * @param name + * @param name String */ public Schema(String name) { @@ -59,8 +59,10 @@ public class Schema extends AbstractDbObject implements Iterable * whose names begin with "alf_" will be represented by this schema. Therefore any comparisons * should be performed against another similarly filtered Schema object. * - * @param name - * @param dbPrefix + * @param name String + * @param dbPrefix String + * @param schemaVersion int + * @param checkTableColumnOrder boolean */ public Schema(String name, String dbPrefix, int schemaVersion, boolean checkTableColumnOrder) { @@ -92,7 +94,7 @@ public class Schema extends AbstractDbObject implements Iterable * Add an object to this schema - this method will set this schema * as the object's parent. * - * @param dbObject + * @param dbObject DbObject */ public void add(DbObject dbObject) { @@ -107,8 +109,8 @@ public class Schema extends AbstractDbObject implements Iterable } /** - * @param object - * @return + * @param object DbObject + * @return boolean */ public boolean contains(DbObject object) { diff --git a/source/java/org/alfresco/util/schemacomp/validator/DbValidator.java b/source/java/org/alfresco/util/schemacomp/validator/DbValidator.java index ded895f562..6917491d9b 100644 --- a/source/java/org/alfresco/util/schemacomp/validator/DbValidator.java +++ b/source/java/org/alfresco/util/schemacomp/validator/DbValidator.java @@ -35,9 +35,9 @@ public interface DbValidator * Validate the target database object (against the reference object if necessary). Store * the validation results on the DiffContext. * - * @param reference - * @param target - * @param ctx + * @param reference DbObject + * @param target DbObject + * @param ctx DiffContext */ void validate(DbObject reference, DbObject target, DiffContext ctx); @@ -45,23 +45,23 @@ public interface DbValidator * Set a property used by this validator. Validator properties provided in the schema reference * XML files will be set on the validator using this method. * - * @param name - * @param value + * @param name String + * @param value String */ void setProperty(String name, String value); /** * Get the current value of a validator property, as set using {@link #setProperty(String, String)}. * - * @param name - * @return + * @param name String + * @return String */ String getProperty(String name); /** * Get the complete set of validator properties in use. * - * @return + * @return Set */ Set getPropertyNames(); @@ -70,8 +70,8 @@ public interface DbValidator * the specified field name. This only applies to simple properties - not DbObject instances * which should provide their own validators. * - * @param fieldName - * @return + * @param fieldName String + * @return boolean */ boolean validates(String fieldName); diff --git a/source/test-java/org/alfresco/Repository03TestSuite.java b/source/test-java/org/alfresco/Repository03TestSuite.java index 9304e14ae0..4307117c41 100644 --- a/source/test-java/org/alfresco/Repository03TestSuite.java +++ b/source/test-java/org/alfresco/Repository03TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository03TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository04TestSuite.java b/source/test-java/org/alfresco/Repository04TestSuite.java index 949b021c82..25941e94ae 100644 --- a/source/test-java/org/alfresco/Repository04TestSuite.java +++ b/source/test-java/org/alfresco/Repository04TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository04TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository06TestSuite.java b/source/test-java/org/alfresco/Repository06TestSuite.java index 1ac94e2ece..4c57aeed6f 100644 --- a/source/test-java/org/alfresco/Repository06TestSuite.java +++ b/source/test-java/org/alfresco/Repository06TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository06TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository07TestSuite.java b/source/test-java/org/alfresco/Repository07TestSuite.java index 57a182b3c7..52736043d3 100644 --- a/source/test-java/org/alfresco/Repository07TestSuite.java +++ b/source/test-java/org/alfresco/Repository07TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository07TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository08TestSuite.java b/source/test-java/org/alfresco/Repository08TestSuite.java index 8dabc8d630..84c27a48bd 100644 --- a/source/test-java/org/alfresco/Repository08TestSuite.java +++ b/source/test-java/org/alfresco/Repository08TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository08TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository09TestSuite.java b/source/test-java/org/alfresco/Repository09TestSuite.java index be1ae4dbbf..eab87256ae 100644 --- a/source/test-java/org/alfresco/Repository09TestSuite.java +++ b/source/test-java/org/alfresco/Repository09TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository09TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository10TestSuite.java b/source/test-java/org/alfresco/Repository10TestSuite.java index 06c80ef98a..e9cfca1abe 100644 --- a/source/test-java/org/alfresco/Repository10TestSuite.java +++ b/source/test-java/org/alfresco/Repository10TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository10TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository11TestSuite.java b/source/test-java/org/alfresco/Repository11TestSuite.java index ef61a66fb8..62c791da08 100644 --- a/source/test-java/org/alfresco/Repository11TestSuite.java +++ b/source/test-java/org/alfresco/Repository11TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository11TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository13TestSuite.java b/source/test-java/org/alfresco/Repository13TestSuite.java index ab16f136ad..0f0edf5003 100644 --- a/source/test-java/org/alfresco/Repository13TestSuite.java +++ b/source/test-java/org/alfresco/Repository13TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository13TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository14TestSuite.java b/source/test-java/org/alfresco/Repository14TestSuite.java index 71f3e08d66..827b9ab8a7 100644 --- a/source/test-java/org/alfresco/Repository14TestSuite.java +++ b/source/test-java/org/alfresco/Repository14TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository14TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository15TestSuite.java b/source/test-java/org/alfresco/Repository15TestSuite.java index 9af6de604b..7e0431bd24 100644 --- a/source/test-java/org/alfresco/Repository15TestSuite.java +++ b/source/test-java/org/alfresco/Repository15TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository15TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository16TestSuite.java b/source/test-java/org/alfresco/Repository16TestSuite.java index fe1c51f2a6..dd4ce0ad1f 100644 --- a/source/test-java/org/alfresco/Repository16TestSuite.java +++ b/source/test-java/org/alfresco/Repository16TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository16TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository17TestSuite.java b/source/test-java/org/alfresco/Repository17TestSuite.java index 1e242a0cb4..22fb53da09 100644 --- a/source/test-java/org/alfresco/Repository17TestSuite.java +++ b/source/test-java/org/alfresco/Repository17TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository17TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository18TestSuite.java b/source/test-java/org/alfresco/Repository18TestSuite.java index af240554d5..f5823ebc94 100644 --- a/source/test-java/org/alfresco/Repository18TestSuite.java +++ b/source/test-java/org/alfresco/Repository18TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository18TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository21TestSuite.java b/source/test-java/org/alfresco/Repository21TestSuite.java index b05087a649..73b4a80ea8 100644 --- a/source/test-java/org/alfresco/Repository21TestSuite.java +++ b/source/test-java/org/alfresco/Repository21TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository21TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository22TestSuite.java b/source/test-java/org/alfresco/Repository22TestSuite.java index 0013a25296..fb85c6f608 100644 --- a/source/test-java/org/alfresco/Repository22TestSuite.java +++ b/source/test-java/org/alfresco/Repository22TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository22TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository23TestSuite.java b/source/test-java/org/alfresco/Repository23TestSuite.java index d6ba447b52..2e1802b5e6 100644 --- a/source/test-java/org/alfresco/Repository23TestSuite.java +++ b/source/test-java/org/alfresco/Repository23TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository23TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository24TestSuite.java b/source/test-java/org/alfresco/Repository24TestSuite.java index cefdfa1894..fd312e9df8 100644 --- a/source/test-java/org/alfresco/Repository24TestSuite.java +++ b/source/test-java/org/alfresco/Repository24TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository24TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository27TestSuite.java b/source/test-java/org/alfresco/Repository27TestSuite.java index 113a15b442..dd3e1eabd5 100644 --- a/source/test-java/org/alfresco/Repository27TestSuite.java +++ b/source/test-java/org/alfresco/Repository27TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository27TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository28TestSuite.java b/source/test-java/org/alfresco/Repository28TestSuite.java index 0ba01e6b03..3e67902983 100644 --- a/source/test-java/org/alfresco/Repository28TestSuite.java +++ b/source/test-java/org/alfresco/Repository28TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository28TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository29TestSuite.java b/source/test-java/org/alfresco/Repository29TestSuite.java index fc546cad59..ed552e5b14 100644 --- a/source/test-java/org/alfresco/Repository29TestSuite.java +++ b/source/test-java/org/alfresco/Repository29TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository29TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository30TestSuite.java b/source/test-java/org/alfresco/Repository30TestSuite.java index 412bc473f1..f69cdd87e6 100644 --- a/source/test-java/org/alfresco/Repository30TestSuite.java +++ b/source/test-java/org/alfresco/Repository30TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository30TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository31TestSuite.java b/source/test-java/org/alfresco/Repository31TestSuite.java index 3db594a1c9..61af85ca4c 100644 --- a/source/test-java/org/alfresco/Repository31TestSuite.java +++ b/source/test-java/org/alfresco/Repository31TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository31TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository32TestSuite.java b/source/test-java/org/alfresco/Repository32TestSuite.java index d645cdd8fe..049125de3f 100644 --- a/source/test-java/org/alfresco/Repository32TestSuite.java +++ b/source/test-java/org/alfresco/Repository32TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository32TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository33TestSuite.java b/source/test-java/org/alfresco/Repository33TestSuite.java index 8b70f3c14c..d5ea22dfb1 100644 --- a/source/test-java/org/alfresco/Repository33TestSuite.java +++ b/source/test-java/org/alfresco/Repository33TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository33TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository34TestSuite.java b/source/test-java/org/alfresco/Repository34TestSuite.java index ee01925c7c..16ef6d6a7f 100644 --- a/source/test-java/org/alfresco/Repository34TestSuite.java +++ b/source/test-java/org/alfresco/Repository34TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository34TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository35TestSuite.java b/source/test-java/org/alfresco/Repository35TestSuite.java index 79dd07c103..a9b386b387 100644 --- a/source/test-java/org/alfresco/Repository35TestSuite.java +++ b/source/test-java/org/alfresco/Repository35TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository35TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository36TestSuite.java b/source/test-java/org/alfresco/Repository36TestSuite.java index 85200aa507..fc90206dad 100644 --- a/source/test-java/org/alfresco/Repository36TestSuite.java +++ b/source/test-java/org/alfresco/Repository36TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository36TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository37TestSuite.java b/source/test-java/org/alfresco/Repository37TestSuite.java index be426962da..55fda78a99 100644 --- a/source/test-java/org/alfresco/Repository37TestSuite.java +++ b/source/test-java/org/alfresco/Repository37TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository37TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository38TestSuite.java b/source/test-java/org/alfresco/Repository38TestSuite.java index c6d061578b..d4b743fd19 100644 --- a/source/test-java/org/alfresco/Repository38TestSuite.java +++ b/source/test-java/org/alfresco/Repository38TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository38TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository39TestSuite.java b/source/test-java/org/alfresco/Repository39TestSuite.java index fc8d633758..8cf3f7ff32 100644 --- a/source/test-java/org/alfresco/Repository39TestSuite.java +++ b/source/test-java/org/alfresco/Repository39TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository39TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository40TestSuite.java b/source/test-java/org/alfresco/Repository40TestSuite.java index cab9d94415..88c7b91301 100644 --- a/source/test-java/org/alfresco/Repository40TestSuite.java +++ b/source/test-java/org/alfresco/Repository40TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository40TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository41TestSuite.java b/source/test-java/org/alfresco/Repository41TestSuite.java index 95f001a2f1..5893a40e61 100644 --- a/source/test-java/org/alfresco/Repository41TestSuite.java +++ b/source/test-java/org/alfresco/Repository41TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository41TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository42TestSuite.java b/source/test-java/org/alfresco/Repository42TestSuite.java index 35dfb6ce97..8511d16d27 100644 --- a/source/test-java/org/alfresco/Repository42TestSuite.java +++ b/source/test-java/org/alfresco/Repository42TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository42TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository43TestSuite.java b/source/test-java/org/alfresco/Repository43TestSuite.java index 030d42f797..996193da87 100644 --- a/source/test-java/org/alfresco/Repository43TestSuite.java +++ b/source/test-java/org/alfresco/Repository43TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository43TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository44TestSuite.java b/source/test-java/org/alfresco/Repository44TestSuite.java index f15a9b300e..5345f987e6 100644 --- a/source/test-java/org/alfresco/Repository44TestSuite.java +++ b/source/test-java/org/alfresco/Repository44TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository44TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository45TestSuite.java b/source/test-java/org/alfresco/Repository45TestSuite.java index a95dd387a1..306f880fca 100644 --- a/source/test-java/org/alfresco/Repository45TestSuite.java +++ b/source/test-java/org/alfresco/Repository45TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository45TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository46TestSuite.java b/source/test-java/org/alfresco/Repository46TestSuite.java index 2f90e987c3..7a4d573c04 100644 --- a/source/test-java/org/alfresco/Repository46TestSuite.java +++ b/source/test-java/org/alfresco/Repository46TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository46TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository47TestSuite.java b/source/test-java/org/alfresco/Repository47TestSuite.java index 131773e1f8..7b8a02ecbc 100644 --- a/source/test-java/org/alfresco/Repository47TestSuite.java +++ b/source/test-java/org/alfresco/Repository47TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository47TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository48TestSuite.java b/source/test-java/org/alfresco/Repository48TestSuite.java index 47f444e924..a66b55b5af 100644 --- a/source/test-java/org/alfresco/Repository48TestSuite.java +++ b/source/test-java/org/alfresco/Repository48TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository48TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository49TestSuite.java b/source/test-java/org/alfresco/Repository49TestSuite.java index 5864755274..46aa7c3e9c 100644 --- a/source/test-java/org/alfresco/Repository49TestSuite.java +++ b/source/test-java/org/alfresco/Repository49TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository49TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository50TestSuite.java b/source/test-java/org/alfresco/Repository50TestSuite.java index e08abd0f42..d93173d080 100644 --- a/source/test-java/org/alfresco/Repository50TestSuite.java +++ b/source/test-java/org/alfresco/Repository50TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository50TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository51TestSuite.java b/source/test-java/org/alfresco/Repository51TestSuite.java index 46f474c14a..0e9a8d4a7d 100644 --- a/source/test-java/org/alfresco/Repository51TestSuite.java +++ b/source/test-java/org/alfresco/Repository51TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository51TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository52TestSuite.java b/source/test-java/org/alfresco/Repository52TestSuite.java index 6b9f1ae955..e94f106ef7 100644 --- a/source/test-java/org/alfresco/Repository52TestSuite.java +++ b/source/test-java/org/alfresco/Repository52TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository52TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository53TestSuite.java b/source/test-java/org/alfresco/Repository53TestSuite.java index 2fda440b6f..478689e949 100644 --- a/source/test-java/org/alfresco/Repository53TestSuite.java +++ b/source/test-java/org/alfresco/Repository53TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository53TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository55TestSuite.java b/source/test-java/org/alfresco/Repository55TestSuite.java index b90f8887fe..3bb96420a4 100644 --- a/source/test-java/org/alfresco/Repository55TestSuite.java +++ b/source/test-java/org/alfresco/Repository55TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository55TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository56TestSuite.java b/source/test-java/org/alfresco/Repository56TestSuite.java index 97cf65ccba..4ac05229c2 100644 --- a/source/test-java/org/alfresco/Repository56TestSuite.java +++ b/source/test-java/org/alfresco/Repository56TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository56TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository57TestSuite.java b/source/test-java/org/alfresco/Repository57TestSuite.java index 40742f9b93..db918cfa65 100644 --- a/source/test-java/org/alfresco/Repository57TestSuite.java +++ b/source/test-java/org/alfresco/Repository57TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository57TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository58TestSuite.java b/source/test-java/org/alfresco/Repository58TestSuite.java index f91be46e89..4923ac7bb1 100644 --- a/source/test-java/org/alfresco/Repository58TestSuite.java +++ b/source/test-java/org/alfresco/Repository58TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository58TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository59TestSuite.java b/source/test-java/org/alfresco/Repository59TestSuite.java index 1340843bf8..83e8ebc29f 100644 --- a/source/test-java/org/alfresco/Repository59TestSuite.java +++ b/source/test-java/org/alfresco/Repository59TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository59TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository61TestSuite.java b/source/test-java/org/alfresco/Repository61TestSuite.java index ef113de8cb..d40b815de2 100644 --- a/source/test-java/org/alfresco/Repository61TestSuite.java +++ b/source/test-java/org/alfresco/Repository61TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository61TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository63TestSuite.java b/source/test-java/org/alfresco/Repository63TestSuite.java index 4670b73b42..c97a038772 100644 --- a/source/test-java/org/alfresco/Repository63TestSuite.java +++ b/source/test-java/org/alfresco/Repository63TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link Repository01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @author Alan Davis + */ public class Repository63TestSuite extends TestSuite { public static Test suite() diff --git a/source/test-java/org/alfresco/Repository65TestSuite.java b/source/test-java/org/alfresco/Repository65TestSuite.java index 34e4734b66..e63aa22759 100644 --- a/source/test-java/org/alfresco/Repository65TestSuite.java +++ b/source/test-java/org/alfresco/Repository65TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link Repository01TestSuite} * - * @Author Alexey Bogdanov + * @author Alexey Bogdanov */ public class Repository65TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/opencmis/AlfrescoCmisExceptionInterceptorTest.java b/source/test-java/org/alfresco/opencmis/AlfrescoCmisExceptionInterceptorTest.java index 89256b7487..935fc9a4ce 100644 --- a/source/test-java/org/alfresco/opencmis/AlfrescoCmisExceptionInterceptorTest.java +++ b/source/test-java/org/alfresco/opencmis/AlfrescoCmisExceptionInterceptorTest.java @@ -49,7 +49,7 @@ public class AlfrescoCmisExceptionInterceptorTest /** * Does the mock call ensuring that the exception is thrown - * @throws throws the exception provided + * @throws Throwable the exception provided */ private void doMockCall(Exception toThrow, Class toCatch) throws Throwable { diff --git a/source/test-java/org/alfresco/repo/action/ActionTrackingServiceImplTest.java b/source/test-java/org/alfresco/repo/action/ActionTrackingServiceImplTest.java index 066c4bc97d..f15d7ef7c5 100644 --- a/source/test-java/org/alfresco/repo/action/ActionTrackingServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/action/ActionTrackingServiceImplTest.java @@ -1262,7 +1262,7 @@ public class ActionTrackingServiceImplTest extends TestCase /** * - * @param id + * @param id String * @param isFatal true means the sleep action will fail with a RuntimeException, * false means it will fail with a {@link ActionServiceTransientException}. */ diff --git a/source/test-java/org/alfresco/repo/action/executer/AbstractMailActionExecuterTest.java b/source/test-java/org/alfresco/repo/action/executer/AbstractMailActionExecuterTest.java index b4a2d81853..cff17096bf 100644 --- a/source/test-java/org/alfresco/repo/action/executer/AbstractMailActionExecuterTest.java +++ b/source/test-java/org/alfresco/repo/action/executer/AbstractMailActionExecuterTest.java @@ -418,9 +418,9 @@ public abstract class AbstractMailActionExecuterTest /** * Creates a test user with the specified username and optionally custom email. * - * @param userName + * @param userName String * @param email Optional, if not specified assigned to userName + "@email.com" - * @return + * @return NodeRef */ private NodeRef createUser(String userName, String email) { @@ -482,7 +482,8 @@ public abstract class AbstractMailActionExecuterTest /** * Test for MNT-11488 - * @throws Exception + * @throws IOException + * @throws MessagingException */ @Test public void testSendingToMultipleUsers() throws IOException, MessagingException diff --git a/source/test-java/org/alfresco/repo/blog/BlogServiceImplTest.java b/source/test-java/org/alfresco/repo/blog/BlogServiceImplTest.java index 0652cb54eb..d0ec9650e0 100644 --- a/source/test-java/org/alfresco/repo/blog/BlogServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/blog/BlogServiceImplTest.java @@ -181,7 +181,7 @@ public class BlogServiceImplTest /** * Deletes the specified NodeRefs, if they exist. - * @param nodesToDelete + * @param nodesToDelete List */ private static void performDeletionOfNodes(final List nodesToDelete) { @@ -283,7 +283,7 @@ public class BlogServiceImplTest /** * This method asserts that the given List has NodeRefs in order of the specified date property. * - * @param blogPosts + * @param blogPosts List * @param property a Date property * @param ascendingOrder true if ascending order, false for descending. */ diff --git a/source/test-java/org/alfresco/repo/calendar/CalendarServiceImplTest.java b/source/test-java/org/alfresco/repo/calendar/CalendarServiceImplTest.java index 6f93403ceb..7414269671 100644 --- a/source/test-java/org/alfresco/repo/calendar/CalendarServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/calendar/CalendarServiceImplTest.java @@ -1174,7 +1174,7 @@ public class CalendarServiceImplTest /** * Deletes the specified NodeRefs, if they exist. - * @param nodesToDelete + * @param nodesToDelete List */ private static void performDeletionOfNodes(final List nodesToDelete) { diff --git a/source/test-java/org/alfresco/repo/coci/CheckOutCheckInServiceImplTest.java b/source/test-java/org/alfresco/repo/coci/CheckOutCheckInServiceImplTest.java index ed30caaa53..e38a9272f9 100644 --- a/source/test-java/org/alfresco/repo/coci/CheckOutCheckInServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/coci/CheckOutCheckInServiceImplTest.java @@ -221,7 +221,7 @@ public class CheckOutCheckInServiceImplTest extends BaseSpringTest /** * - * @return + * @return NodeRef */ private NodeRef checkout() { diff --git a/source/test-java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java b/source/test-java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java index 0af8c7e54b..5d12705e08 100644 --- a/source/test-java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java +++ b/source/test-java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java @@ -525,7 +525,7 @@ public abstract class AbstractWritableContentStoreTest extends AbstractReadOnlyC /** * The simplest test. Write a string and read it again, checking that we receive the same values. - * If the resource accessed by {@link #getReader()} and {@link #getWriter()} is not the same, then + * If the resource accessed by {@link #getReader(String)} and {@link #getWriter()} is not the same, then * values written and read won't be the same. */ @Test diff --git a/source/test-java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanupJobTest.java b/source/test-java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanupJobTest.java index 5466a6057a..108fa51fab 100644 --- a/source/test-java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanupJobTest.java +++ b/source/test-java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanupJobTest.java @@ -424,7 +424,7 @@ public class CachedContentCleanupJobTest * Mimick functionality of ContentCacheImpl.createNewCacheFilePath() * but allowing a specific date (rather than 'now') to be used. * - * @param calendar + * @param calendar Calendar * @return Path to use for cache file. */ private String createNewCacheFilePath(Calendar calendar) diff --git a/source/test-java/org/alfresco/repo/content/caching/test/SlowContentStore.java b/source/test-java/org/alfresco/repo/content/caching/test/SlowContentStore.java index cbfeac6941..ee0f9c2640 100644 --- a/source/test-java/org/alfresco/repo/content/caching/test/SlowContentStore.java +++ b/source/test-java/org/alfresco/repo/content/caching/test/SlowContentStore.java @@ -255,7 +255,7 @@ class SlowContentStore extends AbstractContentStore * Length of time in milliseconds that ReadableByteChannel and WriteableByteChannel objects returned * by SlowContentStore will pause for during read and write operations respectively. * - * @param pauseMillis + * @param pauseMillis int */ public void setPauseMillis(int pauseMillis) { diff --git a/source/test-java/org/alfresco/repo/content/metadata/AbstractMetadataExtracterTest.java b/source/test-java/org/alfresco/repo/content/metadata/AbstractMetadataExtracterTest.java index 4ca1bde419..fe47679b61 100644 --- a/source/test-java/org/alfresco/repo/content/metadata/AbstractMetadataExtracterTest.java +++ b/source/test-java/org/alfresco/repo/content/metadata/AbstractMetadataExtracterTest.java @@ -203,7 +203,7 @@ public abstract class AbstractMetadataExtracterTest extends TestCase * This method can be overridden to cause the author/creator property check to be skipped. * The default behaviour is for the check not to be skipped for all MIME types. * - * @param mimetype + * @param mimetype String * @return true to skip the checks, else false */ protected boolean skipAuthorCheck(String mimetype) @@ -215,7 +215,7 @@ public abstract class AbstractMetadataExtracterTest extends TestCase * This method can be overridden to cause the description property check to be skipped. * The default behaviour is for the check not to be skipped for all MIME types. * - * @param mimetype + * @param mimetype String * @return true to skip the checks, else false */ protected boolean skipDescriptionCheck(String mimetype) diff --git a/source/test-java/org/alfresco/repo/content/replication/AggregatingContentStoreTest.java b/source/test-java/org/alfresco/repo/content/replication/AggregatingContentStoreTest.java index 9106f251e3..083d7ebdd0 100644 --- a/source/test-java/org/alfresco/repo/content/replication/AggregatingContentStoreTest.java +++ b/source/test-java/org/alfresco/repo/content/replication/AggregatingContentStoreTest.java @@ -128,7 +128,7 @@ public class AggregatingContentStoreTest extends AbstractWritableContentStoreTes /** * Checks that the url is present in each of the stores * - * @param contentUrl + * @param contentUrl String * @param mustExist true if the content must exist, false if it must not exist */ private void checkForUrl(String contentUrl, boolean mustExist) diff --git a/source/test-java/org/alfresco/repo/content/replication/ReplicatingContentStoreTest.java b/source/test-java/org/alfresco/repo/content/replication/ReplicatingContentStoreTest.java index 6351a099b8..7eb5639a0c 100644 --- a/source/test-java/org/alfresco/repo/content/replication/ReplicatingContentStoreTest.java +++ b/source/test-java/org/alfresco/repo/content/replication/ReplicatingContentStoreTest.java @@ -129,7 +129,7 @@ public class ReplicatingContentStoreTest extends AbstractWritableContentStoreTes /** * Checks that the url is present in each of the stores * - * @param contentUrl + * @param contentUrl String * @param mustExist true if the content must exist, false if it must not exist */ private void checkForUrl(String contentUrl, boolean mustExist) diff --git a/source/test-java/org/alfresco/repo/content/transform/AbstractContentTransformerTest.java b/source/test-java/org/alfresco/repo/content/transform/AbstractContentTransformerTest.java index 609e94f702..aac7707392 100644 --- a/source/test-java/org/alfresco/repo/content/transform/AbstractContentTransformerTest.java +++ b/source/test-java/org/alfresco/repo/content/transform/AbstractContentTransformerTest.java @@ -118,13 +118,13 @@ public abstract class AbstractContentTransformerTest extends TestCase } /** - * Helper method to load one of the "The quick brown fox" files from the - * classpath. - * - * @param quickname file required, eg quick.txt - * @return Returns a test resource loaded from the classpath or null if - * no resource could be found. - * @throws IOException + * Helper method to load one of the "The quick brown fox" files from the + * classpath. + * + * @param quickname file required, eg quick.txt + * @return Returns a test resource loaded from the classpath or null if + * no resource could be found. + * @throws IOException */ public static File loadNamedQuickTestFile(String quickname) throws IOException { @@ -155,13 +155,13 @@ public abstract class AbstractContentTransformerTest extends TestCase return ResourceUtils.getFile(url); } /** - * Helper method to load one of the "The quick brown fox" files from the - * classpath. - * - * @param extension file extension required, eg txt for the file quick.txt - * @return Returns a test resource loaded from the classpath or null if - * no resource could be found. - * @throws IOException + * Helper method to load one of the "The quick brown fox" files from the + * classpath. + * + * @param extension file extension required, eg txt for the file quick.txt + * @return Returns a test resource loaded from the classpath or null if + * no resource could be found. + * @throws IOException */ public static File loadQuickTestFile(String extension) throws IOException { @@ -404,9 +404,9 @@ public abstract class AbstractContentTransformerTest extends TestCase * This method is an extension point for excluding certain transformations in a subclass. * The default implementation returns false for all mime type pairs. * - * @param sourceExtension - * @param targetExtension - * @return + * @param sourceExtension String + * @param targetExtension String + * @return boolean */ protected boolean isTransformationExcluded(String sourceExtension, String targetExtension) { diff --git a/source/test-java/org/alfresco/repo/content/transform/StringExtractingContentTransformerTest.java b/source/test-java/org/alfresco/repo/content/transform/StringExtractingContentTransformerTest.java index 83b9916bb8..d70b4a23ea 100644 --- a/source/test-java/org/alfresco/repo/content/transform/StringExtractingContentTransformerTest.java +++ b/source/test-java/org/alfresco/repo/content/transform/StringExtractingContentTransformerTest.java @@ -95,8 +95,8 @@ public class StringExtractingContentTransformerTest extends AbstractContentTrans /** * Writes some content using the mimetype and encoding specified. * - * @param mimetype - * @param encoding + * @param mimetype String + * @param encoding String * @return Returns a reader onto the newly written content */ private ContentReader writeContent(String mimetype, String encoding) diff --git a/source/test-java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrapTest.java b/source/test-java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrapTest.java index 4c0731193a..e79cd54bf0 100644 --- a/source/test-java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrapTest.java +++ b/source/test-java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrapTest.java @@ -244,14 +244,14 @@ public class DictionaryRepositoryBootstrapTest extends BaseSpringTest /** * Create model node * - * @param uri - * @param prefix - * @param modelLocalName - * @param importStatement - * @param description - * @param typeName - * @param propertyName - * @return + * @param uri String + * @param prefix String + * @param modelLocalName String + * @param importStatement String + * @param description String + * @param typeName String + * @param propertyName String + * @return NodeRef */ private NodeRef createModelNode( String uri, @@ -291,14 +291,14 @@ public class DictionaryRepositoryBootstrapTest extends BaseSpringTest * * Gets the model string * - * @param uri - * @param prefix - * @param modelLocalName - * @param importStatement - * @param description - * @param typeName - * @param propertyName - * @return + * @param uri String + * @param prefix String + * @param modelLocalName String + * @param importStatement String + * @param description String + * @param typeName String + * @param propertyName String + * @return String */ private String getModelString( String uri, diff --git a/source/test-java/org/alfresco/repo/discussion/DiscussionServiceImplTest.java b/source/test-java/org/alfresco/repo/discussion/DiscussionServiceImplTest.java index 745f3a47ad..345ae6d9f6 100644 --- a/source/test-java/org/alfresco/repo/discussion/DiscussionServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/discussion/DiscussionServiceImplTest.java @@ -1909,7 +1909,7 @@ public class DiscussionServiceImplTest /** * Deletes the specified NodeRefs, if they exist. - * @param nodesToDelete + * @param nodesToDelete List */ private static void performDeletionOfNodes(final List nodesToDelete) { diff --git a/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java b/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java index 5873b9d53b..d1e153187f 100644 --- a/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java +++ b/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java @@ -313,13 +313,13 @@ public class ExporterComponentTest extends BaseSpringTest } assertTrue("The MNT12504 is reproduced.", isFixed); - } - - /** - * @param nodeRef nodeRef - * @return - * @throws FileNotFoundException - * @throws IOException + } + + /** + * @param nodeRef nodeRef + * @return File + * @throws FileNotFoundException + * @throws IOException */ private File exportContent(NodeRef nodeRef) throws FileNotFoundException, IOException @@ -342,9 +342,9 @@ public class ExporterComponentTest extends BaseSpringTest } /** - * @param storeRef - * @param rootNode - * @return + * @param storeRef StoreRef + * @param rootNode NodeRef + * @return ChildAssociationRef */ private ChildAssociationRef createContentWithCategories(StoreRef storeRef, NodeRef rootNode) { @@ -387,9 +387,9 @@ public class ExporterComponentTest extends BaseSpringTest } /** - * @param acpFile - * @param destRootNode - * @return + * @param acpFile File + * @param destRootNode NodeRef + * @return FileInfo */ private FileInfo importContent(File acpFile, NodeRef destRootNode) { diff --git a/source/test-java/org/alfresco/repo/imap/ImapMessageTest.java b/source/test-java/org/alfresco/repo/imap/ImapMessageTest.java index 729a8be076..ea1021da8f 100644 --- a/source/test-java/org/alfresco/repo/imap/ImapMessageTest.java +++ b/source/test-java/org/alfresco/repo/imap/ImapMessageTest.java @@ -614,7 +614,7 @@ public class ImapMessageTest extends TestCase /** * Finds node by its path * - * @param path + * @param path String * @return NodeRef */ private NodeRef findNode(String path) diff --git a/source/test-java/org/alfresco/repo/invitation/site/InviteSenderTest.java b/source/test-java/org/alfresco/repo/invitation/site/InviteSenderTest.java index 5718709dbe..a16b06920c 100644 --- a/source/test-java/org/alfresco/repo/invitation/site/InviteSenderTest.java +++ b/source/test-java/org/alfresco/repo/invitation/site/InviteSenderTest.java @@ -291,7 +291,7 @@ public class InviteSenderTest extends TestCase /** * Mocks up a Repository that will return the inviter as the current user. * - * @return + * @return Repository */ private Repository mockRepository() { @@ -301,7 +301,7 @@ public class InviteSenderTest extends TestCase } /** - * @return + * @return ServiceRegistry */ private ServiceRegistry mockServices() { @@ -360,7 +360,7 @@ public class InviteSenderTest extends TestCase /** * Mocks up a SiteService that returns appropriate SiteInfo. * - * @return + * @return SiteService */ private SiteService mockSiteService() { @@ -374,7 +374,7 @@ public class InviteSenderTest extends TestCase * Mocks up a SearchService that will return the template NodeRef when * queried. * - * @return + * @return SearchService */ private SearchService mockSearchService() { @@ -393,7 +393,7 @@ public class InviteSenderTest extends TestCase * Mocks up a PersonService that returns the correct NodeRef when given a * user name. * - * @return + * @return PersonService */ private PersonService mockPersonService() { @@ -408,7 +408,7 @@ public class InviteSenderTest extends TestCase /** * Mocks up NodeService to return email adresses for inviter and invitee. * - * @return + * @return NodeService */ private NodeService mockNodeService() { diff --git a/source/test-java/org/alfresco/repo/jscript/ScriptNodeTest.java b/source/test-java/org/alfresco/repo/jscript/ScriptNodeTest.java index d4370b7ee5..c7ee3f9c81 100644 --- a/source/test-java/org/alfresco/repo/jscript/ScriptNodeTest.java +++ b/source/test-java/org/alfresco/repo/jscript/ScriptNodeTest.java @@ -198,7 +198,7 @@ public class ScriptNodeTest /** * Create test content, can be versionable. - * @param versionable + * @param versionable boolean */ private void createTestContent(boolean versionable) { diff --git a/source/test-java/org/alfresco/repo/model/filefolder/FileFolderPerformanceTester.java b/source/test-java/org/alfresco/repo/model/filefolder/FileFolderPerformanceTester.java index 5ac4d88a33..c9837cbed2 100644 --- a/source/test-java/org/alfresco/repo/model/filefolder/FileFolderPerformanceTester.java +++ b/source/test-java/org/alfresco/repo/model/filefolder/FileFolderPerformanceTester.java @@ -171,9 +171,13 @@ public class FileFolderPerformanceTester extends TestCase * Each creation (file or folder) uses the PROPAGATION REQUIRED transaction declaration. * * @param parentNodeRef the level zero parent + * @param threadCount * @param randomOrder true if each thread must put the children into the folders in a random order * @param realFile true if a real binary must be streamed into the node - * @return Returns the average time (ms) to create the files only + * @return Returns the average time (ms) to create the files only + * @param batchCount + * @param filesPerBatch + * @param dumpPoints */ private void buildStructure( final NodeRef parentNodeRef, diff --git a/source/test-java/org/alfresco/repo/module/tool/WarHelperImplTest.java b/source/test-java/org/alfresco/repo/module/tool/WarHelperImplTest.java index 9b6685f92c..fbf6ce28c1 100644 --- a/source/test-java/org/alfresco/repo/module/tool/WarHelperImplTest.java +++ b/source/test-java/org/alfresco/repo/module/tool/WarHelperImplTest.java @@ -353,7 +353,6 @@ public class WarHelperImplTest extends WarHelperImpl /** * Tests to see if the war is a share war. - * @throws Exception */ @Test public void testIsShareWar() diff --git a/source/test-java/org/alfresco/repo/node/db/DbNodeServiceImplPropagationTest.java b/source/test-java/org/alfresco/repo/node/db/DbNodeServiceImplPropagationTest.java index 99f1174bc8..dce70893a4 100644 --- a/source/test-java/org/alfresco/repo/node/db/DbNodeServiceImplPropagationTest.java +++ b/source/test-java/org/alfresco/repo/node/db/DbNodeServiceImplPropagationTest.java @@ -43,7 +43,7 @@ import org.alfresco.util.BaseSpringTest; import org.springframework.context.ApplicationContext; /** - * @see org.alfresco.repo.node.db.DbNodeServiceImpl#propagateTimeStamp + * @see org.alfresco.repo.node.db.DbNodeServiceImpl#propagateTimeStamps(ChildAssociationRef) * * @author sergey.shcherbovich */ diff --git a/source/test-java/org/alfresco/repo/policy/PolicyComponentTransactionTest.java b/source/test-java/org/alfresco/repo/policy/PolicyComponentTransactionTest.java index 7972532e0b..35afc12501 100644 --- a/source/test-java/org/alfresco/repo/policy/PolicyComponentTransactionTest.java +++ b/source/test-java/org/alfresco/repo/policy/PolicyComponentTransactionTest.java @@ -471,11 +471,11 @@ public class PolicyComponentTransactionTest extends TestCase /** * Construct * - * @param behaviour - * @param key1 - * @param key2 - * @param arg1 - * @param arg2 + * @param behaviour String + * @param key1 String + * @param key2 String + * @param arg1 String + * @param arg2 String */ public TestResult(String behaviour, String key1, String key2, String arg1, String arg2) { diff --git a/source/test-java/org/alfresco/repo/rendition/executer/AbstractRenderingEngineTest.java b/source/test-java/org/alfresco/repo/rendition/executer/AbstractRenderingEngineTest.java index fd0e2fa248..1830fcc2e2 100644 --- a/source/test-java/org/alfresco/repo/rendition/executer/AbstractRenderingEngineTest.java +++ b/source/test-java/org/alfresco/repo/rendition/executer/AbstractRenderingEngineTest.java @@ -249,8 +249,8 @@ public class AbstractRenderingEngineTest extends TestCase /** * Set up the rendition definition. - * @param renditionAssoc - * @return + * @param renditionAssoc ChildAssociationRef + * @return RenditionDefinition */ private RenditionDefinition makeRenditionDefinition(ChildAssociationRef renditionAssoc) { diff --git a/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneCategoryTest.java b/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneCategoryTest.java index f87ea2b58e..a996db28ab 100644 --- a/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneCategoryTest.java +++ b/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneCategoryTest.java @@ -134,7 +134,7 @@ public class ADMLuceneCategoryTest extends TestCase /** * Named test constructor - * @param arg0 + * @param arg0 String */ public ADMLuceneCategoryTest(String arg0) { diff --git a/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneTest.java b/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneTest.java index 88aa544b72..ef7771fd80 100644 --- a/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneTest.java +++ b/source/test-java/org/alfresco/repo/search/impl/lucene/ADMLuceneTest.java @@ -239,7 +239,7 @@ public class ADMLuceneTest extends TestCase implements DictionaryListener super(); } /** - * @param arg0 + * @param arg0 String */ public ADMLuceneTest(String arg0) { @@ -7878,7 +7878,7 @@ public class ADMLuceneTest extends TestCase implements DictionaryListener } /** - * @param args + * @param args String[] * @throws Exception */ public static void main(String[] args) throws Exception diff --git a/source/test-java/org/alfresco/repo/security/permissions/dynamic/LockOwnerDynamicAuthorityTest.java b/source/test-java/org/alfresco/repo/security/permissions/dynamic/LockOwnerDynamicAuthorityTest.java index 2f91fac6cb..8139c961cb 100644 --- a/source/test-java/org/alfresco/repo/security/permissions/dynamic/LockOwnerDynamicAuthorityTest.java +++ b/source/test-java/org/alfresco/repo/security/permissions/dynamic/LockOwnerDynamicAuthorityTest.java @@ -86,7 +86,7 @@ public class LockOwnerDynamicAuthorityTest extends TestCase } /** - * @param arg0 + * @param arg0 String */ public LockOwnerDynamicAuthorityTest(String arg0) { diff --git a/source/test-java/org/alfresco/repo/security/person/TestGroupManager.java b/source/test-java/org/alfresco/repo/security/person/TestGroupManager.java index fb34c11ddd..6b26ccccbf 100644 --- a/source/test-java/org/alfresco/repo/security/person/TestGroupManager.java +++ b/source/test-java/org/alfresco/repo/security/person/TestGroupManager.java @@ -50,7 +50,7 @@ public class TestGroupManager /** * Creates a group with the given name if one does not already exist. - * @param groupShortName + * @param groupShortName String * @return The group's full name. */ public String createGroupIfNotExist(String groupShortName) @@ -73,8 +73,8 @@ public class TestGroupManager * Adds the child group as a sub-authority of the parent group. Creates the * child group and parent group if they do not exist. * - * @param parentGroupShortName - * @param childGroupShortName + * @param parentGroupShortName String + * @param childGroupShortName String * @return The full name of the child group. */ public String addGroupToParent(String parentGroupShortName, String childGroupShortName) @@ -89,8 +89,8 @@ public class TestGroupManager * Adds the user as a sub-authroity of the specified group. * Creates the group if it doesn't exist. * - * @param groupShortName - * @param userName + * @param groupShortName String + * @param userName String */ public void addUserToGroup(String groupShortName, String userName) { diff --git a/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java b/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java index 5723d10ee6..81d848ac6c 100644 --- a/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java +++ b/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java @@ -878,16 +878,16 @@ public class ChainingUserRegistrySynchronizerTest extends TestCase assertEquals(email, this.nodeService.getProperty(personRef, ContentModel.PROP_EMAIL)); } - /** - * Asserts that a group's display name has the expected value. - * - * @param name - * the person name - * @param displayName - * the display name - */ - private void assertGroupDisplayNameEquals(String name, String displayName) - { + /** + * Asserts that a group's display name has the expected value. + * + * @param name + * the person name + * @param displayName + * the display name + */ + private void assertGroupDisplayNameEquals(String name, String displayName) + { assertEquals(displayName, this.authorityService.getAuthorityDisplayName(longName(name))); } @@ -1037,7 +1037,7 @@ public class ChainingUserRegistrySynchronizerTest extends TestCase /** * - * @param throwError + * @param throwError boolean */ public void setThrowError(boolean throwError) { @@ -1342,14 +1342,14 @@ public class ChainingUserRegistrySynchronizerTest extends TestCase /** * The Constructor. - * - * @param size - * the collection size - * @param persons - * the persons - */ - public RandomGroupCollection(int size, Collection persons) - { + * + * @param size + * the collection size + * @param persons + * the persons + */ + public RandomGroupCollection(int size, Collection persons) + { this.size = size; this.authorities = new ArrayList(persons.size()); for (NodeDescription nodeDescription : persons) diff --git a/source/test-java/org/alfresco/repo/site/SiteServiceImplTest.java b/source/test-java/org/alfresco/repo/site/SiteServiceImplTest.java index a8fd128b99..206b64a26c 100644 --- a/source/test-java/org/alfresco/repo/site/SiteServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/site/SiteServiceImplTest.java @@ -303,7 +303,7 @@ public class SiteServiceImplTest extends BaseAlfrescoSpringTest * This method tests https://issues.alfresco.com/jira/browse/ALF-3785 which allows 'public' sites * to be only visible to members of a configured group, by default EVERYONE. * - * @author Neil McErlean + *

    author Neil McErlean * @since 3.4 */ @SuppressWarnings("deprecation") diff --git a/source/test-java/org/alfresco/repo/tenant/MultiTServiceImplTest.java b/source/test-java/org/alfresco/repo/tenant/MultiTServiceImplTest.java index 7351d3d149..90002cab5c 100644 --- a/source/test-java/org/alfresco/repo/tenant/MultiTServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/tenant/MultiTServiceImplTest.java @@ -603,9 +603,9 @@ public class MultiTServiceImplTest /** * Runs {@link TenantService#getDomain(String)} as a specified tenant. * @param user The input parameter to the {@link TenantService#getDomain(String)} - * @param domain - * @param runAsUsername - * @param checkCurrentDomain + * @param domain String + * @param runAsUsername String + * @param checkCurrentDomain boolean * @return domain * @throws Exception */ @@ -625,8 +625,8 @@ public class MultiTServiceImplTest /** * Runs {@link TenantService#checkDomain(String)} as a specified tenant. * @param string The input parameter to the {@link TenantService#checkDomain(String)} - * @param domain - * @param runAsUsername + * @param domain String + * @param runAsUsername String * @throws Exception */ private void checkDomainWork(final String string, String domain, String runAsUsername) throws Exception @@ -646,8 +646,8 @@ public class MultiTServiceImplTest /** * Runs {@link TenantService#checkDomainUser(String)} as a specified tenant. * @param username The input parameter to the {@link TenantService#checkDomainUser(String)} - * @param domain - * @param runAsUsername + * @param domain String + * @param runAsUsername String * @throws Exception */ private void checkDomainUserWork(final String username, String domain, String runAsUsername) throws Exception @@ -667,7 +667,7 @@ public class MultiTServiceImplTest /** * Create a tenant domain, if not already created * - * @param tenantDomain + * @param tenantDomain String */ private void createTenant(final String tenantDomain) { @@ -688,10 +688,10 @@ public class MultiTServiceImplTest /** * Crate a user and authentication * - * @param baseUserName - * @param tenantDomain - * @param password - * @return the new user NideRef + * @param baseUserName String + * @param tenantDomain String + * @param password String + * @return the new user NodeRef */ private NodeRef createUser(String baseUserName, String tenantDomain, String password) { @@ -723,8 +723,8 @@ public class MultiTServiceImplTest /** * Utility method to add a domain to an string id - * @param id - * @param domain + * @param id String + * @param domain String * @return a string in format "@domain@id" */ private static String addDomainToId(String id, String domain) diff --git a/source/test-java/org/alfresco/repo/version/common/VersionHistoryImplTest.java b/source/test-java/org/alfresco/repo/version/common/VersionHistoryImplTest.java index 030239fe55..4100d13f6d 100644 --- a/source/test-java/org/alfresco/repo/version/common/VersionHistoryImplTest.java +++ b/source/test-java/org/alfresco/repo/version/common/VersionHistoryImplTest.java @@ -122,8 +122,6 @@ public class VersionHistoryImplTest extends TestCase /** * Test getRootVersion - * - *@return root version */ public void testGetRootVersion() { @@ -184,8 +182,6 @@ public class VersionHistoryImplTest extends TestCase /** * Test addVersion - * - * @return version history */ public void testAddVersion() { diff --git a/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java b/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java index c6d3fe7cce..e0d10346f2 100644 --- a/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java +++ b/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java @@ -87,7 +87,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Construct * - * @param writer + * @param writer PrintStream */ public BaseWebScriptTestListener(PrintStream writer) { @@ -137,8 +137,8 @@ public abstract class BaseWebScriptTest extends TestCase /** * Add an arbitrary log statement * - * @param test - * @param log + * @param test Test + * @param log String */ public void addLog(Test test, String log) { @@ -149,7 +149,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Sets custom context for Test Web Script Server (in-process only) - * @param customContext + * @param customContext String */ public void setCustomContext(String customContext) { @@ -169,7 +169,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Sets whether to trace request / response bodies * - * @param traceReqRes + * @param traceReqRes boolean */ public void setTraceReqRes(boolean traceReqRes) { @@ -189,7 +189,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Gets Remote Server * - * @return + * @return RemoteServer */ public RemoteServer getRemoteServer() { @@ -199,7 +199,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Set Default Local Run As User * - * @param localRunAs + * @param localRunAs String */ public void setDefaultRunAs(String localRunAs) { @@ -287,7 +287,7 @@ public abstract class BaseWebScriptTest extends TestCase /** * Log Message to Test Listener * - * @param log + * @param log String */ protected void log(String log) { @@ -300,8 +300,8 @@ public abstract class BaseWebScriptTest extends TestCase /** * Send Request to Test Web Script Server (as admin) * - * @param req - * @param expectedStatus + * @param req Request + * @param expectedStatus int * @return response * @throws IOException */ @@ -314,9 +314,9 @@ public abstract class BaseWebScriptTest extends TestCase /** * Send Request * - * @param req - * @param expectedStatus - * @param asUser + * @param req Request + * @param expectedStatus int + * @param asUser String * @return response * @throws IOException */ @@ -401,9 +401,9 @@ public abstract class BaseWebScriptTest extends TestCase /** * Send Local Request to Test Web Script Server * - * @param req - * @param expectedStatus - * @param asUser + * @param req Request + * @param expectedStatus int + * @param asUser String * @return response * @throws IOException */ @@ -445,8 +445,8 @@ public abstract class BaseWebScriptTest extends TestCase /** * Send Remote Request to stand-alone Web Script Server * - * @param req - * @param expectedStatus + * @param req Request + * @param expectedStatus int * @return response * @throws IOException */ diff --git a/source/test-java/org/alfresco/repo/web/scripts/TestWebScriptRepoServer.java b/source/test-java/org/alfresco/repo/web/scripts/TestWebScriptRepoServer.java index 652bb35c6d..66d7b5f8ae 100644 --- a/source/test-java/org/alfresco/repo/web/scripts/TestWebScriptRepoServer.java +++ b/source/test-java/org/alfresco/repo/web/scripts/TestWebScriptRepoServer.java @@ -41,7 +41,7 @@ import org.springframework.extensions.webscripts.TestWebScriptServer; */ public class TestWebScriptRepoServer extends TestWebScriptServer { - /** + /** * Main entry point. */ public static void main(String[] args) @@ -66,11 +66,11 @@ public class TestWebScriptRepoServer extends TestWebScriptServer } private final static String[] CONFIG_LOCATIONS = new String[] - { - "classpath:alfresco/application-context.xml", - "classpath:alfresco/web-scripts-application-context.xml", - "classpath:alfresco/web-scripts-application-context-test.xml" - }; + { + "classpath:alfresco/application-context.xml", + "classpath:alfresco/web-scripts-application-context.xml", + "classpath:alfresco/web-scripts-application-context-test.xml" + }; /** A static reference to the application context being used */ private static ClassPathXmlApplicationContext ctx; @@ -89,7 +89,7 @@ public class TestWebScriptRepoServer extends TestWebScriptServer } /** - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { @@ -208,7 +208,7 @@ public class TestWebScriptRepoServer extends TestWebScriptServer } catch(AuthenticationException e) { - executeCommand("user " + getDefaultUserName()); + executeCommand("user " + getDefaultUserName()); } // execute command in context of currently selected user diff --git a/source/test-java/org/alfresco/repo/workflow/activiti/AbstractActivitiComponentTest.java b/source/test-java/org/alfresco/repo/workflow/activiti/AbstractActivitiComponentTest.java index 35bf83af86..5cc5402ac9 100644 --- a/source/test-java/org/alfresco/repo/workflow/activiti/AbstractActivitiComponentTest.java +++ b/source/test-java/org/alfresco/repo/workflow/activiti/AbstractActivitiComponentTest.java @@ -289,9 +289,6 @@ public class AbstractActivitiComponentTest when(unprotectedSearchService.selectNodes(rootNode, "spaces.company_home.childname", null, namespaceService, false)).thenReturn(Arrays.asList(companyHomeNode)); } - /** - * @return - */ private void mockDictionaryService() { Mockito.reset(dictionaryService); diff --git a/source/test-java/org/alfresco/util/schemacomp/test/exportdb/AbstractExportTester.java b/source/test-java/org/alfresco/util/schemacomp/test/exportdb/AbstractExportTester.java index 6cb49a729d..31e5e9bc77 100644 --- a/source/test-java/org/alfresco/util/schemacomp/test/exportdb/AbstractExportTester.java +++ b/source/test-java/org/alfresco/util/schemacomp/test/exportdb/AbstractExportTester.java @@ -85,8 +85,8 @@ public abstract class AbstractExportTester * Check that all top level database objects are prefixed as expected * (no other objects should have been retrieved) * - * @param schema - * @param prefix + * @param schema Schema + * @param prefix String */ protected void checkResultsFiltered(Schema schema, String prefix) {