diff --git a/source/java/org/alfresco/email/server/AliasableAspect.java b/source/java/org/alfresco/email/server/AliasableAspect.java index ba9b058fd3..e727b0feb7 100644 --- a/source/java/org/alfresco/email/server/AliasableAspect.java +++ b/source/java/org/alfresco/email/server/AliasableAspect.java @@ -192,26 +192,26 @@ public class AliasableAspect implements NodeServicePolicies.OnAddAspectPolicy, } return null; - } - - /** - * @see org.alfresco.repo.node.NodeServicePolicies$OnAddAspectPolicy#onAddAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName) - * @exception AlfrescoRuntimeException Throws if the alias property is duplicated. - */ - public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName) + } + + /** + * @see org.alfresco.repo.node.NodeServicePolicies.OnAddAspectPolicy#onAddAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName) + * @exception AlfrescoRuntimeException Throws if the alias property is duplicated. + */ + public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName) { Object alias = nodeService.getProperty(nodeRef, EmailServerModel.PROP_ALIAS); if (alias != null) { addAlias(nodeRef, alias.toString()); } - } - - /** - * @see org.alfresco.repo.node.NodeServicePolicies$OnUpdatePropertiesPolicy#onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef, java.util.Map, java.util.Map) - * @exception AlfrescoRuntimeException Throws if the alias property is duplicated. - */ - public void onUpdateProperties(NodeRef nodeRef, Map before, Map after) + } + + /** + * @see org.alfresco.repo.node.NodeServicePolicies.OnUpdatePropertiesPolicy#onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef, java.util.Map, java.util.Map) + * @exception AlfrescoRuntimeException Throws if the alias property is duplicated. + */ + public void onUpdateProperties(NodeRef nodeRef, Map before, Map after) { String oldAlias = (String)before.get(EmailServerModel.PROP_ALIAS); String newAlias = (String)after.get(EmailServerModel.PROP_ALIAS); diff --git a/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java b/source/java/org/alfresco/email/server/AliasableAspectCopyBehaviourCallback.java index 855678929f..96c846433e 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 ASPECT_ALIASABLE aspect. + * Disallows copying of the {@link EmailServerModel#ASPECT_ALIASABLE aspect. */ @Override public boolean getMustCopy(QName classQName, CopyDetails copyDetails) @@ -48,7 +48,7 @@ public class AliasableAspectCopyBehaviourCallback extends DefaultCopyBehaviourCa } /** - * Prevents copying off the {@link ContentModel#PROP_NAME cm:name} property. + * Prevents copying off the {@link org.alfresco.model.ContentModel#PROP_NAME cm:name} property. */ @Override public Map getCopyProperties( diff --git a/source/java/org/alfresco/email/server/EmailServer.java b/source/java/org/alfresco/email/server/EmailServer.java index 009d8f7162..65d2d9cfcd 100644 --- a/source/java/org/alfresco/email/server/EmailServer.java +++ b/source/java/org/alfresco/email/server/EmailServer.java @@ -54,15 +54,12 @@ public abstract class EmailServer extends AbstractLifecycleBean private boolean requireTLS = false; private boolean authenticate = false; - private EmailService emailService; - private AuthenticationComponent authenticationComponent; - - /** - * @param serverConfiguration Server configuration - */ - protected EmailServer() - { - this.enabled = false; + private EmailService emailService; + private AuthenticationComponent authenticationComponent; + + protected EmailServer() + { + this.enabled = false; this.port = 25; this.domain = null; this.maxConnections = 3; diff --git a/source/java/org/alfresco/email/server/handler/AbstractEmailMessageHandler.java b/source/java/org/alfresco/email/server/handler/AbstractEmailMessageHandler.java index 089544baac..2e2d16d61d 100644 --- a/source/java/org/alfresco/email/server/handler/AbstractEmailMessageHandler.java +++ b/source/java/org/alfresco/email/server/handler/AbstractEmailMessageHandler.java @@ -223,15 +223,14 @@ public abstract class AbstractEmailMessageHandler implements EmailMessageHandler writer.putContent(bis); } - /** - * Add emailed aspect to the specified node. - * - * @param nodeService Alfresco Node Service. - * @param nodeRef Target node. - * @param mailParser Mail message that will be used for extracting necessary information - */ - protected void addEmailedAspect(NodeRef nodeRef, EmailMessage message) - { + /** + * Add emailed aspect to the specified node. + * + * @param nodeRef Target node. + * @param message Mail message that will be used for extracting necessary information + */ + protected void addEmailedAspect(NodeRef nodeRef, EmailMessage message) + { /* * TODO - get rid of this and use the RFC822 metadata extractor instead. diff --git a/source/java/org/alfresco/email/server/handler/AbstractForumEmailMessageHandler.java b/source/java/org/alfresco/email/server/handler/AbstractForumEmailMessageHandler.java index 244d7d925d..fa32a0b238 100644 --- a/source/java/org/alfresco/email/server/handler/AbstractForumEmailMessageHandler.java +++ b/source/java/org/alfresco/email/server/handler/AbstractForumEmailMessageHandler.java @@ -47,13 +47,13 @@ import org.alfresco.util.PropertyMap; public abstract class AbstractForumEmailMessageHandler extends AbstractEmailMessageHandler { /** - * Posts content - * - * @param nodeRef Reference to node - * @param parser Mail parser - * @return Returns the new post node - */ - protected NodeRef addPostNode(NodeRef nodeRef, EmailMessage message) + * Posts content + * + * @param nodeRef Reference to node + * @param message Mail parser + * @return Returns the new post node + */ + protected NodeRef addPostNode(NodeRef nodeRef, EmailMessage message) { NodeService nodeService = getNodeService(); Date now = new Date(); @@ -102,13 +102,13 @@ public abstract class AbstractForumEmailMessageHandler extends AbstractEmailMess } /** - * Finds first child with specified name - * - * @param nodeRef Parent node for the search - * @param subject String for search - * @return Reference to found node or null if node isn't found - */ - protected NodeRef getTopicNode(NodeRef nodeRef, String name) + * Finds first child with specified name + * + * @param nodeRef Parent node for the search + * @param name String for search + * @return Reference to found node or null if node isn't found + */ + protected NodeRef getTopicNode(NodeRef nodeRef, String name) { String workingName = encodeSubject(name); diff --git a/source/java/org/alfresco/email/server/handler/DocumentEmailMessageHandler.java b/source/java/org/alfresco/email/server/handler/DocumentEmailMessageHandler.java index 7767e0d045..7dfdb8e960 100644 --- a/source/java/org/alfresco/email/server/handler/DocumentEmailMessageHandler.java +++ b/source/java/org/alfresco/email/server/handler/DocumentEmailMessageHandler.java @@ -137,13 +137,12 @@ public class DocumentEmailMessageHandler extends AbstractForumEmailMessageHandle return forumNode; } - /** - * Finds the first forum node - * - * @param nodeService Alfresco Node Service - * @param nodeRef Parent node - * @return Found node or null - */ + /** + * Finds the first forum node + * + * @param nodeRef Parent node + * @return Found node or null + */ private NodeRef getForumNode(NodeRef nodeRef) { diff --git a/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java b/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java index d0c575241b..d5e7c3efe9 100644 --- a/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java +++ b/source/java/org/alfresco/email/server/handler/FolderEmailMessageHandler.java @@ -95,13 +95,13 @@ public class FolderEmailMessageHandler extends AbstractEmailMessageHandler } /** - * Add content to Alfresco repository - * - * @param spaceNodeRef Addressed node - * @param mailParser 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. + * @throws MessagingException Exception can be thrown while parsing e-mail message. + */ public void addAlfrescoContent(NodeRef spaceNodeRef, EmailMessage message) throws IOException { // Set default values for email fields diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoContext.java index 6b9556a3e4..c709d0ad07 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 dbg int - */ - public final void setDebug(String flagsStr) - { + /** + * Set the debug flags, also requires the logger to be enabled for debug output + * + * @param flagsStr + */ + public final void setDebug(String flagsStr) + { int filesysDbg = 0; if (flagsStr != null) diff --git a/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java b/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java index d1ab804eca..cb087f2bfc 100644 --- a/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java +++ b/source/java/org/alfresco/filesys/alfresco/AlfrescoDiskDriver.java @@ -153,7 +153,6 @@ public abstract class AlfrescoDiskDriver implements IOCtlInterface, ExtendedDisk * shares. In this base class, we initialize all desktop actions. * * @param ctx the context - * @param serverConfig ServerConfigurationBean * @exception DeviceContextException */ public void registerContext(DeviceContext ctx) throws DeviceContextException diff --git a/source/java/org/alfresco/filesys/alfresco/DesktopParams.java b/source/java/org/alfresco/filesys/alfresco/DesktopParams.java index 53fbad2f95..03f719a088 100644 --- a/source/java/org/alfresco/filesys/alfresco/DesktopParams.java +++ b/source/java/org/alfresco/filesys/alfresco/DesktopParams.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; @@ -61,7 +61,6 @@ public class DesktopParams { * Class constructor * * @param sess SrvSession - * @param driver AlfrescoDiskDriver * @param folderNode NodeRef * @param folderFile NetworkFile */ diff --git a/source/java/org/alfresco/filesys/alfresco/ExtendedDiskInterface.java b/source/java/org/alfresco/filesys/alfresco/ExtendedDiskInterface.java index b2560ca98e..d618af95eb 100644 --- a/source/java/org/alfresco/filesys/alfresco/ExtendedDiskInterface.java +++ b/source/java/org/alfresco/filesys/alfresco/ExtendedDiskInterface.java @@ -28,14 +28,13 @@ import org.alfresco.jlan.server.filesys.DiskInterface; public interface ExtendedDiskInterface extends DiskInterface { /** - * Register an independently created device context object for this instance of the shared device. Useful, e.g. when - * context singleton configuration managed by a container. - * - * @param context - * the device context - * @param serverConfig ServerConfigurationBean - * @exception DeviceContextException - */ - public void registerContext(DeviceContext ctx) throws DeviceContextException; + * Register an independently created device context object for this instance of the shared device. Useful, e.g. when + * context singleton configuration managed by a container. + * + * @param ctx + * the device context + * @exception DeviceContextException + */ + public void registerContext(DeviceContext ctx) throws DeviceContextException; } diff --git a/source/java/org/alfresco/filesys/alfresco/HomeShareMapper.java b/source/java/org/alfresco/filesys/alfresco/HomeShareMapper.java index b6bdb4d9ac..f91ac8653e 100644 --- a/source/java/org/alfresco/filesys/alfresco/HomeShareMapper.java +++ b/source/java/org/alfresco/filesys/alfresco/HomeShareMapper.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -189,7 +189,7 @@ public class HomeShareMapper implements ShareMapper /** * Find a share using the name and type for the specified client. * - * @param host String + * @param tohost String * @param name String * @param typ int * @param sess SrvSession @@ -344,7 +344,8 @@ public class HomeShareMapper implements ShareMapper /** * Create a disk share for the home folder * - * @param client AlfrescoClientInfo + * @param homeFolderRef nodeRef + * @param userName user name * @return DiskSharedDevice */ private final DiskSharedDevice createHomeDiskShare(NodeRef homeFolderRef, String userName) diff --git a/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlay.java b/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlay.java index 1808f31356..042f72627f 100644 --- a/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlay.java +++ b/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlay.java @@ -26,21 +26,24 @@ public interface PseudoFileOverlay { /** * Is this a pseudo file? - * @param path the path of the file + * @param parentDir NodeRef + * @param name String * @return true the file is a pseudo file */ public boolean isPseudoFile(NodeRef parentDir, String name); /** * Get the pseudo file - * @param path the path of the file + * @param parentDir NodeRef + * @param name String * @return the pseudoFile or null if there is no pseudo file */ public PseudoFile getPseudoFile(NodeRef parentDir, String name); /** * Search for the pseudo files on the specified path - * @param path the path + * @param parentDir NodeRef + * @param name String * @return list of pseudo files. */ public PseudoFileList searchPseudoFiles(NodeRef parentDir, String name); diff --git a/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlayImpl.java b/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlayImpl.java index 1b9e5e5409..80012e29b4 100644 --- a/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlayImpl.java +++ b/source/java/org/alfresco/filesys/alfresco/PseudoFileOverlayImpl.java @@ -262,8 +262,8 @@ public class PseudoFileOverlayImpl implements PseudoFileOverlay /** * Get the pseudo file - * @param path - * @param nodeRef + * @param parentDir NodeRef + * @param fname String * @return the pseudoFile or null if there is no pseudo file */ public PseudoFile getPseudoFile(NodeRef parentDir, String fname) diff --git a/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java b/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java index 2a71959024..9dc534a61c 100644 --- a/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java +++ b/source/java/org/alfresco/filesys/alfresco/RepositoryDiskInterface.java @@ -47,8 +47,7 @@ public interface RepositoryDiskInterface * CreateFile. * * @param rootNode - * @param fromPath - the source node - * @param toPath - the target node + * @param Path - path * @param allocationSize size to allocate for new file * @param isHidden * @throws FileNotFoundException @@ -60,9 +59,10 @@ public interface RepositoryDiskInterface * * Either restores the file or creates a new one. * + * @param sess + * @param tree * @param rootNode - * @param fromPath - the source node - * @param toPath - the target node + * @param path - path * @param allocationSize size to allocate for new file * @param originalNodeRef * @throws FileNotFoundException @@ -90,9 +90,10 @@ public interface RepositoryDiskInterface /** * CloseFile. * + * @param tree * @param rootNode - * @param fromPath - the source node - * @param toPath - the target node + * @param Path - path + * @param file - file * @throws FileNotFoundException * @return node ref of deleted file or null if no file deleted */ @@ -128,10 +129,11 @@ public interface RepositoryDiskInterface /** * Rename the specified file. * - * @param sess Server session - * @param tree Tree connection + * @param rootNode root node * @param oldName java.lang.String * @param newName java.lang.String + * @param soft + * @param moveAsSystem move as system * @exception java.io.IOException The exception description. */ public void renameFile(NodeRef rootNode, String oldName, String newName, boolean soft, boolean moveAsSystem) diff --git a/source/java/org/alfresco/filesys/auth/cifs/AlfrescoCifsAuthenticator.java b/source/java/org/alfresco/filesys/auth/cifs/AlfrescoCifsAuthenticator.java index 4b028dc020..f0051baec9 100644 --- a/source/java/org/alfresco/filesys/auth/cifs/AlfrescoCifsAuthenticator.java +++ b/source/java/org/alfresco/filesys/auth/cifs/AlfrescoCifsAuthenticator.java @@ -240,13 +240,13 @@ public class AlfrescoCifsAuthenticator extends CifsAuthenticatorBase /** * Authenticate a connection to a share. - * - * @param client User/client details from the tree connect request. - * @param share Shared device the client wants to connect to. - * @param pwd Share password. - * @param sess Server session. - * @return int Granted file permission level or disallow status if negative. See the - * FilePermission class. + * + * @param client User/client details from the tree connect request. + * @param share Shared device the client wants to connect to. + * @param sharePwd Share password. + * @param sess Server session. + * @return int Granted file permission level or disallow status if negative. See the + * FilePermission class. */ public int authenticateShareConnect(ClientInfo client, SharedDevice share, String sharePwd, SrvSession sess) { diff --git a/source/java/org/alfresco/filesys/auth/cifs/EnterpriseCifsAuthenticator.java b/source/java/org/alfresco/filesys/auth/cifs/EnterpriseCifsAuthenticator.java index 5f6050008b..bb2d5c6cd2 100644 --- a/source/java/org/alfresco/filesys/auth/cifs/EnterpriseCifsAuthenticator.java +++ b/source/java/org/alfresco/filesys/auth/cifs/EnterpriseCifsAuthenticator.java @@ -187,13 +187,13 @@ public class EnterpriseCifsAuthenticator extends CifsAuthenticatorBase implement m_krbRealm = realm; } - /** - * Sets the HTTP service login configuration entry name. - * - * @param loginEntryName - * the loginEntryName to set - */ - public void setJaasConfigEntryName(String jaasConfigEntryName) + /** + * Sets the HTTP service login configuration entry name. + * + * @param jaasConfigEntryName + * the loginEntryName to set + */ + public void setJaasConfigEntryName(String jaasConfigEntryName) { m_loginEntryName = jaasConfigEntryName; } diff --git a/source/java/org/alfresco/filesys/auth/ftp/FTPAuthenticatorBase.java b/source/java/org/alfresco/filesys/auth/ftp/FTPAuthenticatorBase.java index 1d1c88e464..236b30e02d 100644 --- a/source/java/org/alfresco/filesys/auth/ftp/FTPAuthenticatorBase.java +++ b/source/java/org/alfresco/filesys/auth/ftp/FTPAuthenticatorBase.java @@ -155,13 +155,13 @@ public abstract class FTPAuthenticatorBase implements FTPAuthenticator, Activate throw new InvalidConfigurationException("server configuration accessor property not set"); } - /** - * Authenticate the user - * - * @param client ClientInfo - * @param sess FTPSrvSession - * @return boolean - */ + /** + * Authenticate the user + * + * @param info ClientInfo + * @param sess FTPSrvSession + * @return boolean + */ public abstract boolean authenticateUser(ClientInfo info, FTPSrvSession sess); /** diff --git a/source/java/org/alfresco/filesys/repo/CifsHelper.java b/source/java/org/alfresco/filesys/repo/CifsHelper.java index fe6ce22b3b..3ccd593f43 100644 --- a/source/java/org/alfresco/filesys/repo/CifsHelper.java +++ b/source/java/org/alfresco/filesys/repo/CifsHelper.java @@ -165,13 +165,12 @@ public class CifsHelper public void setReadOnlyFlagOnFolders(boolean setReadOnlyFlagOnFolders) { this.isReadOnlyFlagOnFolders = setReadOnlyFlagOnFolders; - } - - /** - * @param serviceRegistry for repo connection - * @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) { @@ -482,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 isFile true if the node to be created must be a file - * @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 @@ -624,13 +623,13 @@ public class CifsHelper * Examples of the path are: *

    *
  • \New Folder\New Text Document.txt
  • - *
  • \New Folder\Sub Folder
  • - *
- * - * @param searchRootNodeRef 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 @@ -709,14 +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 oldNodeRef NodeRef - * @param newNodeRef NodeRef - */ - 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); diff --git a/source/java/org/alfresco/filesys/repo/ContentComparator.java b/source/java/org/alfresco/filesys/repo/ContentComparator.java index 26a6d86302..f3b9a01090 100644 --- a/source/java/org/alfresco/filesys/repo/ContentComparator.java +++ b/source/java/org/alfresco/filesys/repo/ContentComparator.java @@ -14,7 +14,7 @@ public interface ContentComparator * trivial changes need to be discarded. *

    * @param existingContent - * @param newFile + * @param file file * @return true content is equal, false content is different. */ boolean isContentEqual(ContentReader existingContent, File file); diff --git a/source/java/org/alfresco/filesys/repo/ContentContext.java b/source/java/org/alfresco/filesys/repo/ContentContext.java index a806a8adc4..95b106ec8a 100644 --- a/source/java/org/alfresco/filesys/repo/ContentContext.java +++ b/source/java/org/alfresco/filesys/repo/ContentContext.java @@ -376,13 +376,13 @@ public class ContentContext extends AlfrescoContext // return new ContentIOControlHandler(); // } - /** - * Set the node monitor - * - * @param filesysDriver ContentDiskDriver - */ - protected void setNodeMonitor( NodeMonitor nodeMonitor) { - m_nodeMonitor = nodeMonitor; + /** + * Set the node monitor + * + * @param nodeMonitor node monitor + */ + protected void setNodeMonitor( NodeMonitor nodeMonitor) { + m_nodeMonitor = nodeMonitor; } /** diff --git a/source/java/org/alfresco/filesys/repo/ContentDiskDriver.java b/source/java/org/alfresco/filesys/repo/ContentDiskDriver.java index 52fc5abad7..5d72763170 100644 --- a/source/java/org/alfresco/filesys/repo/ContentDiskDriver.java +++ b/source/java/org/alfresco/filesys/repo/ContentDiskDriver.java @@ -205,13 +205,13 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter private NodeMonitorFactory m_nodeMonitorFactory; - /** - * Class constructor - * - * @param serviceRegistry to connect to the repository services - */ - public ContentDiskDriver(CifsHelper cifsHelper) - { + /** + * Class constructor + * + * @param cifsHelper to connect to the repository services + */ + public ContentDiskDriver(CifsHelper cifsHelper) + { this.cifsHelper = cifsHelper; } @@ -313,14 +313,12 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter public final PermissionService getPermissionService() { return this.permissionService; } - - /** - * Return the node archive service - * - * @param NodeArchiveService - */ - public final NodeArchiveService getNodeArchiveService() { - return nodeArchiveService; + + /** + * Return the node archive service + */ + public final NodeArchiveService getNodeArchiveService() { + return nodeArchiveService; } /** @@ -466,13 +464,13 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter m_nodeMonitorFactory = nodeMonitorFactory; } - /** - * Set the node archive service - * - * @param NodeArchiveService nodeArchiveService - */ - public void setNodeArchiveService(NodeArchiveService nodeArchiveService) { - this.nodeArchiveService = nodeArchiveService; + /** + * Set the node archive service + * + * @param nodeArchiveService nodeArchiveService + */ + public void setNodeArchiveService(NodeArchiveService nodeArchiveService) { + this.nodeArchiveService = nodeArchiveService; } /** @@ -645,13 +643,12 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter * of the shared device. The same DeviceInterface implementation may be used for multiple * shares. * - * WARNING: side effect, will commit or roll back current user transaction context. - * - * @param ctx the context - * @param serverConfig ServerConfigurationBean - * @exception DeviceContextException - */ - // MER TODO - transaction handling in registerContext needs changing + * WARNING: side effect, will commit or roll back current user transaction context. + * + * @param ctx the context + * @exception DeviceContextException + */ + // MER TODO - transaction handling in registerContext needs changing @Override public void registerContext(DeviceContext ctx) throws DeviceContextException { @@ -860,15 +857,15 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter return isReadOnly; } - /** - * Get the file information for the specified file. - * - * @param sess Server session - * @param tree Tree connection - * @param name File name/path that information is required for. - * @return File information if valid, else null - * @exception java.io.IOException The exception description. - */ + /** + * Get the file information for the specified file. + * + * @param session Server session + * @param tree Tree connection + * @param path File name/path that information is required for. + * @return File information if valid, else null + * @exception java.io.IOException The exception description. + */ public FileInfo getFileInformation(SrvSession session, TreeConnection tree, String path) throws IOException { if(logger.isDebugEnabled()) @@ -1106,13 +1103,13 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter * Start a new search on the filesystem using the specified searchPath that may contain * wildcards. * - * @param sess Server session - * @param tree Tree connection - * @param searchPath File(s) to search for, may include wildcards. - * @param attrib Attributes of the file(s) to search for, see class SMBFileAttribute. - * @return SearchContext - * @exception java.io.FileNotFoundException If the search could not be started. - */ + * @param sess Server session + * @param tree Tree connection + * @param searchPath File(s) to search for, may include wildcards. + * @param attributes Attributes of the file(s) to search for, see class SMBFileAttribute. + * @return SearchContext + * @exception java.io.FileNotFoundException If the search could not be started. + */ public SearchContext startSearch(SrvSession sess, TreeConnection tree, String searchPath, int attributes) throws FileNotFoundException { // Access the device context @@ -2507,13 +2504,13 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter /** * Close the file. - * - * @param sess Server session - * @param tree Tree connection. - * @param param Network file context. - * @exception java.io.IOException If an error occurs. - */ - public void closeFile(SrvSession sess, TreeConnection tree, final NetworkFile file) throws IOException + * + * @param sess Server session + * @param tree Tree connection. + * @param file Network file context. + * @exception java.io.IOException If an error occurs. + */ + public void closeFile(SrvSession sess, TreeConnection tree, final NetworkFile file) throws IOException { if (logger.isDebugEnabled()) { @@ -2877,13 +2874,13 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter /** * Delete the specified file. - * - * @param sess Server session - * @param tree Tree connection - * @param file NetworkFile - * @exception java.io.IOException The exception description. - */ - public void deleteFile(final SrvSession sess, final TreeConnection tree, final String name) throws IOException + * + * @param sess Server session + * @param tree Tree connection + * @param name NetworkFile + * @exception java.io.IOException The exception description. + */ + public void deleteFile(final SrvSession sess, final TreeConnection tree, final String name) throws IOException { // Get the device context @@ -3820,16 +3817,16 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter /** * Read a block of data from the specified file. * - * @param sess Session details - * @param tree Tree connection - * @param file Network file - * @param buf Buffer to return data to - * @param bufPos Starting position in the return buffer - * @param siz Maximum size of data to return - * @param filePos File offset to read data - * @return Number of bytes read - * @exception java.io.IOException The exception description. - */ + * @param sess Session details + * @param tree Tree connection + * @param file Network file + * @param buffer Buffer to return data to + * @param bufferPosition Starting position in the return buffer + * @param size Maximum size of data to return + * @param fileOffset File offset to read data + * @return Number of bytes read + * @exception java.io.IOException The exception description. + */ public int readFile( SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buffer, int bufferPosition, int size, long fileOffset) throws IOException @@ -3903,16 +3900,16 @@ public class ContentDiskDriver extends AlfrescoTxDiskDriver implements DiskInter /** * Write a block of data to the file. * - * @param sess Server session - * @param tree Tree connection - * @param file Network file details - * @param buf byte[] Data to be written - * @param bufoff Offset within the buffer that the data starts - * @param siz int Data length - * @param fileoff Position within the file that the data is to be written. - * @return Number of bytes actually written - * @exception java.io.IOException The exception description. - */ + * @param sess Server session + * @param tree Tree connection + * @param file Network file details + * @param buffer byte[] Data to be written + * @param bufferOffset Offset within the buffer that the data starts + * @param size int Data length + * @param fileOffset Position within the file that the data is to be written. + * @return Number of bytes actually written + * @exception java.io.IOException The exception description. + */ public int writeFile(SrvSession sess, TreeConnection tree, NetworkFile file, byte[] buffer, int bufferOffset, int size, long fileOffset) throws IOException { diff --git a/source/java/org/alfresco/filesys/repo/ContentDiskDriver2.java b/source/java/org/alfresco/filesys/repo/ContentDiskDriver2.java index ac62881198..42b98a4e28 100644 --- a/source/java/org/alfresco/filesys/repo/ContentDiskDriver2.java +++ b/source/java/org/alfresco/filesys/repo/ContentDiskDriver2.java @@ -405,7 +405,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD } /** - * @param hiddenAspect + * @param lockKeeper lockKeeper */ public void setAlfrescoLockKeeper(LockKeeper lockKeeper) { @@ -629,9 +629,9 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Get the file information for the specified file. * - * @param sess Server session + * @param session Server session * @param tree Tree connection - * @param name File name/path that information is required for. + * @param path File name/path that information is required for. * @return File information if valid, else null * @exception java.io.IOException The exception description. */ @@ -760,10 +760,10 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD * Start a new search on the filesystem using the specified searchPath that may contain * wildcards. * - * @param sess Server session + * @param session Server session * @param tree Tree connection * @param searchPath File(s) to search for, may include wildcards. - * @param attrib Attributes of the file(s) to search for, see class SMBFileAttribute. + * @param attributes Attributes of the file(s) to search for, see class SMBFileAttribute. * @return SearchContext * @exception java.io.FileNotFoundException If the search could not be started. */ @@ -903,7 +903,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD * Check if the specified file exists, and whether it is a file or directory. * * - * @param sess Server session + * @param session Server session * @param tree Tree connection * @param name the path of the file * @return FileStatus (0: NotExist, 1 : FileExist, 2: DirectoryExists) @@ -984,7 +984,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Open a file or folder - obsolete implementation. * - * @param sess SrvSession + * @param session SrvSession * @param tree TreeConnection * @param params FileOpenParams * @return NetworkFile @@ -1099,7 +1099,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD *

    * The directory must be empty in order to be able to delete ity * - * @param sess Server session + * @param session Server session * @param tree Tree connection * @param dir Directory name. * @exception java.io.IOException The exception description. @@ -1186,7 +1186,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Flush any buffered output for the specified file. * - * @param sess Server session + * @param session Server session * @param tree Tree connection * @param file Network file context. * @exception java.io.IOException The exception description. @@ -1209,9 +1209,9 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Close the file. * - * @param sess Server session + * @param session Server session * @param tree Tree connection. - * @param param Network file context. + * @param file Network file context. * * @exception java.io.IOException If an error occurs. */ @@ -1228,9 +1228,10 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Delete the specified file. * - * @param sess Server session + * @param session Server session * @param tree Tree connection - * @param file NetworkFile + * @param rootNode Root node + * @param path NetworkFile * @exception java.io.IOException The exception description. * @return NodeRef of deletedFile */ @@ -1927,10 +1928,10 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD * @param sess Session details * @param tree Tree connection * @param file Network file - * @param buf Buffer to return data to - * @param bufPos Starting position in the return buffer - * @param siz Maximum size of data to return - * @param filePos File offset to read data + * @param buffer Buffer to return data to + * @param bufferPosition Starting position in the return buffer + * @param size Maximum size of data to return + * @param fileOffset File offset to read data * @return Number of bytes read * @exception java.io.IOException The exception description. */ @@ -2013,10 +2014,10 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD * @param sess Server session * @param tree Tree connection * @param file Network file details - * @param buf byte[] Data to be written - * @param bufoff Offset within the buffer that the data starts - * @param siz int Data length - * @param fileoff Position within the file that the data is to be written. + * @param buffer byte[] Data to be written + * @param bufferOffset Offset within the buffer that the data starts + * @param size int Data length + * @param fileOffset Position within the file that the data is to be written. * @return Number of bytes actually written * @exception java.io.IOException The exception description. */ @@ -2118,7 +2119,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Get the node for the specified path * - * @param tree TreeConnection + * @param rootNode rootNode * @param path String * @return NodeRef * @exception FileNotFoundException @@ -2155,7 +2156,7 @@ public class ContentDiskDriver2 extends AlfrescoDiskDriver implements ExtendedD /** * Convert a node into a share relative path * - * @param tree rootNode + * @param rootNode rootNode * @param nodeRef NodeRef * @return String * @exception FileNotFoundException diff --git a/source/java/org/alfresco/filesys/repo/ContentDiskInterface.java b/source/java/org/alfresco/filesys/repo/ContentDiskInterface.java index 1e7763a8f9..b4fa4ee646 100644 --- a/source/java/org/alfresco/filesys/repo/ContentDiskInterface.java +++ b/source/java/org/alfresco/filesys/repo/ContentDiskInterface.java @@ -19,13 +19,13 @@ package org.alfresco.filesys.repo; import org.alfresco.jlan.server.filesys.DiskInterface; -import org.alfresco.service.cmr.repository.NodeRef; - -/** - * Extended {@link org.alfresco.filesys.server.filesys.DiskInterface disk interface} to - * allow access to some of the internal configuration properties. - * - * @author Derek Hulley +import org.alfresco.service.cmr.repository.NodeRef; + +/** + * Extended {@link org.alfresco.jlan.server.filesys.DiskInterface disk interface} to + * allow access to some of the internal configuration properties. + * + * @author Derek Hulley */ public interface ContentDiskInterface extends DiskInterface { diff --git a/source/java/org/alfresco/filesys/repo/ContentNetworkFile.java b/source/java/org/alfresco/filesys/repo/ContentNetworkFile.java index cfe6ca4398..638c248fa1 100644 --- a/source/java/org/alfresco/filesys/repo/ContentNetworkFile.java +++ b/source/java/org/alfresco/filesys/repo/ContentNetworkFile.java @@ -182,15 +182,15 @@ public class ContentNetworkFile extends NodeRefNetworkFile return netFile; } - /** - * Class constructor - * - * @param transactionService TransactionService - * @param nodeService NodeService - * @param contentService ContentService - * @param nodeRef NodeRef - * @param name String - */ + /** + * Class constructor + * + * @param nodeService NodeService + * @param contentService ContentService + * @param mimetypeService mimetypeService + * @param nodeRef NodeRef + * @param name String + */ protected ContentNetworkFile( NodeService nodeService, ContentService contentService, @@ -603,16 +603,16 @@ public class ContentNetworkFile extends NodeRefNetworkFile logger.debug("Truncate file=" + this + ", size=" + size); } - /** - * Write a block of data to the file. - * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long - * @exception IOException - */ - public void writeFile(byte[] buffer, int length, int position, long fileOffset) + /** + * Write a block of data to the file. + * + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long + * @exception IOException + */ + public void writeFile(byte[] buffer, int length, int position, long fileOffset) throws IOException { try @@ -659,16 +659,16 @@ public class ContentNetworkFile extends NodeRefNetworkFile logger.debug("Write file=" + this + ", size=" + count); } - /** - * Read from the file. - * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long - * @return Length of data read. - * @exception IOException - */ + /** + * Read from the file. + * + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long + * @return Length of data read. + * @exception IOException + */ public int readFile(byte[] buffer, int length, int position, long fileOffset) throws IOException { diff --git a/source/java/org/alfresco/filesys/repo/ContentQuotaManager.java b/source/java/org/alfresco/filesys/repo/ContentQuotaManager.java index 30e0d6f51a..1cad7a9bc0 100644 --- a/source/java/org/alfresco/filesys/repo/ContentQuotaManager.java +++ b/source/java/org/alfresco/filesys/repo/ContentQuotaManager.java @@ -367,7 +367,7 @@ public class ContentQuotaManager implements QuotaManager, Runnable { /** * Load the user quota details * - * @param user - name of the user. + * @param userName - name of the user. * @return UserQuotaDetails * @throws QuotaManagerException */ diff --git a/source/java/org/alfresco/filesys/repo/ContentSearchContext.java b/source/java/org/alfresco/filesys/repo/ContentSearchContext.java index b9c4faf406..fe7ecab426 100644 --- a/source/java/org/alfresco/filesys/repo/ContentSearchContext.java +++ b/source/java/org/alfresco/filesys/repo/ContentSearchContext.java @@ -397,14 +397,14 @@ public class ContentSearchContext extends SearchContext return null; } - - /** - * Restart a search at the specified resume point. - * - * @param resumeId Resume point id. - * @return true if the search can be restarted, else false. - */ - public boolean restartAt(FileInfo info) + + /** + * Restart a search at the specified resume point. + * + * @param info File to restart the search at. + * @return true if the search can be restarted, else false. + */ + public boolean restartAt(FileInfo info) { // Check if the resume point is in the pseudo file list @@ -480,13 +480,13 @@ public class ContentSearchContext extends SearchContext return false; } - /** - * Restart the current search at the specified file. - * - * @param info File to restart the search at. - * @return true if the search can be restarted, else false. - */ - public boolean restartAt(int resumeId) + /** + * Restart the current search at the specified file. + * + * @param resumeId Resume point id. + * @return true if the search can be restarted, else false. + */ + public boolean restartAt(int resumeId) { // Resume ids are one based as zero has special meaning for some protocols, adjust the resume id diff --git a/source/java/org/alfresco/filesys/repo/DotDotContentSearchContext.java b/source/java/org/alfresco/filesys/repo/DotDotContentSearchContext.java index a42baec722..71b5e1931c 100644 --- a/source/java/org/alfresco/filesys/repo/DotDotContentSearchContext.java +++ b/source/java/org/alfresco/filesys/repo/DotDotContentSearchContext.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -55,7 +55,7 @@ public class DotDotContentSearchContext extends ContentSearchContext { * @param searchStr Search path * @param pseudoList List of pseudo files to be blended into the returned list of files * @param relPath Relative path being searched - * @param stateCache File state cache + * @param lockedFilesAsOffline set state */ protected DotDotContentSearchContext( CifsHelper cifsHelper, diff --git a/source/java/org/alfresco/filesys/repo/LinkMemoryNetworkFile.java b/source/java/org/alfresco/filesys/repo/LinkMemoryNetworkFile.java index 50456190ef..6373975675 100644 --- a/source/java/org/alfresco/filesys/repo/LinkMemoryNetworkFile.java +++ b/source/java/org/alfresco/filesys/repo/LinkMemoryNetworkFile.java @@ -45,13 +45,13 @@ public class LinkMemoryNetworkFile extends NodeRefNetworkFile private byte[] m_data; /** - * Class constructor. - * - * @param name String - * @param localPath String - * @param finfo FileInfo - * @param nodeRef NodeRef - */ + * Class constructor. + * + * @param name String + * @param data byte[] + * @param finfo FileInfo + * @param nodeRef NodeRef + */ public LinkMemoryNetworkFile(String name, byte[] data, FileInfo finfo, NodeRef nodeRef) { super( name, nodeRef); diff --git a/source/java/org/alfresco/filesys/repo/MSOfficeContentNetworkFile.java b/source/java/org/alfresco/filesys/repo/MSOfficeContentNetworkFile.java index 03f1aeda34..ce22e6f3b4 100644 --- a/source/java/org/alfresco/filesys/repo/MSOfficeContentNetworkFile.java +++ b/source/java/org/alfresco/filesys/repo/MSOfficeContentNetworkFile.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -53,9 +53,9 @@ public class MSOfficeContentNetworkFile extends ContentNetworkFile { /** * Class constructor * - * @param transactionService TransactionService * @param nodeService NodeService * @param contentService ContentService + * @param mimetypeService MimetypeService * @param nodeRef NodeRef * @param name String */ @@ -85,10 +85,10 @@ public class MSOfficeContentNetworkFile extends ContentNetworkFile { /** * Read from the file. * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long * @return Length of data read. * @exception IOException */ @@ -107,10 +107,10 @@ public class MSOfficeContentNetworkFile extends ContentNetworkFile { /** * Write a block of data to the file. * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long * @exception IOException */ public void writeFile(byte[] buffer, int length, int position, long fileOffset) diff --git a/source/java/org/alfresco/filesys/repo/MoveNodeEvent.java b/source/java/org/alfresco/filesys/repo/MoveNodeEvent.java index dd9234b739..a28e1334c4 100644 --- a/source/java/org/alfresco/filesys/repo/MoveNodeEvent.java +++ b/source/java/org/alfresco/filesys/repo/MoveNodeEvent.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -40,7 +40,7 @@ public class MoveNodeEvent extends NodeEvent { * @param fType FileFolderServiceTtype * @param nodeRef NodeRef * @param fromPath String - * @param toNodeRef NodeRef + * @param toPath String */ public MoveNodeEvent( FileFolderServiceType fType, NodeRef nodeRef, String fromPath, String toPath) { super( fType, nodeRef); diff --git a/source/java/org/alfresco/filesys/repo/NodeEventQueue.java b/source/java/org/alfresco/filesys/repo/NodeEventQueue.java index 863431c150..b71961e7c0 100644 --- a/source/java/org/alfresco/filesys/repo/NodeEventQueue.java +++ b/source/java/org/alfresco/filesys/repo/NodeEventQueue.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -51,7 +51,7 @@ public class NodeEventQueue { /** * Add an event to the queue * - * @param evetn NodeEvent + * @param event NodeEvent */ public final synchronized void addEvent(NodeEvent event) { diff --git a/source/java/org/alfresco/filesys/repo/NodeMonitor.java b/source/java/org/alfresco/filesys/repo/NodeMonitor.java index fe66e624e5..66fc166b1d 100644 --- a/source/java/org/alfresco/filesys/repo/NodeMonitor.java +++ b/source/java/org/alfresco/filesys/repo/NodeMonitor.java @@ -107,8 +107,12 @@ public class NodeMonitor extends TransactionListenerAdapter /** * Class constructor * - * @param filesysDriver ContentDiskDriver * @param filesysCtx ContentContext + * @param nodeService NodeService + * @param policyComponent PolicyComponent + * @param fileFolderService FileFolderService + * @param permissionService PermissionService + * @param transService TransactionService */ protected NodeMonitor(ContentContext filesysCtx, NodeService nodeService, PolicyComponent policyComponent, FileFolderService fileFolderService, PermissionService permissionService, TransactionService transService) { @@ -419,7 +423,6 @@ public class NodeMonitor extends TransactionListenerAdapter * node (parentNodeRef) - this will have the correct path * * @param parentNodeRef the old parent of the node - * @param childNodeRef the child node (renamed or moved node) * @param nodeName the old name of the childs * @return */ diff --git a/source/java/org/alfresco/filesys/repo/NodeMonitorFactory.java b/source/java/org/alfresco/filesys/repo/NodeMonitorFactory.java index d6effa3fee..d75aca2882 100644 --- a/source/java/org/alfresco/filesys/repo/NodeMonitorFactory.java +++ b/source/java/org/alfresco/filesys/repo/NodeMonitorFactory.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2006-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) 2006-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 . */ @@ -57,7 +57,6 @@ public class NodeMonitorFactory { /** * Create a node monitor * - * @param filesysDriver ContentDiskDriver * @param filesysCtx ContentContext */ public NodeMonitor createNodeMonitor(final ContentContext filesysCtx) diff --git a/source/java/org/alfresco/filesys/repo/OpenOfficeContentNetworkFile.java b/source/java/org/alfresco/filesys/repo/OpenOfficeContentNetworkFile.java index d1c84dfd4c..e848d24995 100644 --- a/source/java/org/alfresco/filesys/repo/OpenOfficeContentNetworkFile.java +++ b/source/java/org/alfresco/filesys/repo/OpenOfficeContentNetworkFile.java @@ -54,9 +54,9 @@ public class OpenOfficeContentNetworkFile extends ContentNetworkFile { /** * Class constructor * - * @param transactionService TransactionService * @param nodeService NodeService * @param contentService ContentService + * @param mimetypeService MimetypeService * @param nodeRef NodeRef * @param name String */ @@ -112,10 +112,10 @@ public class OpenOfficeContentNetworkFile extends ContentNetworkFile { /** * Read from the file. * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long * @return Length of data read. * @exception IOException */ @@ -134,10 +134,10 @@ public class OpenOfficeContentNetworkFile extends ContentNetworkFile { /** * Write a block of data to the file. * - * @param buf byte[] - * @param len int - * @param pos int - * @param fileOff long + * @param buffer byte[] + * @param length int + * @param position int + * @param fileOffset long * @exception IOException */ public void writeFile(byte[] buffer, int length, int position, long fileOffset) diff --git a/source/java/org/alfresco/filesys/repo/desk/JavaScriptDesktopAction.java b/source/java/org/alfresco/filesys/repo/desk/JavaScriptDesktopAction.java index d104806a37..6258e05d40 100644 --- a/source/java/org/alfresco/filesys/repo/desk/JavaScriptDesktopAction.java +++ b/source/java/org/alfresco/filesys/repo/desk/JavaScriptDesktopAction.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.desk; @@ -439,7 +439,7 @@ public class JavaScriptDesktopAction extends DesktopAction { /** * Load, or reload, the script * - * @param scriptFile File + * @param scriptResource script resource */ private final void loadScript(Resource scriptResource) throws IOException diff --git a/source/java/org/alfresco/filesys/repo/rules/Scenario.java b/source/java/org/alfresco/filesys/repo/rules/Scenario.java index 2fc43aba70..b317b04393 100644 --- a/source/java/org/alfresco/filesys/repo/rules/Scenario.java +++ b/source/java/org/alfresco/filesys/repo/rules/Scenario.java @@ -31,7 +31,7 @@ public interface Scenario *

    * If the scenario is interested in the specified operation then * return a new scenario instance. - * @param currentInstances the current instances of all scenarios. + * @param ctx EvaluatorContext. * @param operation the operation to be performed * @return the scenario instance or null if a new instance is not required. */ diff --git a/source/java/org/alfresco/filesys/repo/rules/commands/OpenFileCommand.java b/source/java/org/alfresco/filesys/repo/rules/commands/OpenFileCommand.java index ae323666d3..30497570ae 100644 --- a/source/java/org/alfresco/filesys/repo/rules/commands/OpenFileCommand.java +++ b/source/java/org/alfresco/filesys/repo/rules/commands/OpenFileCommand.java @@ -39,9 +39,9 @@ public class OpenFileCommand implements Command /** * * @param name - * @param writeAccess - * @param rootNode + * @param mode * @param truncate + * @param rootNode * @param path */ public OpenFileCommand(String name, OpenFileMode mode, boolean truncate, NodeRef rootNode, String path) diff --git a/source/java/org/alfresco/filesys/repo/rules/operations/OpenFileOperation.java b/source/java/org/alfresco/filesys/repo/rules/operations/OpenFileOperation.java index c61d85241f..6bfe3735c6 100644 --- a/source/java/org/alfresco/filesys/repo/rules/operations/OpenFileOperation.java +++ b/source/java/org/alfresco/filesys/repo/rules/operations/OpenFileOperation.java @@ -38,8 +38,9 @@ public class OpenFileOperation implements Operation /** * * @param name the name of the file to open - * @param writeAccess if true open the file in read/write - * @param rootNode + * @param mode if true open the file in read/write + * @param truncate boolean + * @param rootNode root node * @param path the full path/name to open */ public OpenFileOperation(String name, OpenFileMode mode, boolean truncate, NodeRef rootNode, String path) diff --git a/source/java/org/alfresco/opencmis/CMISChangeLogDataExtractor.java b/source/java/org/alfresco/opencmis/CMISChangeLogDataExtractor.java index 7b20fb7bc4..db442f92b1 100644 --- a/source/java/org/alfresco/opencmis/CMISChangeLogDataExtractor.java +++ b/source/java/org/alfresco/opencmis/CMISChangeLogDataExtractor.java @@ -49,8 +49,7 @@ public class CMISChangeLogDataExtractor extends AbstractDataExtractor /** * Extracts relevant node refs and Ids from auditing data * - * @see org.alfresco.repo.audit.extractor.DataExtractor.extractData(java.io. - * Serializable) + * @see org.alfresco.repo.audit.extractor.DataExtractor#extractData(java.io.Serializable) */ public Serializable extractData(Serializable value) throws Throwable { @@ -65,8 +64,7 @@ public class CMISChangeLogDataExtractor extends AbstractDataExtractor /** * @return Returns true if items in the CMIS domain model - * @see org.alfresco.repo.audit.extractor.DataExtractor.isSupported(java.io. - * Serializable) + * @see org.alfresco.repo.audit.extractor.DataExtractor#isSupported(java.io.Serializable) */ public boolean isSupported(Serializable data) { diff --git a/source/java/org/alfresco/opencmis/CMISConnector.java b/source/java/org/alfresco/opencmis/CMISConnector.java index 5814fd92e4..fe4cf770ae 100644 --- a/source/java/org/alfresco/opencmis/CMISConnector.java +++ b/source/java/org/alfresco/opencmis/CMISConnector.java @@ -1765,12 +1765,12 @@ public class CMISConnector implements ApplicationContextAware, ApplicationListen /** * Notifies listeners that a read has taken place. * - * @param streamNodeRef - * @param type + * @param nodeRef + * @param name * @param mimeType * @param contentSize * @param encoding - * @param string + * @param range */ protected void publishReadEvent(final NodeRef nodeRef, final String name, final String mimeType, final long contentSize, final String encoding, final String range) { diff --git a/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java b/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java index d711aa9d8e..d00716e31b 100644 --- a/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java +++ b/source/java/org/alfresco/opencmis/mapping/ParentActionEvaluator.java @@ -34,8 +34,7 @@ public class ParentActionEvaluator extends AbstractActionEvaluator /** * Construct * - * @param serviceRegistry - * @param action + * @param evaluator */ protected ParentActionEvaluator(AbstractActionEvaluator evaluator) { diff --git a/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java b/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java index 67389a97b0..040d85e275 100644 --- a/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java +++ b/source/java/org/alfresco/opencmis/mapping/RuntimePropertyAccessorMapping.java @@ -59,41 +59,37 @@ public class RuntimePropertyAccessorMapping implements PropertyAccessorMapping, private CMISDictionaryService cmisDictionaryService; private Map propertyAccessors = new HashMap(); - private Map> actionEvaluators = new HashMap>(); - - /** - * @param service - * registry - */ - public void setServiceRegistry(ServiceRegistry serviceRegistry) - { + private Map> actionEvaluators = new HashMap>(); + + /** + * @param serviceRegistry + */ + public void setServiceRegistry(ServiceRegistry serviceRegistry) + { this.serviceRegistry = serviceRegistry; - } - - /** - * @param cmis - * connector - */ - public void setCmisConnector(CMISConnector cmisConnector) - { + } + + /** + * @param cmisConnector + */ + public void setCmisConnector(CMISConnector cmisConnector) + { this.cmisConnector = cmisConnector; - } - - /** - * @param cmis - * mapping - */ - public void setCmisMapping(CMISMapping cmisMapping) - { + } + + /** + * @param cmisMapping + */ + public void setCmisMapping(CMISMapping cmisMapping) + { this.cmisMapping = cmisMapping; - } - - /** - * @param cmis - * mapping - */ - public void setCmisDictionaryService(CMISDictionaryService cmisDictionaryService) - { + } + + /** + * @param cmisDictionaryService + */ + public void setCmisDictionaryService(CMISDictionaryService cmisDictionaryService) + { this.cmisDictionaryService = cmisDictionaryService; } diff --git a/source/java/org/alfresco/repo/action/ActionImpl.java b/source/java/org/alfresco/repo/action/ActionImpl.java index 22d0343fc1..d52f1fe6f7 100644 --- a/source/java/org/alfresco/repo/action/ActionImpl.java +++ b/source/java/org/alfresco/repo/action/ActionImpl.java @@ -419,39 +419,39 @@ public class ActionImpl extends ParameterizedItemImpl implements Action public Date getExecutionStartDate() { return executionStartDate; } - - /** - * Records the date when the action began execution, - * normally called by the {@link ActionService} when - * it starts running the action. - */ - public void setExecutionStartDate(Date startDate) { + + /** + * Records the date when the action began execution, + * normally called by the {@link org.alfresco.service.cmr.action.ActionService} when + * it starts running the action. + */ + public void setExecutionStartDate(Date startDate) { this.executionStartDate = startDate; } public Date getExecutionEndDate() { return executionEndDate; } - - /** - * Records the date when the action finished execution, - * normally called by the {@link ActionService} when - * the action completes or fails. - */ - public void setExecutionEndDate(Date endDate) { + + /** + * Records the date when the action finished execution, + * normally called by the {@link org.alfresco.service.cmr.action.ActionService} when + * the action completes or fails. + */ + public void setExecutionEndDate(Date endDate) { this.executionEndDate = endDate; } public ActionStatus getExecutionStatus() { return executionStatus; } - - /** - * Updates the current execution status. This is - * normally called by the {@link ActionService} as - * it progresses the Action's execution. - */ - public void setExecutionStatus(ActionStatus status) { + + /** + * Updates the current execution status. This is + * normally called by the {@link org.alfresco.service.cmr.action.ActionService} as + * it progresses the Action's execution. + */ + public void setExecutionStatus(ActionStatus status) { this.executionStatus = status; } diff --git a/source/java/org/alfresco/repo/action/ActionServiceImpl.java b/source/java/org/alfresco/repo/action/ActionServiceImpl.java index eaf3276df7..7350c45774 100644 --- a/source/java/org/alfresco/repo/action/ActionServiceImpl.java +++ b/source/java/org/alfresco/repo/action/ActionServiceImpl.java @@ -213,13 +213,13 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A this.monitor = monitor; } - /** - * Set the asynchronous action execution queues - * - * @param asynchronousActionExecutionQueue 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( @@ -397,13 +397,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() - */ - 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); } @@ -1659,15 +1659,12 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A actionTrackingService.recordActionPending(action, actionedUponNodeRef); } } - } - } - - /** - * @see org.alfresco.repo.action.RuntimeActionService#getPostTransactionPendingActions() - */ - @SuppressWarnings("unchecked") - private List getPostTransactionPendingActions() - { + } + } + + @SuppressWarnings("unchecked") + private List getPostTransactionPendingActions() + { return (List) AlfrescoTransactionSupport.getResource(POST_TRANSACTION_PENDING_ACTIONS); } @@ -1777,13 +1774,13 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A return false; } } - } - - /** - * @return Returns {@link AdctionParameterTypeCopyBehaviourCallback} - */ - 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/ParameterizedItemAbstractBase.java b/source/java/org/alfresco/repo/action/ParameterizedItemAbstractBase.java index 4142f9299f..9bc29e13e4 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 actionRegistration 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; } diff --git a/source/java/org/alfresco/repo/action/ParameterizedItemImpl.java b/source/java/org/alfresco/repo/action/ParameterizedItemImpl.java index fc278940d8..3ce8d02607 100644 --- a/source/java/org/alfresco/repo/action/ParameterizedItemImpl.java +++ b/source/java/org/alfresco/repo/action/ParameterizedItemImpl.java @@ -42,23 +42,23 @@ public abstract class ParameterizedItemImpl implements ParameterizedItem, Serial */ private Map parameterValues = new HashMap(); - /** - * Constructor - * - * @param ruleItem the rule item - */ - public ParameterizedItemImpl(String id) - { + /** + * Constructor + * + * @param id the id + */ + public ParameterizedItemImpl(String id) + { this(id, null); } - /** - * Constructor - * - * @param ruleItem the rule item - * @param parameterValues the parameter values - */ - public ParameterizedItemImpl(String id, Map parameterValues) + /** + * Constructor + * + * @param id the rule item + * @param parameterValues the parameter values + */ + public ParameterizedItemImpl(String id, Map parameterValues) { // Set the action id this.id = id; diff --git a/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java b/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java index 14f42a58c7..c6cafcfb9f 100644 --- a/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java +++ b/source/java/org/alfresco/repo/action/constraint/BaseParameterConstraint.java @@ -135,21 +135,21 @@ public abstract class BaseParameterConstraint implements ParameterConstraint, result = i18n; } return result; - } - - /** - * @see org.alfresco.service.cmr.action.ParameterConstraint#getValueDisplayLabel(java.io.Serializable) - */ - 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(java.io.Serializable) - */ - 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/evaluator/ActionConditionEvaluatorAbstractBase.java b/source/java/org/alfresco/repo/action/evaluator/ActionConditionEvaluatorAbstractBase.java index cd3852aa6f..0773d6f89e 100644 --- a/source/java/org/alfresco/repo/action/evaluator/ActionConditionEvaluatorAbstractBase.java +++ b/source/java/org/alfresco/repo/action/evaluator/ActionConditionEvaluatorAbstractBase.java @@ -80,13 +80,13 @@ public abstract class ActionConditionEvaluatorAbstractBase extends Parameterized ((ActionConditionDefinitionImpl)this.actionConditionDefinition).setParameterDefinitions(getParameterDefintions()); } return this.actionConditionDefinition; - } - - /** - * @see org.alfresco.repo.action.evaluator.ActionConditionEvaluator#evaluate(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) - */ - public boolean evaluate(ActionCondition actionCondition, NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.evaluator.ActionConditionEvaluator#evaluate(org.alfresco.service.cmr.action.ActionCondition, org.alfresco.service.cmr.repository.NodeRef) + */ + public boolean evaluate(ActionCondition actionCondition, NodeRef actionedUponNodeRef) + { checkMandatoryProperties(actionCondition, getActionConditionDefintion()); boolean result = evaluateImpl(actionCondition, actionedUponNodeRef); if (actionCondition.getInvertCondition() == true) diff --git a/source/java/org/alfresco/repo/action/evaluator/InCategoryEvaluator.java b/source/java/org/alfresco/repo/action/evaluator/InCategoryEvaluator.java index a7a3ecdc44..361a0d6d81 100644 --- a/source/java/org/alfresco/repo/action/evaluator/InCategoryEvaluator.java +++ b/source/java/org/alfresco/repo/action/evaluator/InCategoryEvaluator.java @@ -87,16 +87,16 @@ public class InCategoryEvaluator extends ActionConditionEvaluatorAbstractBase { paramList.add(new ParameterDefinitionImpl(PARAM_CATEGORY_ASPECT, DataTypeDefinition.QNAME, true, getParamDisplayLabel(PARAM_CATEGORY_ASPECT))); paramList.add(new ParameterDefinitionImpl(PARAM_CATEGORY_VALUE, DataTypeDefinition.NODE_REF, true, getParamDisplayLabel(PARAM_CATEGORY_VALUE))); - } - - /** - * @see org.alfresco.repo.action.evaluator.ActionConditionEvaluatorAbstractBase#evaluateImpl(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) - */ - @Override - protected boolean evaluateImpl( - ActionCondition ruleCondition, - NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.evaluator.ActionConditionEvaluatorAbstractBase#evaluateImpl(ActionCondition, org.alfresco.service.cmr.repository.NodeRef) + */ + @Override + protected boolean evaluateImpl( + ActionCondition ruleCondition, + NodeRef actionedUponNodeRef) + { boolean result = false; // Double check that the node still exists diff --git a/source/java/org/alfresco/repo/action/executer/ActionExecuterAbstractBase.java b/source/java/org/alfresco/repo/action/executer/ActionExecuterAbstractBase.java index dc63ed905e..5a0beedc9d 100644 --- a/source/java/org/alfresco/repo/action/executer/ActionExecuterAbstractBase.java +++ b/source/java/org/alfresco/repo/action/executer/ActionExecuterAbstractBase.java @@ -283,13 +283,13 @@ public abstract class ActionExecuterAbstractBase extends ParameterizedItemAbstra */ protected abstract void executeImpl(Action action, NodeRef actionedUponNodeRef); - /** - * Set the queueName which will execute this action - * if blank or null then the action will be executed on the "default" queue - * @param the name of the execution queue which should execute this action. - */ - public void setQueueName(String queueName) - { + /** + * Set the queueName which will execute this action + * if blank or null then the action will be executed on the "default" queue + * @param queueName name of the execution queue which should execute this action. + */ + public void setQueueName(String queueName) + { this.queueName = queueName; } diff --git a/source/java/org/alfresco/repo/action/executer/AddFeaturesActionExecuter.java b/source/java/org/alfresco/repo/action/executer/AddFeaturesActionExecuter.java index 352332bbae..49856965a8 100644 --- a/source/java/org/alfresco/repo/action/executer/AddFeaturesActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/AddFeaturesActionExecuter.java @@ -81,13 +81,13 @@ public class AddFeaturesActionExecuter extends ActionExecuterAbstractBase protected boolean getAdhocPropertiesAllowed() { return true; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) - */ - public void executeImpl(final Action ruleAction, final NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.action.Action, NodeRef) + */ + public void executeImpl(final Action ruleAction, final NodeRef actionedUponNodeRef) + { if (this.nodeService.exists(actionedUponNodeRef)) { transactionService.getRetryingTransactionHelper().doInTransaction( diff --git a/source/java/org/alfresco/repo/action/executer/CheckInActionExecuter.java b/source/java/org/alfresco/repo/action/executer/CheckInActionExecuter.java index 95de23dcc4..ed56ce867c 100644 --- a/source/java/org/alfresco/repo/action/executer/CheckInActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/CheckInActionExecuter.java @@ -74,13 +74,13 @@ public class CheckInActionExecuter extends ActionExecuterAbstractBase public void setCociService(CheckOutCheckInService cociService) { this.cociService = cociService; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.NodeRef) - */ - public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, org.alfresco.service.cmr.repository.NodeRef) + */ + public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) + { // First ensure that the actionedUponNodeRef is a workingCopy if (this.nodeService.exists(actionedUponNodeRef) == true && this.nodeService.hasAspect(actionedUponNodeRef, ContentModel.ASPECT_WORKING_COPY) == true) diff --git a/source/java/org/alfresco/repo/action/executer/CheckOutActionExecuter.java b/source/java/org/alfresco/repo/action/executer/CheckOutActionExecuter.java index a19c1df89b..e6a8a5fc94 100644 --- a/source/java/org/alfresco/repo/action/executer/CheckOutActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/CheckOutActionExecuter.java @@ -81,13 +81,13 @@ public class CheckOutActionExecuter extends ActionExecuterAbstractBase paramList.add(new ParameterDefinitionImpl(PARAM_DESTINATION_FOLDER, DataTypeDefinition.NODE_REF, false, getParamDisplayLabel(PARAM_DESTINATION_FOLDER))); paramList.add(new ParameterDefinitionImpl(PARAM_ASSOC_TYPE_QNAME, DataTypeDefinition.QNAME, false, getParamDisplayLabel(PARAM_ASSOC_TYPE_QNAME))); paramList.add(new ParameterDefinitionImpl(PARAM_ASSOC_QNAME, DataTypeDefinition.QNAME, false, getParamDisplayLabel(PARAM_ASSOC_QNAME))); - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.NodeRef) - */ - public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, org.alfresco.service.cmr.repository.NodeRef) + */ + public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) + { if (this.nodeService.exists(actionedUponNodeRef) == true && this.nodeService.hasAspect(actionedUponNodeRef, ContentModel.ASPECT_WORKING_COPY) == false && isApplicableType(actionedUponNodeRef) == true) diff --git a/source/java/org/alfresco/repo/action/executer/CompositeActionExecuter.java b/source/java/org/alfresco/repo/action/executer/CompositeActionExecuter.java index 47843851ce..3d695337aa 100644 --- a/source/java/org/alfresco/repo/action/executer/CompositeActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/CompositeActionExecuter.java @@ -54,7 +54,7 @@ public class CompositeActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action action, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/ContentMetadataEmbedder.java b/source/java/org/alfresco/repo/action/executer/ContentMetadataEmbedder.java index 33a99241c9..8c4b36dd31 100644 --- a/source/java/org/alfresco/repo/action/executer/ContentMetadataEmbedder.java +++ b/source/java/org/alfresco/repo/action/executer/ContentMetadataEmbedder.java @@ -80,8 +80,7 @@ public class ContentMetadataEmbedder extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, - * NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java b/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java index c242d17fba..47049d2b9b 100644 --- a/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java +++ b/source/java/org/alfresco/repo/action/executer/ContentMetadataExtracter.java @@ -224,7 +224,7 @@ public class ContentMetadataExtracter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, * NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) diff --git a/source/java/org/alfresco/repo/action/executer/CountChildrenActionExecuter.java b/source/java/org/alfresco/repo/action/executer/CountChildrenActionExecuter.java index ea53dcacdb..334d4f60d2 100644 --- a/source/java/org/alfresco/repo/action/executer/CountChildrenActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/CountChildrenActionExecuter.java @@ -51,13 +51,13 @@ public class CountChildrenActionExecuter extends ActionExecuterAbstractBase public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, 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) + { if (this.nodeService.exists(actionedUponNodeRef) == true) { // Get the parent node diff --git a/source/java/org/alfresco/repo/action/executer/CreateVersionActionExecuter.java b/source/java/org/alfresco/repo/action/executer/CreateVersionActionExecuter.java index b1af730ef7..f6c7bfba07 100644 --- a/source/java/org/alfresco/repo/action/executer/CreateVersionActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/CreateVersionActionExecuter.java @@ -76,7 +76,7 @@ public class CreateVersionActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/ExecuteAllRulesActionExecuter.java b/source/java/org/alfresco/repo/action/executer/ExecuteAllRulesActionExecuter.java index b49c30aee4..a6f8e805bf 100644 --- a/source/java/org/alfresco/repo/action/executer/ExecuteAllRulesActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/ExecuteAllRulesActionExecuter.java @@ -107,7 +107,7 @@ public class ExecuteAllRulesActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java b/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java index 516cd5c188..cac91371a4 100644 --- a/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/ExporterActionExecuter.java @@ -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(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.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/ImporterActionExecuter.java b/source/java/org/alfresco/repo/action/executer/ImporterActionExecuter.java index a30a5d3e4b..5d46ff5fbf 100644 --- a/source/java/org/alfresco/repo/action/executer/ImporterActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/ImporterActionExecuter.java @@ -151,13 +151,13 @@ public class ImporterActionExecuter extends ActionExecuterAbstractBase public void setHighByteZip(boolean highByteZip) { this.highByteZip = highByteZip; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.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) + { if (this.nodeService.exists(actionedUponNodeRef) == true) { // The node being passed in should be an Alfresco content package diff --git a/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java b/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java index 882d2cfe3d..6b16e088ee 100644 --- a/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/MailActionExecuter.java @@ -468,7 +468,7 @@ public class MailActionExecuter extends ActionExecuterAbstractBase /** * Send an email message * - * @throws AlfrescoRuntimeExeption + * @throws org.alfresco.error.AlfrescoRuntimeException */ @Override protected void executeImpl( diff --git a/source/java/org/alfresco/repo/action/executer/MoveActionExecuter.java b/source/java/org/alfresco/repo/action/executer/MoveActionExecuter.java index 9884177d10..113cd38a3f 100644 --- a/source/java/org/alfresco/repo/action/executer/MoveActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/MoveActionExecuter.java @@ -71,13 +71,13 @@ public class MoveActionExecuter extends ActionExecuterAbstractBase protected void addParameterDefinitions(List paramList) { paramList.add(new ParameterDefinitionImpl(PARAM_DESTINATION_FOLDER, DataTypeDefinition.NODE_REF, true, getParamDisplayLabel(PARAM_DESTINATION_FOLDER))); - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.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) + { // ALF-17635: A move action should not fire on a working copy - wait until check in if (this.nodeService.exists(actionedUponNodeRef) && !this.nodeService.hasAspect(actionedUponNodeRef, ContentModel.ASPECT_WORKING_COPY)) diff --git a/source/java/org/alfresco/repo/action/executer/RemoveFeaturesActionExecuter.java b/source/java/org/alfresco/repo/action/executer/RemoveFeaturesActionExecuter.java index abf499b21b..e07929644c 100644 --- a/source/java/org/alfresco/repo/action/executer/RemoveFeaturesActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/RemoveFeaturesActionExecuter.java @@ -57,7 +57,7 @@ public class RemoveFeaturesActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/RepositoryExporterActionExecuter.java b/source/java/org/alfresco/repo/action/executer/RepositoryExporterActionExecuter.java index 6436efe438..759b380a03 100644 --- a/source/java/org/alfresco/repo/action/executer/RepositoryExporterActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/RepositoryExporterActionExecuter.java @@ -54,7 +54,7 @@ public class RepositoryExporterActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.ref.NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/SetPropertyValueActionExecuter.java b/source/java/org/alfresco/repo/action/executer/SetPropertyValueActionExecuter.java index f7c8a2ea34..46912163ab 100644 --- a/source/java/org/alfresco/repo/action/executer/SetPropertyValueActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/SetPropertyValueActionExecuter.java @@ -58,7 +58,7 @@ public class SetPropertyValueActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/SimpleWorkflowActionExecuter.java b/source/java/org/alfresco/repo/action/executer/SimpleWorkflowActionExecuter.java index 24d72595ab..7db3d9a419 100644 --- a/source/java/org/alfresco/repo/action/executer/SimpleWorkflowActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/SimpleWorkflowActionExecuter.java @@ -66,7 +66,7 @@ public class SimpleWorkflowActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(Action, org.alfresco.service.cmr.repository.NodeRef) */ @Override protected void executeImpl( diff --git a/source/java/org/alfresco/repo/action/executer/SpecialiseTypeActionExecuter.java b/source/java/org/alfresco/repo/action/executer/SpecialiseTypeActionExecuter.java index 56c9456f0d..b1c46bc71c 100644 --- a/source/java/org/alfresco/repo/action/executer/SpecialiseTypeActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/SpecialiseTypeActionExecuter.java @@ -73,7 +73,7 @@ public class SpecialiseTypeActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) */ public void executeImpl(Action ruleAction, NodeRef actionedUponNodeRef) { diff --git a/source/java/org/alfresco/repo/action/executer/TransformActionExecuter.java b/source/java/org/alfresco/repo/action/executer/TransformActionExecuter.java index 475f91e8a3..5622e45c20 100644 --- a/source/java/org/alfresco/repo/action/executer/TransformActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/TransformActionExecuter.java @@ -148,7 +148,7 @@ public class TransformActionExecuter extends ActionExecuterAbstractBase } /** - * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(Action, org.alfresco.service.cmr.repository.NodeRef) */ @Override protected void executeImpl( diff --git a/source/java/org/alfresco/repo/action/executer/TransitionSimpleWorkflowActionExecuter.java b/source/java/org/alfresco/repo/action/executer/TransitionSimpleWorkflowActionExecuter.java index ca57b9fb12..b4166bffa2 100644 --- a/source/java/org/alfresco/repo/action/executer/TransitionSimpleWorkflowActionExecuter.java +++ b/source/java/org/alfresco/repo/action/executer/TransitionSimpleWorkflowActionExecuter.java @@ -87,7 +87,7 @@ public class TransitionSimpleWorkflowActionExecuter extends ActionExecuterAbstra } /** - * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(Action, org.alfresco.service.cmr.repository.NodeRef) */ @Override protected void executeImpl( diff --git a/source/java/org/alfresco/repo/activities/ActivityPostServiceImpl.java b/source/java/org/alfresco/repo/activities/ActivityPostServiceImpl.java index 3a5aa4a091..8b34e0f20f 100644 --- a/source/java/org/alfresco/repo/activities/ActivityPostServiceImpl.java +++ b/source/java/org/alfresco/repo/activities/ActivityPostServiceImpl.java @@ -371,13 +371,13 @@ public class ActivityPostServiceImpl implements ActivityPostService } /** - * Validate that the nodeRef property - if present in the activity data - is valid - * on a basic level (it can be used to construct a NodeRef object). - * - * @param activityPost - * @throws JSONException - */ - private NodeRef checkNodeRef(JSONObject jo) throws JSONException + * Validate that the nodeRef property - if present in the activity data - is valid + * on a basic level (it can be used to construct a NodeRef object). + * + * @param jo + * @throws JSONException + */ + private NodeRef checkNodeRef(JSONObject jo) throws JSONException { String nodeRefStr = null; try diff --git a/source/java/org/alfresco/repo/activities/feed/ErrorProneActionExecutor.java b/source/java/org/alfresco/repo/activities/feed/ErrorProneActionExecutor.java index 1290a6c7c6..a5d49c4d34 100644 --- a/source/java/org/alfresco/repo/activities/feed/ErrorProneActionExecutor.java +++ b/source/java/org/alfresco/repo/activities/feed/ErrorProneActionExecutor.java @@ -45,7 +45,7 @@ public class ErrorProneActionExecutor extends ActionExecuterAbstractBase /** * Send an email message * - * @throws AlfrescoRuntimeExeption + * @throws AlfrescoRuntimeException */ @Override protected void executeImpl( diff --git a/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java b/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java index 000d1713a0..3ac6c3b8a4 100644 --- a/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java +++ b/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java @@ -109,11 +109,9 @@ public interface RepoServerMgmtMBean * * If number of non-expired logins is greater or equal to the limit then further logins will be prevented * otherwise valid login attempt will be permitted. However, single-user mode will take precedence. - * - * Max users = 0 prevents further logins - * Max users = -1 allow logins (without a max limit) - * - * @param int maxUsers - */ - public int getMaxUsers(); -} + * + * Max users = 0 prevents further logins + * Max users = -1 allow logins (without a max limit) + */ + public int getMaxUsers(); +} diff --git a/source/java/org/alfresco/repo/admin/patch/PatchService.java b/source/java/org/alfresco/repo/admin/patch/PatchService.java index a571d7f3d3..56747f5384 100644 --- a/source/java/org/alfresco/repo/admin/patch/PatchService.java +++ b/source/java/org/alfresco/repo/admin/patch/PatchService.java @@ -65,15 +65,15 @@ public interface PatchService */ public boolean applyOutstandingPatch(Patch patch); - /** - * Retrieves all applied patches between two specific times. - * - * @param from - * the start date of the search, or null to get all patches from the start - * @param to - * the end date of the search, or null to g - * @return Returns all applied patches (successful or not) - */ + /** + * Retrieves all applied patches between two specific times. + * + * @param fromDate + * the start date of the search, or null to get all patches from the start + * @param toDate + * the end date of the search, or null to g + * @return Returns all applied patches (successful or not) + */ public List getPatches(Date fromDate, Date toDate); /** diff --git a/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java b/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java index 9e4ac9dfb1..6046650762 100644 --- a/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java +++ b/source/java/org/alfresco/repo/admin/patch/PatchServiceImpl.java @@ -257,13 +257,13 @@ 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 patchInfos 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 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 * @return Returns true if the patch and all its dependencies were successfully applied. */ private boolean applyPatchAndDependencies(final Patch patch, Map appliedPatchesById) diff --git a/source/java/org/alfresco/repo/admin/patch/SimplePatch.java b/source/java/org/alfresco/repo/admin/patch/SimplePatch.java index ec0f6ca7cc..458f5ee6f0 100644 --- a/source/java/org/alfresco/repo/admin/patch/SimplePatch.java +++ b/source/java/org/alfresco/repo/admin/patch/SimplePatch.java @@ -24,7 +24,8 @@ public class SimplePatch extends AbstractPatch /** * Helper constructor for some tests. Default properties are set automatically. * - * @param mustFail true if this instance must always fail to apply + * @param transactionService TransactionService + * @param requiresTransaction true if transaction required */ /* protected */ SimplePatch(TransactionService transactionService, boolean requiresTransaction) { 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 2aa93dfa82..d48a198cf1 100644 --- a/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java +++ b/source/java/org/alfresco/repo/admin/patch/impl/GenericWorkflowPatch.java @@ -71,7 +71,7 @@ public class GenericWorkflowPatch extends AbstractPatch implements ApplicationCo /** * Sets the Workflow Names to be undeployed * - * @param workflowDefinitions + * @param undeployWorkflowNames list with names */ public void setUndeployWorkflowNames(List undeployWorkflowNames) { diff --git a/source/java/org/alfresco/repo/admin/patch/impl/SchemaUpgradeScriptPatch.java b/source/java/org/alfresco/repo/admin/patch/impl/SchemaUpgradeScriptPatch.java index 81231f91f4..80872ca879 100644 --- a/source/java/org/alfresco/repo/admin/patch/impl/SchemaUpgradeScriptPatch.java +++ b/source/java/org/alfresco/repo/admin/patch/impl/SchemaUpgradeScriptPatch.java @@ -53,7 +53,7 @@ public class SchemaUpgradeScriptPatch extends AbstractPatch * where the ${hibernate.dialect.class} placeholder will be substituted with the Hibernate * Dialect as configured for the system. * - * @param scriptUrl the scriptUrl filename + * @param script the script */ public void setScriptUrl(String script) { diff --git a/source/java/org/alfresco/repo/admin/registry/RegistryService.java b/source/java/org/alfresco/repo/admin/registry/RegistryService.java index 20ae1558aa..3e8b49186e 100644 --- a/source/java/org/alfresco/repo/admin/registry/RegistryService.java +++ b/source/java/org/alfresco/repo/admin/registry/RegistryService.java @@ -39,13 +39,13 @@ public interface RegistryService /** * @param key the registry key. - * @return Returns the value stored in the key or null if - * no value exists at the path and name provided - * - * @see #addProperty(String, Serializable) - */ - Serializable getProperty(RegistryKey key); - + * @return Returns the value stored in the key or null if + * no value exists at the path and name provided + * + * @see #addProperty(RegistryKey, Serializable) + */ + Serializable getProperty(RegistryKey key); + /** * Fetches all child elements for the given path. The key's property should be * null as it is completely ignored. diff --git a/source/java/org/alfresco/repo/audit/AuditMethodInterceptor.java b/source/java/org/alfresco/repo/audit/AuditMethodInterceptor.java index 5db543ca3b..5ee32526dd 100644 --- a/source/java/org/alfresco/repo/audit/AuditMethodInterceptor.java +++ b/source/java/org/alfresco/repo/audit/AuditMethodInterceptor.java @@ -328,13 +328,13 @@ public class AuditMethodInterceptor implements MethodInterceptor /** * Returns a value that may be included in audit map data. Called for method arguments and return - * values. Not all values may be audited. Some cannot be converted to something that can be - * serialised or may only be read once (so would be damaged). String audit values may be trimmed. - * @param value to be audited. - * @return Return {@link NOT_AUDITABLE} if it is not possible to audit the value,a value that may be audited. May be null. - * @throws TypeConversionException if not possible to convert the original object. - */ - private Serializable getRecordableValue(Object value) + * values. Not all values may be audited. Some cannot be converted to something that can be + * serialised or may only be read once (so would be damaged). String audit values may be trimmed. + * @param value to be audited. + * @return Return {@link #NOT_RECORDABLE} if it is not possible to audit the value,a value that may be audited. May be null. + * @throws TypeConversionException if not possible to convert the original object. + */ + private Serializable getRecordableValue(Object value) { if (value == null) { diff --git a/source/java/org/alfresco/repo/audit/access/NodeInfo.java b/source/java/org/alfresco/repo/audit/access/NodeInfo.java index 1f46fd1ef5..d1ccb2473a 100644 --- a/source/java/org/alfresco/repo/audit/access/NodeInfo.java +++ b/source/java/org/alfresco/repo/audit/access/NodeInfo.java @@ -19,13 +19,13 @@ package org.alfresco.repo.audit.access; import org.alfresco.service.cmr.repository.NodeRef; - -/** - * Wrapper for a {@link NodeRef} to provide path and type values using namespace prefixes. - * Use the {@link NodeInfoFactory#newNodeInfo()} to create new instances. - * - * @author Alan Davis - */ + +/** + * Wrapper for a {@link NodeRef} to provide path and type values using namespace prefixes. + * Use the {@link NodeInfoFactory#newNodeInfo(org.alfresco.service.cmr.repository.NodeRef)} to create new instances. + * + * @author Alan Davis + */ /*package*/ class NodeInfo { private final NodeRef nodeRef; diff --git a/source/java/org/alfresco/repo/audit/extractor/DataExtractor.java b/source/java/org/alfresco/repo/audit/extractor/DataExtractor.java index c934a50f23..139958e584 100644 --- a/source/java/org/alfresco/repo/audit/extractor/DataExtractor.java +++ b/source/java/org/alfresco/repo/audit/extractor/DataExtractor.java @@ -24,13 +24,13 @@ import org.alfresco.api.AlfrescoPublicApi; /** * Interface for Audit data value extractors. These are used to extract auditable values - * from those arguments, return values, exceptions and any other value passed into the audit - * components for recording. - *

    - * The framework will first determine if data passed into the instance is {@link #isSupported(Object) supported} - * and will then pass it in for {@link #extractData(Serializable) conversion} to the type that will be - * recorded. - * + * from those arguments, return values, exceptions and any other value passed into the audit + * components for recording. + *

    + * The framework will first determine if data passed into the instance is {@link #isSupported(Serializable) supported} + * and will then pass it in for {@link #extractData(Serializable) conversion} to the type that will be + * recorded. + * * @author Derek Hulley * @since 3.2 */ diff --git a/source/java/org/alfresco/repo/audit/model/AuditApplication.java b/source/java/org/alfresco/repo/audit/model/AuditApplication.java index c032e9d2e3..61b7769571 100644 --- a/source/java/org/alfresco/repo/audit/model/AuditApplication.java +++ b/source/java/org/alfresco/repo/audit/model/AuditApplication.java @@ -166,13 +166,13 @@ public class AuditApplication /** * Helper method to check that a path is correct for this application instance * - * @param path the path in format /app-key/x/y/z - * @throws AuditModelException if the path is invalid - * - * @see #AUDIT_PATH_REGEX - */ - public void checkPath(String path) - { + * @param path the path in format /app-key/x/y/z + * @throws AuditModelException if the path is invalid + * + * @see #AUDIT_PATH_PATTERN + */ + public void checkPath(String path) + { checkPathFormat(path); if (path == null || path.length() == 0) { @@ -195,13 +195,13 @@ public class AuditApplication /** * Helper method to check that a path is correct for this application instance * - * @param path the path in format /app-key/x/y/z - * @throws AuditModelException if the path is invalid - * - * @see #AUDIT_PATH_REGEX - */ - public static void checkPathFormat(String path) - { + * @param path the path in format /app-key/x/y/z + * @throws AuditModelException if the path is invalid + * + * @see #AUDIT_PATH_PATTERN + */ + public static void checkPathFormat(String path) + { if (path == null || path.length() == 0) { throw new AuditModelException("Empty or null audit path: " + path); @@ -219,16 +219,16 @@ public class AuditApplication * the application root key. *

    * If the path separator is present at the beginning of a path component, then it is not added, - * so "/a", "b", "/c" becomes "/a/b/c" allowing path to be appended - * to other paths. - *

    - * The final result is checked against a {@link #AUDIT_PATH_REGEX regular expression} to ensure - * it is valid. - * - * @param pathElements the elements of the path e.g. "a", "b", "c". - * @return Returns the compiled path e.g "/a/b/c". - */ - public static String buildPath(String ... pathComponents) + * so "/a", "b", "/c" becomes "/a/b/c" allowing path to be appended + * to other paths. + *

    + * The final result is checked against a {@link #AUDIT_PATH_PATTERN regular expression} to ensure + * it is valid. + * + * @param pathComponents the elements of the path e.g. "a", "b", "c". + * @return Returns the compiled path e.g "/a/b/c". + */ + public static String buildPath(String ... pathComponents) { StringBuilder sb = new StringBuilder(pathComponents.length * 10); for (String pathComponent : pathComponents) @@ -258,14 +258,12 @@ public class AuditApplication return path; } - /** - * @param path the audit path for form /abc/def - * @return the root key of form abc - * - * @see #AUDIT_ROOT_KEY_REGEX - */ - public static String getRootKey(String path) - { + /** + * @param path the audit path for form /abc/def + * @return the root key of form abc + */ + public static String getRootKey(String path) + { if (!path.startsWith(AUDIT_PATH_SEPARATOR)) { throw new AuditModelException( diff --git a/source/java/org/alfresco/repo/blog/BaseBlogIntegrationImplementation.java b/source/java/org/alfresco/repo/blog/BaseBlogIntegrationImplementation.java index 04cac0b1a6..ba922ed29f 100644 --- a/source/java/org/alfresco/repo/blog/BaseBlogIntegrationImplementation.java +++ b/source/java/org/alfresco/repo/blog/BaseBlogIntegrationImplementation.java @@ -63,7 +63,7 @@ public abstract class BaseBlogIntegrationImplementation implements BlogIntegrati } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#getName() + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#getName() */ public String getName() { @@ -81,7 +81,7 @@ public abstract class BaseBlogIntegrationImplementation implements BlogIntegrati } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#getDisplayName() + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#getDisplayName() */ public String getDisplayName() { diff --git a/source/java/org/alfresco/repo/blog/BlogIntegrationService.java b/source/java/org/alfresco/repo/blog/BlogIntegrationService.java index acde400e77..7063ddf8c3 100644 --- a/source/java/org/alfresco/repo/blog/BlogIntegrationService.java +++ b/source/java/org/alfresco/repo/blog/BlogIntegrationService.java @@ -76,7 +76,6 @@ public interface BlogIntegrationService /** * - * @param postId * @param nodeRef * @param contentProperty * @param publish @@ -85,7 +84,6 @@ public interface BlogIntegrationService /** * - * @param postId * @param 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 37ca0f9820..363a546c1a 100644 --- a/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java +++ b/source/java/org/alfresco/repo/blog/BlogIntegrationServiceImpl.java @@ -83,7 +83,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#register(org.alfresco.module.blogIntegration.BlogIntegrationImplementation) + * @see org.alfresco.repo.blog.BlogIntegrationService#register(org.alfresco.repo.blog.BlogIntegrationImplementation) */ public void register(BlogIntegrationImplementation implementation) { @@ -95,7 +95,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#getBlogIntegrationImplementation(java.lang.String) + * @see org.alfresco.repo.blog.BlogIntegrationService#getBlogIntegrationImplementation(java.lang.String) */ public BlogIntegrationImplementation getBlogIntegrationImplementation(String implementationName) { @@ -103,7 +103,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#getBlogIntegrationImplementations() + * @see org.alfresco.repo.blog.BlogIntegrationService#getBlogIntegrationImplementations() */ public List getBlogIntegrationImplementations() { @@ -111,7 +111,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#getBlogDetails(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.repo.blog.BlogIntegrationService#getBlogDetails(org.alfresco.service.cmr.repository.NodeRef) */ public List getBlogDetails(NodeRef nodeRef) { @@ -157,7 +157,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.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(org.alfresco.module.blogIntegration.BlogDetails, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, boolean) */ public void newPost(BlogDetails blogDetails, NodeRef nodeRef, QName contentProperty, boolean publish) { @@ -249,7 +249,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#updatePost(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, boolean) + * @see org.alfresco.repo.blog.BlogIntegrationService#updatePost(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, boolean) */ public void updatePost(NodeRef nodeRef, QName contentProperty, boolean publish) { @@ -326,7 +326,7 @@ public class BlogIntegrationServiceImpl implements BlogIntegrationService, BlogI } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationService#deletePost(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.repo.blog.BlogIntegrationService#deletePost(org.alfresco.service.cmr.repository.NodeRef) */ public void deletePost(NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java b/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java index cd51539672..5f94f407f3 100644 --- a/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java +++ b/source/java/org/alfresco/repo/blog/DefaultBlogIntegrationImplementation.java @@ -54,7 +54,7 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg protected abstract String getEndpointURL(BlogDetails blogDetails); /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#newPost(org.alfresco.module.blogIntegration.BlogDetails, java.lang.String, java.lang.String, boolean) + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#newPost(org.alfresco.repo.blog.BlogDetails, java.lang.String, java.lang.String, boolean) */ public String newPost(BlogDetails blogDetails, String title, String body, boolean publish) { @@ -76,7 +76,7 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#updatePost(org.alfresco.module.blogIntegration.BlogDetails, java.lang.String, java.lang.String, java.lang.String, boolean) + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#updatePost(org.alfresco.repo.blog.BlogDetails, java.lang.String, java.lang.String, java.lang.String, boolean) */ public boolean updatePost(BlogDetails blogDetails, String postId, String title, String body, boolean publish) { @@ -105,7 +105,7 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#getPost(org.alfresco.module.blogIntegration.BlogDetails, java.lang.String) + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#getPost(org.alfresco.repo.blog.BlogDetails, java.lang.String) */ @SuppressWarnings("unchecked") public Map getPost(BlogDetails blogDetails, String postId) @@ -121,7 +121,7 @@ public abstract class DefaultBlogIntegrationImplementation extends BaseBlogInteg } /** - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#deletePost(org.alfresco.module.blogIntegration.BlogDetails, java.lang.String) + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#deletePost(org.alfresco.repo.blog.BlogDetails, java.lang.String) */ public boolean deletePost(BlogDetails blogDetails, String postId) { diff --git a/source/java/org/alfresco/repo/blog/cannedqueries/DraftsAndPublishedBlogPostsCannedQuery.java b/source/java/org/alfresco/repo/blog/cannedqueries/DraftsAndPublishedBlogPostsCannedQuery.java index 7e099ef899..ab331a2cda 100644 --- a/source/java/org/alfresco/repo/blog/cannedqueries/DraftsAndPublishedBlogPostsCannedQuery.java +++ b/source/java/org/alfresco/repo/blog/cannedqueries/DraftsAndPublishedBlogPostsCannedQuery.java @@ -42,13 +42,13 @@ import org.apache.commons.logging.LogFactory; /** * This is a {@link CannedQuery} for the rather particular 'get my drafts and all published' blog-post query. * - * @author Neil Mc Erlean - * @since 4.0 - * - * @see BlogService#getMyDraftsAndAllPublished(NodeRef, Date, Date, String, org.alfresco.query.PagingRequest) - */ -public class DraftsAndPublishedBlogPostsCannedQuery extends AbstractCannedQueryPermissions -{ + * @author Neil Mc Erlean + * @since 4.0 + * + * @see org.alfresco.service.cmr.blog.BlogService#getMyDraftsAndAllPublished(NodeRef, Date, Date, org.alfresco.query.PagingRequest) + */ +public class DraftsAndPublishedBlogPostsCannedQuery extends AbstractCannedQueryPermissions +{ private Log logger = LogFactory.getLog(getClass()); private static final String QUERY_NAMESPACE = "alfresco.query.blogs"; diff --git a/source/java/org/alfresco/repo/blog/typepad/TypepadIntegration.java b/source/java/org/alfresco/repo/blog/typepad/TypepadIntegration.java index ea52650589..d4bbeae205 100644 --- a/source/java/org/alfresco/repo/blog/typepad/TypepadIntegration.java +++ b/source/java/org/alfresco/repo/blog/typepad/TypepadIntegration.java @@ -29,7 +29,7 @@ import org.alfresco.repo.blog.DefaultBlogIntegrationImplementation; public class TypepadIntegration extends DefaultBlogIntegrationImplementation { /** - * @see org.alfresco.module.blogIntegration.DefaultBlogIntegrationImplementation#getEndpointURL(org.alfresco.module.blogIntegration.BlogDetails) + * @see org.alfresco.repo.blog.DefaultBlogIntegrationImplementation#getEndpointURL(org.alfresco.repo.blog.BlogDetails) */ @Override protected String getEndpointURL(BlogDetails blogDetails) @@ -40,7 +40,7 @@ public class TypepadIntegration extends DefaultBlogIntegrationImplementation /** * For some reason typepad returns a hash table rather than the expected boolean result. * - * @see org.alfresco.module.blogIntegration.BlogIntegrationImplementation#deletePost(org.alfresco.module.blogIntegration.BlogDetails, java.lang.String) + * @see org.alfresco.repo.blog.BlogIntegrationImplementation#deletePost(org.alfresco.repo.blog.BlogDetails, java.lang.String) */ @Override public boolean deletePost(BlogDetails blogDetails, String postId) diff --git a/source/java/org/alfresco/repo/blog/wordpress/WordPressIntegration.java b/source/java/org/alfresco/repo/blog/wordpress/WordPressIntegration.java index eb231fb60b..b782a495bf 100644 --- a/source/java/org/alfresco/repo/blog/wordpress/WordPressIntegration.java +++ b/source/java/org/alfresco/repo/blog/wordpress/WordPressIntegration.java @@ -29,7 +29,7 @@ public class WordPressIntegration extends DefaultBlogIntegrationImplementation private static String ENDPOINT = "xmlrpc.php"; /** - * @see org.alfresco.module.blogIntegration.DefaultBlogIntegrationImplementation#getEndpointURL(org.alfresco.module.blogIntegration.BlogDetails) + * @see DefaultBlogIntegrationImplementation#getEndpointURL(BlogDetails) */ @Override protected String getEndpointURL(BlogDetails blogDetails) diff --git a/source/java/org/alfresco/repo/bulkimport/BulkFSImportEvent.java b/source/java/org/alfresco/repo/bulkimport/BulkFSImportEvent.java index d46f575721..558a667941 100644 --- a/source/java/org/alfresco/repo/bulkimport/BulkFSImportEvent.java +++ b/source/java/org/alfresco/repo/bulkimport/BulkFSImportEvent.java @@ -41,10 +41,6 @@ public class BulkFSImportEvent extends ApplicationEvent * * @param source * the source index monitor - * @param description - * the event description - * @param count - * its instance count */ public BulkFSImportEvent(BulkFilesystemImporter source) { diff --git a/source/java/org/alfresco/repo/bulkimport/BulkFilesystemImporter.java b/source/java/org/alfresco/repo/bulkimport/BulkFilesystemImporter.java index c373a5ee49..17a91c3e68 100644 --- a/source/java/org/alfresco/repo/bulkimport/BulkFilesystemImporter.java +++ b/source/java/org/alfresco/repo/bulkimport/BulkFilesystemImporter.java @@ -37,19 +37,17 @@ public interface BulkFilesystemImporter * Initiates a bulk filesystem import. * Note: getStatus().inProgress() must be false prior to calling this method or an Exception will be thrown. * - * @param target The target space to ingest the content into (must not be null and must be a valid, writable space in the repository). - * @param source The source directory on the local filesystem to read content from (must not be null and must be a valid, readable directory on the local filesystem). - * @param replaceExisting A flag indicating whether to replace (true) or skip (false) files that are already in the repository. + * @param bulkImportParameters The target bulk import parameters. + * @param nodeImporter The node importer. */ void bulkImport(BulkImportParameters bulkImportParameters, NodeImporter nodeImporter); /** * Initiates a bulk filesystem import asynchronously i.e. in a background thread. * Note: getStatus().inProgress() must be false prior to calling this method or an Exception will be thrown. - * - * @param target The target space to ingest the content into (must not be null and must be a valid, writable space in the repository). - * @param source The source directory on the local filesystem to read content from (must not be null and must be a valid, readable directory on the local filesystem). - * @param replaceExisting A flag indicating whether to replace (true) or skip (false) files that are already in the repository. + * + * @param bulkImportParameters The target bulk import parameters. + * @param nodeImporter The node importer. */ void asyncBulkImport(BulkImportParameters bulkImportParameters, NodeImporter nodeImporter); diff --git a/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java b/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java index dc6b9867a4..c9e91c0dda 100644 --- a/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java +++ b/source/java/org/alfresco/repo/bulkimport/impl/AbstractBulkFilesystemImporter.java @@ -126,7 +126,7 @@ public abstract class AbstractBulkFilesystemImporter implements BulkFilesystemIm } /** - * @see org.alfresco.extension.bulkfilesystemimport.BulkFilesystemImporter#getStatus() + * @see org.alfresco.repo.bulkimport.BulkFilesystemImporter#getStatus() */ public final BulkImportStatus getStatus() { @@ -360,7 +360,7 @@ public abstract class AbstractBulkFilesystemImporter implements BulkFilesystemIm } /** - * @see org.alfresco.extension.bulkfilesystemimport.BulkFilesystemImporter#bulkImport(java.io.File, org.alfresco.service.cmr.repository.NodeRef, boolean) + * @see org.alfresco.repo.bulkimport.BulkFilesystemImporter#bulkImport(org.alfresco.repo.bulkimport.BulkImportParameters, org.alfresco.repo.bulkimport.NodeImporter) */ public void bulkImport(final BulkImportParameters bulkImportParameters, final NodeImporter nodeImporter) { diff --git a/source/java/org/alfresco/repo/bulkimport/impl/BulkImportStatusImpl.java b/source/java/org/alfresco/repo/bulkimport/impl/BulkImportStatusImpl.java index ec6ccaef80..4b08248476 100644 --- a/source/java/org/alfresco/repo/bulkimport/impl/BulkImportStatusImpl.java +++ b/source/java/org/alfresco/repo/bulkimport/impl/BulkImportStatusImpl.java @@ -42,7 +42,7 @@ import org.alfresco.repo.bulkimport.ImportableItem; * * @since 4.0 * - * @see org.alfresco.extension.bulkfilesystemimport.BulkImportStatus + * @see org.alfresco.repo.bulkimport.BulkImportStatus */ public class BulkImportStatusImpl implements BulkImportStatus { diff --git a/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java b/source/java/org/alfresco/repo/bulkimport/impl/DirectoryAnalyserImpl.java index 58538def7d..a72619156e 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.extension.bulkfilesystemimport.DirectoryAnalyser#analyseDirectory(java.io.File) + * @see org.alfresco.repo.bulkimport.DirectoryAnalyser#analyseDirectory(java.io.File) */ public AnalysedDirectory analyseDirectory(ImportableItem directory, FileFilter filter) { 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 44dd6e8eb5..30b9ecdaaa 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 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/importfilters/AndImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/AndImportFilter.java index 152c3a5648..7d2c7fe339 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/AndImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/AndImportFilter.java @@ -66,7 +66,7 @@ public class AndImportFilter /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/DirectoryImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/DirectoryImportFilter.java index c8d99c3701..79631a3da7 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/DirectoryImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/DirectoryImportFilter.java @@ -39,7 +39,7 @@ public class DirectoryImportFilter { /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/FileImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/FileImportFilter.java index 78f687b10c..379b7a1a1f 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/FileImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/FileImportFilter.java @@ -38,7 +38,7 @@ public class FileImportFilter implements ImportFilter { /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/FileNameRegexImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/FileNameRegexImportFilter.java index 4f3800a7d0..45a12d3539 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/FileNameRegexImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/FileNameRegexImportFilter.java @@ -53,7 +53,7 @@ public class FileNameRegexImportFilter implements ImportFilter } /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/HiddenFileFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/HiddenFileFilter.java index eda0ab1154..6c05ab1f99 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/HiddenFileFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/HiddenFileFilter.java @@ -40,7 +40,7 @@ import org.alfresco.repo.bulkimport.ImportableItem; public class HiddenFileFilter implements ImportFilter { /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/NonExistentContentFileImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/NonExistentContentFileImportFilter.java index c29eaca5e9..3522c4e5f5 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/NonExistentContentFileImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/NonExistentContentFileImportFilter.java @@ -38,7 +38,7 @@ public class NonExistentContentFileImportFilter implements ImportFilter { /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/importfilters/NotImportFilter.java b/source/java/org/alfresco/repo/bulkimport/importfilters/NotImportFilter.java index 68cacbf8f8..15d11fc367 100644 --- a/source/java/org/alfresco/repo/bulkimport/importfilters/NotImportFilter.java +++ b/source/java/org/alfresco/repo/bulkimport/importfilters/NotImportFilter.java @@ -50,7 +50,7 @@ public class NotImportFilter /** - * @see org.alfresco.extension.bulkfilesystemimport.ImportFilter#shouldFilter(org.alfresco.extension.bulkfilesystemimport.ImportableItem) + * @see org.alfresco.repo.bulkimport.ImportFilter#shouldFilter(org.alfresco.repo.bulkimport.ImportableItem) */ public boolean shouldFilter(final ImportableItem importableItem) { diff --git a/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java b/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java index a3f5a06224..e1deeed0aa 100644 --- a/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java +++ b/source/java/org/alfresco/repo/bulkimport/metadataloaders/AbstractMapBasedMetadataLoader.java @@ -83,7 +83,7 @@ abstract class AbstractMapBasedMetadataLoader implements MetadataLoader /** - * @see org.alfresco.extension.bulkfilesystemimport.MetadataLoader#getMetadataFileExtension() + * @see org.alfresco.repo.bulkimport.MetadataLoader#getMetadataFileExtension() */ @Override public final String getMetadataFileExtension() @@ -101,7 +101,7 @@ abstract class AbstractMapBasedMetadataLoader implements MetadataLoader /** - * @see org.alfresco.extension.bulkfilesystemimport.MetadataLoader#loadMetadata(org.alfresco.extension.bulkfilesystemimport.ImportableItem.ContentAndMetadata, org.alfresco.extension.bulkfilesystemimport.MetadataLoader.Metadata) + * @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/metadataloaders/PropertiesFileMetadataLoader.java b/source/java/org/alfresco/repo/bulkimport/metadataloaders/PropertiesFileMetadataLoader.java index c6d783d6fe..2402b48204 100644 --- a/source/java/org/alfresco/repo/bulkimport/metadataloaders/PropertiesFileMetadataLoader.java +++ b/source/java/org/alfresco/repo/bulkimport/metadataloaders/PropertiesFileMetadataLoader.java @@ -106,7 +106,7 @@ extends AbstractMapBasedMetadataLoader /** - * @see org.alfresco.extension.bulkfilesystemimport.metadataloaders.AbstractMapBasedMetadataLoader#loadMetadataFromFile(java.io.File) + * @see org.alfresco.repo.bulkimport.metadataloaders.AbstractMapBasedMetadataLoader#loadMetadataFromFile(java.io.File) */ @Override protected Map loadMetadataFromFile(File metadataFile) diff --git a/source/java/org/alfresco/repo/bulkimport/metadataloaders/XmlPropertiesFileMetadataLoader.java b/source/java/org/alfresco/repo/bulkimport/metadataloaders/XmlPropertiesFileMetadataLoader.java index 73f16a28a1..5ebcfa5143 100644 --- a/source/java/org/alfresco/repo/bulkimport/metadataloaders/XmlPropertiesFileMetadataLoader.java +++ b/source/java/org/alfresco/repo/bulkimport/metadataloaders/XmlPropertiesFileMetadataLoader.java @@ -108,7 +108,7 @@ public final class XmlPropertiesFileMetadataLoader extends AbstractMapBasedMetad } /** - * @see org.alfresco.extension.bulkfilesystemimport.metadataloaders.AbstractMapBasedMetadataLoader#loadMetadataFromFile(java.io.File) + * @see AbstractMapBasedMetadataLoader#loadMetadataFromFile(java.io.File) */ @Override protected Map loadMetadataFromFile(File metadataFile) diff --git a/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java b/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java index c29da97a00..c5e6c128ac 100644 --- a/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java +++ b/source/java/org/alfresco/repo/bulkimport/script/BulkImport.java @@ -34,7 +34,7 @@ import org.alfresco.repo.bulkimport.ContentStoreMapProvider; import org.alfresco.repo.processor.BaseProcessorExtension; /** - * Custom javascript root object to provide access to the {@link BulkFilesystemImporter} from scripts. + * Custom javascript root object to provide access to the {@link org.alfresco.repo.bulkimport.BulkFilesystemImporter} from scripts. * * @since 4.0 * diff --git a/source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java b/source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java index 9952525eb7..6d969eae3a 100644 --- a/source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java +++ b/source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java @@ -529,13 +529,13 @@ public class EntityLookupCachenull not allowed) - * @return The entity key (may be null) - */ - @SuppressWarnings("unchecked") + /** + * Cache-only operation: Get the key for a given value key (note: not 'value' but 'value key'). + * + * @param valueKey The entity value key, which must be valid (null not allowed) + * @return The entity key (may be null) + */ + @SuppressWarnings("unchecked") public K getKey(VK valueKey) { // There is a good value key, cache by value @@ -646,13 +646,13 @@ public class EntityLookupCache * It is up to the client code to decide if a 0 return value indicates a concurrency violation - * or not; usually the former will generate {@link ConcurrencyFailureException} or something recognised - * by the {@link RetryingTransactionHelper#RETRY_EXCEPTIONS RetryingTransactionHelper}. - * - * @param key the entity value, which may be valid or invalid (null allowed) - * @return Returns the row deletion count - */ - public int deleteByValue(V value) + * or not; usually the former will generate {@link ConcurrencyFailureException} or something recognised + * by the {@link RetryingTransactionHelper#RETRY_EXCEPTIONS RetryingTransactionHelper}. + * + * @param value the entity value, which may be valid or invalid (null allowed) + * @return Returns the row deletion count + */ + public int deleteByValue(V value) { // Handle missing cache if (cache == null) diff --git a/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java b/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java index 0297021500..1f52b527a2 100755 --- a/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java +++ b/source/java/org/alfresco/repo/coci/CheckOutCheckInServicePolicies.java @@ -57,13 +57,13 @@ public interface CheckOutCheckInServicePolicies public interface OnCheckOut extends ClassPolicy { static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "onCheckOut"); - - /** - * - * @param nodeRef - */ - void onCheckOut(NodeRef workingCopy); - } + + /** + * + * @param workingCopy - working copy + */ + void onCheckOut(NodeRef workingCopy); + } /** * @@ -106,13 +106,13 @@ public interface CheckOutCheckInServicePolicies public interface BeforeCancelCheckOut extends ClassPolicy { static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "beforeCancelCheckOut"); - - /** - * - * @param nodeRef - */ - void beforeCancelCheckOut(NodeRef workingCopyNodeRef); - } + + /** + * + * @param workingCopyNodeRef - working copy nodeRef + */ + void beforeCancelCheckOut(NodeRef workingCopyNodeRef); + } /** * diff --git a/source/java/org/alfresco/repo/content/AbstractContentStore.java b/source/java/org/alfresco/repo/content/AbstractContentStore.java index 31b6a68d19..6d104b0f45 100644 --- a/source/java/org/alfresco/repo/content/AbstractContentStore.java +++ b/source/java/org/alfresco/repo/content/AbstractContentStore.java @@ -36,13 +36,13 @@ import org.apache.commons.logging.LogFactory; * provided is the generation of new content URLs and the checking of * existing URLs. *

    - * Implementations must override either of the getWriter methods; - * {@link #getWriter(ContentContext)} or {@link #getWriterInternal(ContentReader, String)}. - * - * @see #getWriter(ContentReader, String) - * @see #getWriterInternal(ContentReader, String) - * - * @author Derek Hulley + * Implementations must override either of the getWriter methods; + * {@link #getWriter(ContentContext)} or {@link #getWriterInternal(ContentReader, String)}. + * + * @see #getWriter(org.alfresco.repo.content.ContentContext) + * @see #getWriterInternal(ContentReader, String) + * + * @author Derek Hulley */ public abstract class AbstractContentStore implements ContentStore { diff --git a/source/java/org/alfresco/repo/content/AbstractContentWriter.java b/source/java/org/alfresco/repo/content/AbstractContentWriter.java index 986537fc04..b9ab6e8ac7 100644 --- a/source/java/org/alfresco/repo/content/AbstractContentWriter.java +++ b/source/java/org/alfresco/repo/content/AbstractContentWriter.java @@ -265,13 +265,13 @@ public abstract class AbstractContentWriter extends AbstractContentAccessor impl } return callbackChannel; } - - /** - * @see #getDirectWritableChannel() - * @see #getCallbackWritableChannel() - */ - public synchronized final WritableByteChannel getWritableChannel() throws ContentIOException - { + + /** + * @see #getDirectWritableChannel() + * @see #getCallbackWritableChannel(java.nio.channels.WritableByteChannel, List) + */ + public synchronized final WritableByteChannel getWritableChannel() throws ContentIOException + { // this is a use-once object if (channel != null) { diff --git a/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java b/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java index a341a3ab8a..af362852d6 100644 --- a/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java +++ b/source/java/org/alfresco/repo/content/ContentStoreCreatedEvent.java @@ -39,14 +39,12 @@ public class ContentStoreCreatedEvent extends ApplicationEvent /** * The Constructor. * - * @param source - * the source content store - * @param extendedEventParams - * @param rootDirectory - * the root directory - */ - public ContentStoreCreatedEvent(ContentStore source, Map extendedEventParams) - { + * @param source + * the source content store + * @param extendedEventParams + */ + public ContentStoreCreatedEvent(ContentStore source, Map extendedEventParams) + { super(source); this.extendedEventParams = extendedEventParams; } diff --git a/source/java/org/alfresco/repo/content/ContentWorker.java b/source/java/org/alfresco/repo/content/ContentWorker.java index 6f0a1691c6..d6b1a75b26 100644 --- a/source/java/org/alfresco/repo/content/ContentWorker.java +++ b/source/java/org/alfresco/repo/content/ContentWorker.java @@ -22,13 +22,13 @@ import org.alfresco.api.AlfrescoPublicApi; /** * An interface instances that operate on content. This is a marker interface - * for specific worker interfaces such as metadata extractors, content transformers - * and so forth. - * - * @see ContentWorkerSelector - * @since 2.1 - * @author Derek Hulley - */ + * for specific worker interfaces such as metadata extractors, content transformers + * and so forth. + * + * @see org.alfresco.repo.content.selector.ContentWorkerSelector + * @since 2.1 + * @author Derek Hulley + */ @AlfrescoPublicApi public interface ContentWorker { diff --git a/source/java/org/alfresco/repo/content/caching/CacheFileProps.java b/source/java/org/alfresco/repo/content/caching/CacheFileProps.java index 2f6032d4d8..a7ec6506d9 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 cachedFile - */ - 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(); } diff --git a/source/java/org/alfresco/repo/content/caching/ContentCache.java b/source/java/org/alfresco/repo/content/caching/ContentCache.java index 845c196167..8b09b22b29 100644 --- a/source/java/org/alfresco/repo/content/caching/ContentCache.java +++ b/source/java/org/alfresco/repo/content/caching/ContentCache.java @@ -92,11 +92,11 @@ public interface ContentCache 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 context - * @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 7277c62772..5a59dfb890 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 @@ -152,13 +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. - * - * @param contentUrl - * @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(); diff --git a/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanerCreatedEvent.java b/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanerCreatedEvent.java index 6d793334ab..c76a2fc7e7 100644 --- a/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanerCreatedEvent.java +++ b/source/java/org/alfresco/repo/content/caching/cleanup/CachedContentCleanerCreatedEvent.java @@ -27,13 +27,13 @@ import org.alfresco.repo.content.caching.CachingContentStoreEvent; */ public class CachedContentCleanerCreatedEvent extends CachingContentStoreEvent { - private static final long serialVersionUID = 1L; - - /** - * @param source - */ - public CachedContentCleanerCreatedEvent(CachedContentCleaner cleaner) - { + private static final long serialVersionUID = 1L; + + /** + * @param cleaner - cleaner + */ + public CachedContentCleanerCreatedEvent(CachedContentCleaner cleaner) + { super(cleaner); } diff --git a/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java b/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java index 305d923029..4f3e6ab596 100644 --- a/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java +++ b/source/java/org/alfresco/repo/content/cleanup/ContentStoreCleaner.java @@ -369,7 +369,6 @@ public class ContentStoreCleaner /** * - * @param minIdInclusive the min content URL ID (inclusive) * @param maxTimeExclusive the max orphan time (exclusive) * @param batchSize the maximum number of orphans to process * @return Returns the last processed orphan ID or null if nothing was processed diff --git a/source/java/org/alfresco/repo/content/filestore/FileContentStore.java b/source/java/org/alfresco/repo/content/filestore/FileContentStore.java index 0bb55c8d5d..66f4494bdd 100644 --- a/source/java/org/alfresco/repo/content/filestore/FileContentStore.java +++ b/source/java/org/alfresco/repo/content/filestore/FileContentStore.java @@ -340,8 +340,6 @@ public class FileContentStore * @throws UnsupportedContentUrlException * if the URL is invalid and doesn't support the * {@link FileContentStore#STORE_PROTOCOL correct protocol} - * - * @see #checkUrl(String) */ /*package*/ File makeFile(String contentUrl) { diff --git a/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java index 8768d9af1b..6e58c1247d 100644 --- a/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java @@ -212,14 +212,16 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter, Be return extract(reader, OverwritePolicy.PRAGMATIC, destination); } - /** - * {@inheritDoc} - * - * @param propertyMapping ignored - * - * @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/DWGMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/DWGMetadataExtracter.java index ccc6670998..77de3138cd 100644 --- a/source/java/org/alfresco/repo/content/metadata/DWGMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/DWGMetadataExtracter.java @@ -30,8 +30,10 @@ import org.apache.tika.parser.dwg.DWGParser; /** * Metadata extractor for the - * {@link org.alfresco.repo.content.MimetypeMap#MIMETYPE_DWG MIMETYPE_DWG} - * mimetype. + * {@link org.alfresco.repo.content.MimetypeMap#MIMETYPE_APP_DWG MIMETYPE_APP_DWG} + * and + * {@link org.alfresco.repo.content.MimetypeMap#MIMETYPE_IMG_DWG MIMETYPE_IMG_DWG} + * mimetypes. *

      *   title:           --      cm:title
      *   description:     --      cm:description
    diff --git a/source/java/org/alfresco/repo/content/metadata/MetadataEmbedder.java b/source/java/org/alfresco/repo/content/metadata/MetadataEmbedder.java
    index 08c07b567a..777ea3426e 100644
    --- a/source/java/org/alfresco/repo/content/metadata/MetadataEmbedder.java
    +++ b/source/java/org/alfresco/repo/content/metadata/MetadataEmbedder.java
    @@ -49,7 +49,7 @@ public interface MetadataEmbedder extends ContentWorker {
          * Embeds the given properties into the file specified by the given content writer.
          *      * 

    * The embedding viability can be determined by an up front call to - * {@link #isSupported(String)}. + * {@link #isEmbeddingSupported(String)}. *

    * The source mimetype must be available on the * {@link org.alfresco.service.cmr.repository.ContentAccessor#getMimetype()} method diff --git a/source/java/org/alfresco/repo/content/metadata/MetadataExtracterRegistry.java b/source/java/org/alfresco/repo/content/metadata/MetadataExtracterRegistry.java index c9a0716c1d..53c4481153 100644 --- a/source/java/org/alfresco/repo/content/metadata/MetadataExtracterRegistry.java +++ b/source/java/org/alfresco/repo/content/metadata/MetadataExtracterRegistry.java @@ -113,13 +113,13 @@ public class MetadataExtracterRegistry /** * Gets the best metadata extracter. This is a combination of the most * reliable and the most performant extracter. - *

    - * The result is cached for quicker access next time. - * - * @param mimetype the source MIME of the extraction - * @return Returns a metadata extracter that can extract metadata from the - * chosen MIME type. - */ + *

    + * The result is cached for quicker access next time. + * + * @param sourceMimetype the source MIME of the extraction + * @return Returns a metadata extracter that can extract metadata from the + * chosen MIME type. + */ public MetadataExtracter getExtracter(String sourceMimetype) { logger.debug("Get extractors for " + sourceMimetype); @@ -216,13 +216,13 @@ public class MetadataExtracterRegistry /** * Gets the best metadata embedder. This is a combination of the most * reliable and the most performant embedder. - *

    - * The result is cached for quicker access next time. - * - * @param mimetype the source MIME of the extraction - * @return Returns a metadata embedder that can embed metadata in the - * chosen MIME type. - */ + *

    + * The result is cached for quicker access next time. + * + * @param sourceMimetype the source MIME of the extraction + * @return Returns a metadata embedder that can embed metadata in the + * chosen MIME type. + */ public MetadataEmbedder getEmbedder(String sourceMimetype) { List embedders = null; diff --git a/source/java/org/alfresco/repo/content/metadata/TikaAudioMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/TikaAudioMetadataExtracter.java index 31b74a1221..8826c6ff23 100644 --- a/source/java/org/alfresco/repo/content/metadata/TikaAudioMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/TikaAudioMetadataExtracter.java @@ -152,7 +152,7 @@ public class TikaAudioMetadataExtracter extends TikaPoweredMetadataExtracter /** * Generate the description * - * @param props the properties extracted from the file + * @param metadata the metadata extracted from the file * @return the description */ @SuppressWarnings("deprecation") diff --git a/source/java/org/alfresco/repo/content/metadata/TikaPoweredMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/TikaPoweredMetadataExtracter.java index 74b16fe76e..32c737dd7c 100644 --- a/source/java/org/alfresco/repo/content/metadata/TikaPoweredMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/TikaPoweredMetadataExtracter.java @@ -313,7 +313,7 @@ public abstract class TikaPoweredMetadataExtracter * null by default so parse all. * * @param metadata - * @param sourceMimeType + * @param targetMimeType * @return the document selector */ protected DocumentSelector getDocumentSelector(Metadata metadata, String targetMimeType) diff --git a/source/java/org/alfresco/repo/content/metadata/TikaSpringConfiguredMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/TikaSpringConfiguredMetadataExtracter.java index db483ef03a..20ac6ed019 100644 --- a/source/java/org/alfresco/repo/content/metadata/TikaSpringConfiguredMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/TikaSpringConfiguredMetadataExtracter.java @@ -77,7 +77,7 @@ public class TikaSpringConfiguredMetadataExtracter extends TikaPoweredMetadataEx /** * Injects the Tika parser to use - * @param parser + * @param tikaParser */ public void setTikaParser(Parser tikaParser) { diff --git a/source/java/org/alfresco/repo/content/metadata/xml/XPathMetadataExtracter.java b/source/java/org/alfresco/repo/content/metadata/xml/XPathMetadataExtracter.java index e195b65660..446746c4a0 100644 --- a/source/java/org/alfresco/repo/content/metadata/xml/XPathMetadataExtracter.java +++ b/source/java/org/alfresco/repo/content/metadata/xml/XPathMetadataExtracter.java @@ -74,7 +74,7 @@ import org.w3c.dom.NodeList; * *

  • * A mapping of document property names to Alfresco repository model QNames. - * See {@link #setXPathMappingProperties(Properties).} + * See {@link #setXpathMappingProperties(Properties).} *
  • * *

    diff --git a/source/java/org/alfresco/repo/content/replication/AggregatingContentStore.java b/source/java/org/alfresco/repo/content/replication/AggregatingContentStore.java index d28f018d32..fe076a127b 100644 --- a/source/java/org/alfresco/repo/content/replication/AggregatingContentStore.java +++ b/source/java/org/alfresco/repo/content/replication/AggregatingContentStore.java @@ -87,7 +87,7 @@ public class AggregatingContentStore extends AbstractContentStore /** * Set the secondary stores that this component will replicate to or from * - * @param stores a list of stores to replicate to or from + * @param secondaryStores a list of stores to replicate to or from */ public void setSecondaryStores(List secondaryStores) { diff --git a/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java b/source/java/org/alfresco/repo/content/replication/ReplicatingContentStore.java index 881ec7c1b8..1266b73e31 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(boolean) 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}] @@ -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 stores 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/selector/XPathContentWorkerSelector.java b/source/java/org/alfresco/repo/content/selector/XPathContentWorkerSelector.java index b635ea2ff6..31ad4e839a 100644 --- a/source/java/org/alfresco/repo/content/selector/XPathContentWorkerSelector.java +++ b/source/java/org/alfresco/repo/content/selector/XPathContentWorkerSelector.java @@ -168,7 +168,7 @@ public class XPathContentWorkerSelector implements Cont /** * Check the given document against the list of XPath statements provided. * - * @param document the XML document + * @param doc the XML document * @return Returns a content worker that was matched or null */ private W processDocument(Document doc) diff --git a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java index 65bd3b7b28..d6b279d713 100644 --- a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformer.java @@ -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 ContentTransformer#getReliability(String, String) reliability check}. + * via the {@link org.alfresco.repo.content.transform.ContentTransformerContentTransformer#getReliability(String, String) reliability check}. * * @param explicitTransformations explicit key mappings */ @@ -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)}
    • - *
    • 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 bb5028171b..b729b15986 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, Map) - */ - 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()); } diff --git a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java index 14f1c592b1..7ed1446d95 100644 --- a/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java +++ b/source/java/org/alfresco/repo/content/transform/AbstractContentTransformerLimits.java @@ -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, String)} which allows the - * limits to be selected based on mimetype and use. - */ - protected TransformationOptionLimits getLimits() + } + + /** + * @deprecated use @link {@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); } diff --git a/source/java/org/alfresco/repo/content/transform/ContentTransformerRegistry.java b/source/java/org/alfresco/repo/content/transform/ContentTransformerRegistry.java index 1b7e7889c2..9b95eeb6a7 100644 --- a/source/java/org/alfresco/repo/content/transform/ContentTransformerRegistry.java +++ b/source/java/org/alfresco/repo/content/transform/ContentTransformerRegistry.java @@ -49,13 +49,13 @@ public class ContentTransformerRegistry private final List transformers; private final List allTransformers; - private final TransformerSelector transformerSelector; - - /** - * @param mimetypeMap all the mimetypes available to the system - */ - public ContentTransformerRegistry(TransformerSelector transformerSelector) - { + private final TransformerSelector transformerSelector; + + /** + * @param transformerSelector Transformer selector + */ + public ContentTransformerRegistry(TransformerSelector transformerSelector) + { this.transformerSelector = transformerSelector; this.transformers = new ArrayList(70); this.allTransformers = new ArrayList(70); @@ -195,13 +195,13 @@ public class ContentTransformerRegistry throw new UnsupportedOperationException(); } - /** - * A key for a combination of a source and target mimetype - * - * @Deprecated since 3.0 - */ - @Deprecated - public static class TransformationKey + /** + * A key for a combination of a source and target mimetype + * + * Deprecated since 3.0 + */ + @Deprecated + public static class TransformationKey { private final String sourceMimetype; private final String targetMimetype; diff --git a/source/java/org/alfresco/repo/content/transform/HtmlParserContentTransformer.java b/source/java/org/alfresco/repo/content/transform/HtmlParserContentTransformer.java index 87062f9b41..2e7e7c81bb 100644 --- a/source/java/org/alfresco/repo/content/transform/HtmlParserContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/HtmlParserContentTransformer.java @@ -47,15 +47,15 @@ import org.htmlparser.util.ParserException; *

    * Tika Note - could be converted to use the Tika HTML parser, * but we'd potentially need a custom text handler to replicate - * the current settings around links and non-breaking spaces. - *

    - * - * @see http://htmlparser.sourceforge.net/ - * @see org.htmlparser.beans.StringBean - * @see http://sourceforge.net/tracker/?func=detail&aid=1644504&group_id=24399&atid=381401 - * - * @author Derek Hulley - */ + * the current settings around links and non-breaking spaces. + *

    + * + * @see http://htmlparser.sourceforge.net + * @see org.htmlparser.beans.StringBean + * @see HTML Parser + * + * @author Derek Hulley + */ public class HtmlParserContentTransformer extends AbstractContentTransformer2 { @SuppressWarnings("unused") diff --git a/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java b/source/java/org/alfresco/repo/content/transform/RuntimeExecutableContentTransformerWorker.java index 831493f007..90633aefac 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 erroCodesStr + * @param errCodesStr */ public void setErrorCodes(String errCodesStr) { diff --git a/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java b/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java index bace2fde1e..c18d47c2d2 100644 --- a/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java +++ b/source/java/org/alfresco/repo/content/transform/TikaSpringConfiguredContentTransformer.java @@ -61,7 +61,7 @@ public class TikaSpringConfiguredContentTransformer extends TikaPoweredContentTr /** * Injects the Tika parser to use - * @param parser + * @param tikaParser */ public void setTikaParser(Parser tikaParser) { diff --git a/source/java/org/alfresco/repo/content/transform/TransformerConfig.java b/source/java/org/alfresco/repo/content/transform/TransformerConfig.java index acbb230b90..e93abb1c29 100644 --- a/source/java/org/alfresco/repo/content/transform/TransformerConfig.java +++ b/source/java/org/alfresco/repo/content/transform/TransformerConfig.java @@ -127,7 +127,7 @@ public interface TransformerConfig * The suffix to property names to indicate which Alfresco version the transformer is * available with. If not specified it is not restricted. So if set to "Enterprise" it * is not available to Community. - * @see AMP + * @see #AMP */ static final String EDITION = ".edition"; @@ -174,7 +174,7 @@ public interface TransformerConfig /** * To support the historical concept of EXPLICIT transformers, all such transformers - * are given a {@link PRIORITY_EXPLICIT} (50). By default transformers have a default of 10. + * are given a {@link #PRIORITY_EXPLICIT} (50). By default transformers have a default of 10. * A value of 5 allows better transformers to be added later. */ public int PRIORITY_EXPLICIT = 50; @@ -320,11 +320,11 @@ public interface TransformerConfig /** * Returns the priority of the specified transformer for the the combination of source and target mimetype. - * @param transformer + * @param contentTransformerHelper * @param sourceMimetype * @param targetMimetype * @return the priority. To support the historical concept of EXPLICIT transformers, all such transformers - * are given a {@link PRIORITY_EXPLICIT} (50). By default transformers have a default of 100. + * are given a {@link #PRIORITY_EXPLICIT} (50). By default transformers have a default of 100. */ public int getPriority(ContentTransformer contentTransformerHelper, String sourceMimetype, String targetMimetype); @@ -332,7 +332,7 @@ public interface TransformerConfig /** * Returns the threshold of the transformer. It is only after this number of transformation attempts * that the average time is used. - * @param transformer + * @param contentTransformerHelper * @param sourceMimetype * @param targetMimetype * @return the threshold. diff --git a/source/java/org/alfresco/repo/content/transform/TransformerDebugLog.java b/source/java/org/alfresco/repo/content/transform/TransformerDebugLog.java index ae5818ff72..8b88459564 100644 --- a/source/java/org/alfresco/repo/content/transform/TransformerDebugLog.java +++ b/source/java/org/alfresco/repo/content/transform/TransformerDebugLog.java @@ -28,7 +28,7 @@ import org.apache.commons.logging.Log; /** * Implementation of a {@link Log} that logs messages to a structure accessible via - * {@link TransformerConfigMBean#getTransformationDebug(int)}.

    + * {@link TransformerConfigMBean#getTransformationDebugLog(int)}.

    * * @author Alan Davis */ 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 040aff8214..af321f24f1 100644 --- a/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java +++ b/source/java/org/alfresco/repo/content/transform/magick/AbstractImageMagickContentTransformerWorker.java @@ -71,13 +71,13 @@ public abstract class AbstractImageMagickContentTransformerWorker extends Conten { this.available = available; } - - /** - * Checks for the JMagick and ImageMagick dependencies, using the common - * {@link #transformInternal(File, File) 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, File) - */ - 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/content/transform/magick/ImageMagickContentTransformerWorker.java b/source/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java index 8dfd9130c2..46fc641f84 100644 --- a/source/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java +++ b/source/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java @@ -111,16 +111,15 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont */ public String getVersionString() { - return this.versionString; - } - - - /** - * Checks for the JMagick and ImageMagick dependencies, using the common - * {@link #transformInternal(File, File) transformation method} to check - * that the sample image can be converted. - */ - @Override + return this.versionString; + } + + /** + * Checks for the JMagick and ImageMagick dependencies, using the common + * {@link #transformInternal(File, String, File, String, TransformationOptions) transformation method} to check + * that the sample image can be converted. + */ + @Override public void afterPropertiesSet() { if (executer == null) @@ -246,13 +245,13 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont return false; } - /** - * Gets the imagemagick command string for the image crop options provided - * - * @param imageResizeOptions image resize options - * @return String the imagemagick command options - */ - private String getImageCropCommandOptions(CropSourceOptions cropOptions) + /** + * Gets the imagemagick command string for the image crop options provided + * + * @param cropOptions image resize options + * @return String the imagemagick command options + */ + private String getImageCropCommandOptions(CropSourceOptions cropOptions) { StringBuilder builder = new StringBuilder(32); String gravity = cropOptions.getGravity(); diff --git a/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java index 5ca2886775..64ae088982 100644 --- a/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/AbstractCopyBehaviourCallback.java @@ -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, 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 daa69268c9..bb34223f25 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#mustCopy(NodeRef)}, - * 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. */ diff --git a/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java b/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java index bad64e9510..54b1bc6d97 100644 --- a/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java +++ b/source/java/org/alfresco/repo/copy/CopyBehaviourCallback.java @@ -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, ChildAssociationRef, boolean) - */ - 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/query/AbstractCopyCannedQueryFactory.java b/source/java/org/alfresco/repo/copy/query/AbstractCopyCannedQueryFactory.java index f554e83b07..e225afbebb 100644 --- a/source/java/org/alfresco/repo/copy/query/AbstractCopyCannedQueryFactory.java +++ b/source/java/org/alfresco/repo/copy/query/AbstractCopyCannedQueryFactory.java @@ -75,14 +75,12 @@ public abstract class AbstractCopyCannedQueryFactory extends AbstractCannedQu { this(originalNodeRef, null); } - /** - * @param originalNodeRef the original node - * @param copyParentNodeRef the copied node's primary parent (optional) - * @param copyNodeAspectsToIgnore aspects on the copied node that effectively hide it - * (null or empty allowed) - */ - public CopyCannedQueryDetail(NodeRef originalNodeRef, NodeRef copyParentNodeRef) - { + /** + * @param originalNodeRef the original node + * @param copyParentNodeRef the copied node's primary parent (optional) + */ + public CopyCannedQueryDetail(NodeRef originalNodeRef, NodeRef copyParentNodeRef) + { super(); if (originalNodeRef == null) { diff --git a/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java b/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java index 11e0130f92..c76ba5e433 100644 --- a/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java +++ b/source/java/org/alfresco/repo/dictionary/DictionaryRepositoryBootstrap.java @@ -186,7 +186,7 @@ implements TenantDeployer, DictionaryListener, /*TenantDictionaryListener, */Mes /** * Set the repository models locations * - * @param repositoryModelsLocations list of the repository models locations + * @param repositoryLocations list of the repository models locations */ public void setRepositoryModelsLocations( List repositoryLocations) { diff --git a/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java b/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java index 8481fc1b91..5609c6b664 100644 --- a/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java +++ b/source/java/org/alfresco/repo/dictionary/ModelValidatorImpl.java @@ -271,8 +271,7 @@ public class ModelValidatorImpl implements ModelValidator * - no deletion of types, aspects or properties or associations * - no addition, update or deletion of default/mandatory aspects * - * @paramn modelName - * @param newOrUpdatedModel + * @param compiledModel */ @Override public void validateModel(CompiledModel compiledModel) diff --git a/source/java/org/alfresco/repo/dictionary/RepositoryLocation.java b/source/java/org/alfresco/repo/dictionary/RepositoryLocation.java index 4f88e03c49..187a813d82 100644 --- a/source/java/org/alfresco/repo/dictionary/RepositoryLocation.java +++ b/source/java/org/alfresco/repo/dictionary/RepositoryLocation.java @@ -97,13 +97,13 @@ public class RepositoryLocation this.path = path; } - /** - * Set the query language - * - * @param path the search language - */ - public void setQueryLanguage(String queryLanguage) - { + /** + * Set the query language + * + * @param queryLanguage the search language + */ + public void setQueryLanguage(String queryLanguage) + { if (queryLanguage.equals(SearchService.LANGUAGE_LUCENE) || queryLanguage.equals(SearchService.LANGUAGE_XPATH) || queryLanguage.equals(LANGUAGE_PATH) || diff --git a/source/java/org/alfresco/repo/domain/audit/AuditDAO.java b/source/java/org/alfresco/repo/domain/audit/AuditDAO.java index c676771fd2..fcbbf96814 100644 --- a/source/java/org/alfresco/repo/domain/audit/AuditDAO.java +++ b/source/java/org/alfresco/repo/domain/audit/AuditDAO.java @@ -103,13 +103,13 @@ public interface AuditDAO } } - /** - * Creates a new audit model entry or finds an existing one - * - * @param the URL of the configuration - * @return Returns the ID of the config matching the input stream and the - * content storage details - * @since 3.2 + /** + * Creates a new audit model entry or finds an existing one + * + * @param url the URL of the configuration + * @return Returns the ID of the config matching the input stream and the + * content storage details + * @since 3.2 */ Pair getOrCreateAuditModel(URL url); diff --git a/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java b/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java index 87f63a6b2f..bed77cccf9 100644 --- a/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java +++ b/source/java/org/alfresco/repo/domain/contentdata/ContentDataDAO.java @@ -158,22 +158,24 @@ public interface ContentDataDAO /** * Updates the content key for the given content url - * - * @since 5.0 - * @param contentUrlId - * @param contentUrlKeyEntity - */ - boolean updateContentUrlKey(long contentUrlId, ContentUrlKeyEntity contentUrlKey); - + * + * @since 5.0 + * @param contentUrlId + * @param contentUrlKey url key + */ + 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 contentUrlEntity - * @return - */ - 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 diff --git a/source/java/org/alfresco/repo/domain/contentdata/ContentDataEntity.java b/source/java/org/alfresco/repo/domain/contentdata/ContentDataEntity.java index b103cec416..315bc6d56c 100644 --- a/source/java/org/alfresco/repo/domain/contentdata/ContentDataEntity.java +++ b/source/java/org/alfresco/repo/domain/contentdata/ContentDataEntity.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.domain.contentdata; @@ -24,7 +24,7 @@ import org.alfresco.util.EqualsHelper; * Entity bean for alf_content_data table. *

    * These are unique (see {@link #equals(Object) equals} and {@link #hashCode() hashCode}) based - * on the {@link #getContentUrl() content URL} value. + * on the {@link #getContentUrlId() content URL} value. * * @author Derek Hulley * @since 3.2 @@ -84,18 +84,18 @@ public class ContentDataEntity return sb.toString(); } - public void incrementVersion() - { - if (version >= Short.MAX_VALUE) - { - this.version = 0L; - } - else - { - this.version++; - } - } - + public void incrementVersion() + { + if (version >= Short.MAX_VALUE) + { + this.version = 0L; + } + else + { + this.version++; + } + } + public Long getId() { return id; diff --git a/source/java/org/alfresco/repo/domain/locale/LocaleDAO.java b/source/java/org/alfresco/repo/domain/locale/LocaleDAO.java index 147e789e25..bedd3be6cf 100644 --- a/source/java/org/alfresco/repo/domain/locale/LocaleDAO.java +++ b/source/java/org/alfresco/repo/domain/locale/LocaleDAO.java @@ -36,13 +36,13 @@ public interface LocaleDAO * @return the locale pair (never null) * @throws DataIntegrityViolationException if the ID provided is invalid */ - Pair getLocalePair(Long id); - - /** - * @param id the locale to fetch or null to get the default locale - * @return the locale or null if no such locale exists - */ - Pair getLocalePair(Locale locale); + Pair getLocalePair(Long id); + + /** + * @param locale the locale to fetch or null to get the default locale + * @return the locale or null if no such locale exists + */ + Pair getLocalePair(Locale locale); /** * @return the locale pair for the default locale. Although the Locale diff --git a/source/java/org/alfresco/repo/domain/locks/AbstractLockDAOImpl.java b/source/java/org/alfresco/repo/domain/locks/AbstractLockDAOImpl.java index 4eb8d0548b..9cedfae80f 100644 --- a/source/java/org/alfresco/repo/domain/locks/AbstractLockDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/locks/AbstractLockDAOImpl.java @@ -319,13 +319,13 @@ public abstract class AbstractLockDAOImpl implements LockDAO protected abstract LockEntity getLock(Long sharedResourceId, Long exclusiveResourceId); /** - * Get any existing lock data for the shared resources. The locks returned are not filtered and - * may be expired. - * - * @param lockResourceIds a list of shared resource IDs for which to retrieve the current locks - * @return Returns a list of locks (expired or not) for the given lock resources - */ - protected abstract List getLocksBySharedResourceIds(List sharedLockResourceIds); + * Get any existing lock data for the shared resources. The locks returned are not filtered and + * may be expired. + * + * @param sharedLockResourceIds a list of shared resource IDs for which to retrieve the current locks + * @return Returns a list of locks (expired or not) for the given lock resources + */ + protected abstract List getLocksBySharedResourceIds(List sharedLockResourceIds); /** * Create a new lock. @@ -342,13 +342,13 @@ public abstract class AbstractLockDAOImpl implements LockDAO String lockToken, long timeToLive); - /** - * Update an existing lock - * @param lockEntity the specific lock to update - * @param lockApplicant the new lock token - * @param timeToLive the new lock time, in milliseconds, for the lock to remain valid - * @return Returns the updated lock - * @throws ConcurrencyFailureException if the entity was not updated + /** + * Update an existing lock + * @param lockEntity the specific lock to update + * @param lockToken the new lock token + * @param timeToLive the new lock time, in milliseconds, for the lock to remain valid + * @return Returns the updated lock + * @throws ConcurrencyFailureException if the entity was not updated */ protected abstract LockEntity updateLock( LockEntity lockEntity, diff --git a/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java b/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java index e002799988..621e4c9a3e 100644 --- a/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/node/AbstractNodeDAOImpl.java @@ -323,7 +323,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO /** * Set the cache that maintains the extended Store root node data * - * @param cache the cache + * @param allRootNodesCache the cache */ public void setAllRootNodesCache(SimpleCache> allRootNodesCache) { @@ -883,7 +883,7 @@ public abstract class AbstractNodeDAOImpl implements NodeDAO, BatchingDAO } /** - * @param key the store ID + * @param storeRef the store ID */ public Pair findByKey(StoreRef storeRef) { @@ -1699,7 +1699,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(NodeEntity, NodeUpdateEntity) + * @see #updateNodeImpl(Node, NodeUpdateEntity, Set) */ private boolean touchNode( Long nodeId, AuditablePropertiesEntity auditableProps, Set nodeAspects, diff --git a/source/java/org/alfresco/repo/domain/node/NodeDAO.java b/source/java/org/alfresco/repo/domain/node/NodeDAO.java index d4e8d393ef..cc26f7ce39 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 forceNew 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); @@ -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 modifiedDate 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,13 +419,15 @@ public interface NodeDAO extends NodeBulkLoader */ public void setNodeAssocIndex(Long id, int assocIndex); - /** - * Remove a specific node association - * - * @param assocId the node association ID to remove - * @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 @@ -530,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 newIndex 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, @@ -721,13 +723,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 currentNodePair 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 diff --git a/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java b/source/java/org/alfresco/repo/domain/node/NodePropertyValue.java index 5752f73e14..5623a8a788 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 NodePropertyValue#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) diff --git a/source/java/org/alfresco/repo/domain/patch/AppliedPatchDAO.java b/source/java/org/alfresco/repo/domain/patch/AppliedPatchDAO.java index c5d608c8ee..37437d3caf 100644 --- a/source/java/org/alfresco/repo/domain/patch/AppliedPatchDAO.java +++ b/source/java/org/alfresco/repo/domain/patch/AppliedPatchDAO.java @@ -31,13 +31,13 @@ import org.alfresco.repo.admin.patch.AppliedPatch; */ public interface AppliedPatchDAO { - /** - * Creates and saves a new instance of the patch. - * - * @param patchInfo the patch ID and details - */ - public void createAppliedPatch(AppliedPatch appliedPatch); - + /** + * Creates and saves a new instance of the patch. + * + * @param appliedPatch the patch + */ + public void createAppliedPatch(AppliedPatch appliedPatch); + public void updateAppliedPatch(AppliedPatch appliedPatch); /** diff --git a/source/java/org/alfresco/repo/domain/permissions/ADMAccessControlListDAO.java b/source/java/org/alfresco/repo/domain/permissions/ADMAccessControlListDAO.java index 67b17b783e..7dc7bf4de3 100644 --- a/source/java/org/alfresco/repo/domain/permissions/ADMAccessControlListDAO.java +++ b/source/java/org/alfresco/repo/domain/permissions/ADMAccessControlListDAO.java @@ -141,16 +141,16 @@ public class ADMAccessControlListDAO implements AccessControlListDAO { CounterSet result = new CounterSet(); List> stores = nodeDAO.getStores(); - - for (Pair pair : stores) - { + + for (Pair pair : stores) + { CounterSet update; Long rootNodeId = nodeDAO.getRootNode(pair.getSecond()).getFirst(); update = fixOldDmAcls(rootNodeId, nodeDAO.getNodeAclId(rootNodeId), (Long)null, true); result.add(update); - } - - HashMap toReturn = new HashMap(); + } + + HashMap toReturn = new HashMap(); toReturn.put(ACLType.DEFINING, Integer.valueOf(result.get(ACLType.DEFINING).getCounter())); toReturn.put(ACLType.FIXED, Integer.valueOf(result.get(ACLType.FIXED).getCounter())); toReturn.put(ACLType.GLOBAL, Integer.valueOf(result.get(ACLType.GLOBAL).getCounter())); @@ -313,14 +313,14 @@ public class ADMAccessControlListDAO implements AccessControlListDAO // Nothing to do: no nodes change as a result of ACL changes } - /** - * Support to set a shared ACL on a node and all of its children - * - * @param nodeRef - * the parent node - * @param inheritFrom - * the parent node's ACL - * @param mergeFrom + /** + * Support to set a shared ACL on a node and all of its children + * + * @param nodeId + * the parent node id + * @param inheritFrom + * the parent node's ACL + * @param mergeFrom * the shared ACL, if already known. If null, will be retrieved / created lazily * @param changes * the list in which to record changes @@ -472,9 +472,9 @@ public class ADMAccessControlListDAO implements AccessControlListDAO { // the acl does not inherit from a node and does not need to be fixed up // Leave alone - } - } - } + } + } + } /** * @@ -547,4 +547,4 @@ public class ADMAccessControlListDAO implements AccessControlListDAO counter += i; } } -} +} diff --git a/source/java/org/alfresco/repo/domain/permissions/AclDAO.java b/source/java/org/alfresco/repo/domain/permissions/AclDAO.java index aa17f5f701..9ef43fde0e 100644 --- a/source/java/org/alfresco/repo/domain/permissions/AclDAO.java +++ b/source/java/org/alfresco/repo/domain/permissions/AclDAO.java @@ -157,14 +157,14 @@ public interface AclDAO public void renameAuthority(String before, String after); - public void deleteAclForNode(long aclId); - - /** - * @param inheritedAclId - * @param aclId - */ - public void fixSharedAcl(Long shared, Long defining); - + public void deleteAclForNode(long aclId); + + /** + * @param shared + * @param defining + */ + public void fixSharedAcl(Long shared, Long defining); + /** * @return */ diff --git a/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java b/source/java/org/alfresco/repo/domain/permissions/AclMemberEntity.java index 1fe0d2967a..9d198c3464 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 position - */ - public void setPos(Integer pos) - { + /** + * Set the position for the ACL-ACE relationship + * + * @param pos + */ + public void setPos(Integer pos) + { this.pos = pos; } diff --git a/source/java/org/alfresco/repo/domain/propval/AbstractPropertyValueDAOImpl.java b/source/java/org/alfresco/repo/domain/propval/AbstractPropertyValueDAOImpl.java index b1ff8a3899..d48b6a78e7 100644 --- a/source/java/org/alfresco/repo/domain/propval/AbstractPropertyValueDAOImpl.java +++ b/source/java/org/alfresco/repo/domain/propval/AbstractPropertyValueDAOImpl.java @@ -273,13 +273,13 @@ public abstract class AbstractPropertyValueDAOImpl implements PropertyValueDAO propertyValueCallback); } - /** - * Set the cache to use for alf_prop_root lookups (optional). - * - * @param propertyValueCache the cache of IDs to property values - */ - public void setPropertyCache(SimpleCache propertyCache) - { + /** + * Set the cache to use for alf_prop_root lookups (optional). + * + * @param propertyCache the cache of IDs to property values + */ + public void setPropertyCache(SimpleCache propertyCache) + { this.propertyCache = new EntityLookupCache( propertyCache, CACHE_REGION_PROPERTY, @@ -847,13 +847,13 @@ public abstract class AbstractPropertyValueDAOImpl implements PropertyValueDAO { findPropertiesByIds(ids, callback); } - - /** - * {@inheritDoc} - * @see #createPropertyImpl(Serializable, int, int) - */ - public Long createProperty(Serializable value) - { + + /** + * {@inheritDoc} + * @see #createPropertyImpl(Long, long, long, Long, Serializable) + */ + public Long createProperty(Serializable value) + { Pair entityPair = propertyCache.getOrCreateByValue(value); return entityPair.getFirst(); } diff --git a/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java b/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java index 6c5df7d40e..cc9d433d5d 100644 --- a/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java +++ b/source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java @@ -196,13 +196,13 @@ 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, int)}. - * - * @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. To limit this behaviour, + * use {@link #getOrCreatePropertyValue(Serializable)}. + * + * @param value the value to find the ID for (may be null) + */ Pair getOrCreatePropertyValue(Serializable value); //================================ @@ -290,13 +290,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 values a combination of one to three values in order - * @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/qname/NamespaceEntity.java b/source/java/org/alfresco/repo/domain/qname/NamespaceEntity.java index 9226ba2539..638c13aa36 100644 --- a/source/java/org/alfresco/repo/domain/qname/NamespaceEntity.java +++ b/source/java/org/alfresco/repo/domain/qname/NamespaceEntity.java @@ -87,13 +87,13 @@ public class NamespaceEntity public void setUri(String uri) { this.uri = uri; - } - - /** - * Convenience getter to interpret the {@link #EMPTY_URI_SUBSTITUTE} - */ - public String getUriSafe() - { + } + + /** + * Convenience getter to interpret the {@link QName#EMPTY_URI_SUBSTITUTE} + */ + public String getUriSafe() + { if (EqualsHelper.nullSafeEquals(uri, QName.EMPTY_URI_SUBSTITUTE)) { return ""; @@ -101,13 +101,13 @@ public class NamespaceEntity else { return uri; - } - } - /** - * Convenience setter to interpret the {@link #EMPTY_URI_SUBSTITUTE} - */ - public void setUriSafe(String uri) - { + } + } + /** + * Convenience setter to interpret the {@link QName#EMPTY_URI_SUBSTITUTE} + */ + public void setUriSafe(String uri) + { this.uri = (uri.length() == 0) ? QName.EMPTY_URI_SUBSTITUTE : uri; } } diff --git a/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java b/source/java/org/alfresco/repo/domain/query/CannedQueryDAO.java index 5acf8f037b..126b5218c2 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 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. * diff --git a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java index 2150226578..21f528952b 100644 --- a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java +++ b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrap.java @@ -178,7 +178,7 @@ public class SchemaBootstrap extends AbstractLifecycleBean private ResourcePatternResolver rpr = new PathMatchingResourcePatternResolver(this.getClass().getClassLoader()); /** - * @see PropertyValue#DEFAULT_MAX_STRING_LENGTH + * @see #DEFAULT_MAX_STRING_LENGTH */ private static final void setMaxStringLength(int length) { @@ -467,7 +467,7 @@ public class SchemaBootstrap extends AbstractLifecycleBean * Register a new script for execution after the Hibernate schema creation phase. The order of registration * determines the order of execution. * - * @param postCreateScriptUrl the script URL, possibly containing the ${db.script.dialect} placeholder + * @param postUpdateScriptUrl the script URL, possibly containing the ${db.script.dialect} placeholder */ public void addPostCreateScriptUrl(String postUpdateScriptUrl) { diff --git a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrapRegistration.java b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrapRegistration.java index 7c2611c6be..3c2618505e 100644 --- a/source/java/org/alfresco/repo/domain/schema/SchemaBootstrapRegistration.java +++ b/source/java/org/alfresco/repo/domain/schema/SchemaBootstrapRegistration.java @@ -67,7 +67,7 @@ public class SchemaBootstrapRegistration } /** - * @param postCreateScriptUrls a list of schema create URLs that will be registered in order. + * @param preCreateScriptUrls a list of schema create URLs that will be registered in order. * * @see SchemaBootstrap#addPostCreateScriptUrl(String) */ diff --git a/source/java/org/alfresco/repo/domain/solr/SOLRDAO.java b/source/java/org/alfresco/repo/domain/solr/SOLRDAO.java index 2510bc0fa9..7d19c48be7 100644 --- a/source/java/org/alfresco/repo/domain/solr/SOLRDAO.java +++ b/source/java/org/alfresco/repo/domain/solr/SOLRDAO.java @@ -71,7 +71,6 @@ public interface SOLRDAO * Get the nodes satisfying the constraints in nodeParameters * * @param nodeParameters set of constraints for which nodes to return - * @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results * @return list of matching nodes */ public List getNodes(NodeParameters nodeParameters); diff --git a/source/java/org/alfresco/repo/domain/usage/UsageDAO.java b/source/java/org/alfresco/repo/domain/usage/UsageDAO.java index 08984cf791..ce390f6a69 100644 --- a/source/java/org/alfresco/repo/domain/usage/UsageDAO.java +++ b/source/java/org/alfresco/repo/domain/usage/UsageDAO.java @@ -73,7 +73,7 @@ public interface UsageDAO * New style content urls - Iterate and sum all content node sizes for user (owner/creator) * * @param storeRef the store to search in - * @param handler the callback to use while iterating over the content sizes (one row per user) + * @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( @@ -84,7 +84,7 @@ public interface UsageDAO * Iterate over all person nodes to get users without a calculated usage * * @param storeRef the store to search in - * @param handler the callback to use while iterating over the people + * @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( @@ -95,7 +95,7 @@ public interface UsageDAO * Iterate over all person nodes to get users with a calculated usage * * @param storeRef the store to search in - * @param handler the callback to use while iterating over the people + * @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( diff --git a/source/java/org/alfresco/repo/download/ZipDownloadExporter.java b/source/java/org/alfresco/repo/download/ZipDownloadExporter.java index 199cb25f64..c32bc815c7 100644 --- a/source/java/org/alfresco/repo/download/ZipDownloadExporter.java +++ b/source/java/org/alfresco/repo/download/ZipDownloadExporter.java @@ -80,13 +80,14 @@ public class ZipDownloadExporter extends BaseExporter /** * Construct * - * @param destDir * @param zipFile - * @param transactionHelper - * @param l - * @param actionedUponNodeRef - * @param dataFile - * @param contentDir + * @param checkOutCheckInService + * @param transactionHelper + * @param updateService + * @param downloadStorage + * @param downloadNodeRef + * @param total + * @param totalFileCount */ 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/FileExportPackageHandler.java b/source/java/org/alfresco/repo/exporter/FileExportPackageHandler.java index b4a650bd04..0a9b84e25d 100644 --- a/source/java/org/alfresco/repo/exporter/FileExportPackageHandler.java +++ b/source/java/org/alfresco/repo/exporter/FileExportPackageHandler.java @@ -50,13 +50,13 @@ public class FileExportPackageHandler /** * Constuct Handler - * - * @param destDir destination directory - * @param dataFile filename of data file (relative to destDir) - * @param packageDir directory for content (relative to destDir) - * @param overwrite force overwrite of existing package directory - * @param mimetypeService (optional) mimetype service - */ + * + * @param destDir destination directory + * @param dataFile filename of data file (relative to destDir) + * @param contentDir directory for content (relative to destDir) + * @param overwrite force overwrite of existing package directory + * @param mimetypeService (optional) mimetype service + */ public FileExportPackageHandler(File destDir, File dataFile, File contentDir, boolean overwrite, MimetypeService mimetypeService) { this.contentDir = contentDir; diff --git a/source/java/org/alfresco/repo/exporter/RepositoryExporterComponent.java b/source/java/org/alfresco/repo/exporter/RepositoryExporterComponent.java index 5e16dad56d..9a7879cfab 100644 --- a/source/java/org/alfresco/repo/exporter/RepositoryExporterComponent.java +++ b/source/java/org/alfresco/repo/exporter/RepositoryExporterComponent.java @@ -182,8 +182,10 @@ public class RepositoryExporterComponent implements RepositoryExporterService * Add a file system based .acp file into the repository * * @param repoDestination location within repository to place .acp file - * @param packageName acp package name - * @param packageDescription acp package description + * @param name name + * @param title title + * @param description description + * @param mimeType mime type * @param exportFile the .acp file * @return node reference to import .acp file */ @@ -251,8 +253,8 @@ public class RepositoryExporterComponent implements RepositoryExporterService /** * Enumerate list of pre-configured Stores and export one by one * - * @param type of export file handle * @param stores the list of stores to export + * @param packageName package name * @param exportStore the exporter call-back for handling the actual export * @return the list export file handles */ diff --git a/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java b/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java index f979084dfb..0b932ec83b 100644 --- a/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java +++ b/source/java/org/alfresco/repo/exporter/ViewXMLExporter.java @@ -800,7 +800,7 @@ import org.xml.sax.helpers.AttributesImpl; /** * Get the prefix for the specified URI - * @param uri the URI + * @param qname the QName * @return the prefix (or null, if one is not registered) */ private String toPrefixString(QName qname) diff --git a/source/java/org/alfresco/repo/forms/AssociationFieldDefinition.java b/source/java/org/alfresco/repo/forms/AssociationFieldDefinition.java index b5d6f8ba05..09e4441f52 100644 --- a/source/java/org/alfresco/repo/forms/AssociationFieldDefinition.java +++ b/source/java/org/alfresco/repo/forms/AssociationFieldDefinition.java @@ -107,7 +107,7 @@ public class AssociationFieldDefinition extends FieldDefinition /** * Sets whether multiple targets can be selected * - * @param targetMany true if multiple targets can be selected + * @param endpointMany true if multiple targets can be selected */ public void setEndpointMany(boolean endpointMany) { diff --git a/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java b/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java index ab5b8b704a..c012766aa4 100644 --- a/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java +++ b/source/java/org/alfresco/repo/forms/processor/FilteredFormProcessor.java @@ -202,7 +202,7 @@ public abstract class FilteredFormProcessor extends Abstr /** * Generates a list of default fields to add if no field names are specified. * @param data Used for field creation. - * @param ignoredFields TODO + * @param fieldsToIgnore TODO * @return a {@link List} of {@link Field Fields} which may be empty. */ protected List generateDefaultFields(FormCreationData data, List fieldsToIgnore) 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 60c0fb98ba..a39130aafe 100644 --- a/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java +++ b/source/java/org/alfresco/repo/forms/processor/workflow/TaskFormProcessor.java @@ -174,7 +174,7 @@ public class TaskFormProcessor extends AbstractWorkflowFormProcessor listComments(NodeRef discussableNode, PagingRequest paging); diff --git a/source/java/org/alfresco/repo/i18n/MessageService.java b/source/java/org/alfresco/repo/i18n/MessageService.java index b0d3e3fa41..c38f648afc 100644 --- a/source/java/org/alfresco/repo/i18n/MessageService.java +++ b/source/java/org/alfresco/repo/i18n/MessageService.java @@ -93,26 +93,26 @@ public interface MessageService extends TenantDeployer, MessageLookup * eg, alfresco/messages/errors * or, workspace://SpaceStore/app:company_home/app:dictionary/app:labels/cm:errors *

    - * Once registered the messages will be available via getMessage, assuming the - * bundle resource exists at the given path location. - * - * @param bundleBaseName 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 bundleBaseName 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 * diff --git a/source/java/org/alfresco/repo/imap/AbstractImapFolder.java b/source/java/org/alfresco/repo/imap/AbstractImapFolder.java index 997e05bdfc..beb603ec22 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 The parameter instance to check. - * @param 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."); diff --git a/source/java/org/alfresco/repo/imap/AbstractMimeMessage.java b/source/java/org/alfresco/repo/imap/AbstractMimeMessage.java index a4c38ba0e9..c6e95311b4 100644 --- a/source/java/org/alfresco/repo/imap/AbstractMimeMessage.java +++ b/source/java/org/alfresco/repo/imap/AbstractMimeMessage.java @@ -102,14 +102,14 @@ public abstract class AbstractMimeMessage extends MimeMessage * @throws MessagingException */ public abstract void buildMessageInternal() throws MessagingException; - - /** - * Method that checks mandatory parameter. - * @param The parameter instance to check. - * @param 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."); @@ -184,13 +184,12 @@ public abstract class AbstractMimeMessage extends MimeMessage imapService.setFlags(messageFileInfo, flags, value); } - /** - * Returns the text representing email body for ContentModel node. - * - * @param nodeRef NodeRef of the target content. - * @param type The type of the returned body. May be the one of {@link EmailBodyFormat}. - * @return Text representing email body for ContentModel node. - */ + /** + * Returns the text representing email body for ContentModel node. + * + * @param type The type of the returned body. May be the one of {@link EmailBodyFormat}. + * @return Text representing email body for ContentModel node. + */ public String getEmailBodyText(EmailBodyFormat type) { return serviceRegistry.getTemplateService().processTemplate( diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java b/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java index 49f242a166..349cd2dbbc 100644 --- a/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java +++ b/source/java/org/alfresco/repo/imap/AlfrescoImapFolder.java @@ -138,18 +138,21 @@ public class AlfrescoImapFolder extends AbstractImapFolder implements Serializab } - /** - * Constructs {@link AlfrescoImapFolder} object. - * - * @param qualifiedMailboxName - name of the mailbox (e.g. "admin" for admin user). - * @param folderInfo - reference to the {@link FileInfo} object representing the folder. - * @param folderName - name of the folder. - * @param viewMode - defines view mode. Can be one of the following: {@link AlfrescoImapConst#MODE_ARCHIVE} or {@link AlfrescoImapConst#MODE_VIRTUAL}. - * @param rootNodeRef - reference to the root node of the store where folder is placed. - * @param mountPointName - name 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 + * @param imapService + * @param serviceRegistry + * @param mountPointId - id of the mount point. + */ + public AlfrescoImapFolder( + FileInfo folderInfo, String userName, String folderName, String folderPath, @@ -162,20 +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 qualifiedMailboxName - name of the mailbox (e.g. "admin" for admin user). - * @param folderInfo - reference to the {@link FileInfo} object representing the folder. - * @param folderName - name of the folder. - * @param viewMode - defines view mode. Can be one of the following: {@link AlfrescoImapConst#MODE_ARCHIVE} or {@link AlfrescoImapConst#MODE_VIRTUAL}. - * @param rootNodeRef - reference to the root node of the store where folder is placed. - * @param mountPointName - name of the mount point. - * @param imapService - the IMAP service. - * @param selectable - defines whether the folder is selectable or not. - */ - 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 + * @param selectable - defines whether the folder is selectable or not. + * @param extractAttachmentsEnabled + * @param mountPointId + */ + public AlfrescoImapFolder( + FileInfo folderInfo, String userName, String folderName, String folderPath, diff --git a/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java b/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java index 5e8508487c..c623411a1b 100644 --- a/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java +++ b/source/java/org/alfresco/repo/imap/AlfrescoImapUserManager.java @@ -99,13 +99,13 @@ public class AlfrescoImapUserManager extends UserManager } } - /** - * The login method. - * - * @see com.icegreen.greenmail.imap.commands.LoginCommand#doProcess() - */ - public boolean test(String userid, String password) - { + /** + * 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) + { try { authenticationService.authenticate(userid, password.toCharArray()); diff --git a/source/java/org/alfresco/repo/imap/AttachmentsExtractor.java b/source/java/org/alfresco/repo/imap/AttachmentsExtractor.java index 8e7e8bc668..6cef973586 100644 --- a/source/java/org/alfresco/repo/imap/AttachmentsExtractor.java +++ b/source/java/org/alfresco/repo/imap/AttachmentsExtractor.java @@ -201,13 +201,13 @@ public class AttachmentsExtractor } /** - * Create an attachment given a mime part - * - * @param messageFile the file containing the message - * @param destinationFolder where to put the attachment - * @param part the mime part - * @throws MessagingException - * @throws IOException + * Create an attachment given a mime part + * + * @param messageFile the file containing the message + * @param attachmentsFolderRef where to put the attachment + * @param part the mime part + * @throws MessagingException + * @throws IOException */ private void createAttachment(NodeRef messageFile, NodeRef attachmentsFolderRef, Part part) throws MessagingException, IOException { diff --git a/source/java/org/alfresco/repo/imap/ContentModelMessage.java b/source/java/org/alfresco/repo/imap/ContentModelMessage.java index 968aae4e4c..95fc080e95 100644 --- a/source/java/org/alfresco/repo/imap/ContentModelMessage.java +++ b/source/java/org/alfresco/repo/imap/ContentModelMessage.java @@ -63,13 +63,12 @@ public class ContentModelMessage extends AbstractMimeMessage } } - /** - * This method builds {@link MimeMessage} based on {@link ContentModel} - * - * @param fileInfo - Source file information {@link FileInfo} - * @throws MessagingException - */ - private void buildContentModelMessage() throws MessagingException + /** + * This method builds {@link MimeMessage} based on {@link ContentModel} + * + * @throws MessagingException + */ + private void buildContentModelMessage() throws MessagingException { Map properties = messageFileInfo.getProperties(); String prop = null; @@ -94,13 +93,12 @@ public class ContentModelMessage extends AbstractMimeMessage setContent(buildContentModelMultipart()); } - /** - * This method builds {@link Multipart} based on {@link ContentModel} - * - * @param fileInfo - Source file information {@link FileInfo} - * @throws MessagingException - */ - private Multipart buildContentModelMultipart() throws MessagingException + /** + * This method builds {@link Multipart} based on {@link ContentModel} + * + * @throws MessagingException + */ + private Multipart buildContentModelMultipart() throws MessagingException { MimeMultipart rootMultipart = new AlfrescoMimeMultipart("alternative", this.messageFileInfo); // Cite MOB-395: "email agent will be used to select an appropriate template" - we are not able to @@ -224,13 +222,12 @@ public class ContentModelMessage extends AbstractMimeMessage * * Last Step : Use the default address. * - * Content Author name if provided. If name not specified, it takes Content Creator name. - * If content creator does not exists, the default from address will be returned. - * - * @param contentAuthor The content author full name. - * @return Generated InternetAddress[] array. - * @throws AddressException - */ + * Content Author name if provided. If name not specified, it takes Content Creator name. + * If content creator does not exists, the default from address will be returned. + * + * @return Generated InternetAddress[] array. + * @throws AddressException + */ private InternetAddress[] buildSenderFromAddress() throws AddressException { // Generate FROM address (Content author) diff --git a/source/java/org/alfresco/repo/imap/ImapModelMessage.java b/source/java/org/alfresco/repo/imap/ImapModelMessage.java index 64f175658b..3e88d61ae4 100644 --- a/source/java/org/alfresco/repo/imap/ImapModelMessage.java +++ b/source/java/org/alfresco/repo/imap/ImapModelMessage.java @@ -41,13 +41,13 @@ import org.alfresco.service.cmr.repository.ContentService; public class ImapModelMessage extends AbstractMimeMessage { /** - * Constructs {@link ImapModelMessage} object. - * - * @param fileInfo - reference to the {@link FileInfo} object representing the message. - * @param imapHelper - reference to the {@link ImapHelper} object. - * @param generateBody - if {@code true} message body will be generated. - * - * @throws MessagingException if generation of the body fails. + * Constructs {@link ImapModelMessage} object. + * + * @param fileInfo - reference to the {@link FileInfo} object representing the message. + * @param serviceRegistry - serviceRegistry object. + * @param generateBody - if {@code true} message body will be generated. + * + * @throws MessagingException if generation of the body fails. */ public ImapModelMessage(FileInfo fileInfo, ServiceRegistry serviceRegistry, boolean generateBody) throws MessagingException { @@ -64,13 +64,12 @@ public class ImapModelMessage extends AbstractMimeMessage } } - /** - * This method builds MimeMessage based on either ImapModel or ContentModel type. - * - * @param fileInfo - Source file information {@link FileInfo} - * @throws MessagingException - */ - private void buildImapMessage() throws MessagingException + /** + * This method builds MimeMessage based on either ImapModel or ContentModel type. + * + * @throws MessagingException + */ + private void buildImapMessage() throws MessagingException { modified = false; saved = false; diff --git a/source/java/org/alfresco/repo/imap/ImapService.java b/source/java/org/alfresco/repo/imap/ImapService.java index 70e1d301ab..0335581dbd 100644 --- a/source/java/org/alfresco/repo/imap/ImapService.java +++ b/source/java/org/alfresco/repo/imap/ImapService.java @@ -189,15 +189,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 namePattern name pattern for search - * @param viewMode (ARCHIVE, MIXED or VIRTUAL) - * @param includeSubFolders includeSubFolders - * @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 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); /** * Gets a cached MIME message for the given file, complete with message body. @@ -222,30 +221,30 @@ public interface ImapService */ public void expungeMessage(FileInfo messageFileInfo); - /** - * Return flags that belong to the specified imap folder. - * - * @param messageInfo 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 messageInfo 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 messageInfo 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); /** @@ -277,13 +276,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 + */ + public String getDefaultEmailBodyTemplate(EmailBodyFormat type); /** * Get the node's site container if it belongs to Sites. diff --git a/source/java/org/alfresco/repo/imap/IncomingImapMessage.java b/source/java/org/alfresco/repo/imap/IncomingImapMessage.java index c06a8c9dc4..95d22f3ee4 100644 --- a/source/java/org/alfresco/repo/imap/IncomingImapMessage.java +++ b/source/java/org/alfresco/repo/imap/IncomingImapMessage.java @@ -58,13 +58,13 @@ public class IncomingImapMessage extends AbstractMimeMessage private Log logger = LogFactory.getLog(IncomingImapMessage.class); private ContentReader contentReader; /** - * Constructs {@link IncomingImapMessage} object based on {@link MimeMessage} - * - * @param fileInfo - reference to the {@link FileInfo} object representing the message. - * @param imapHelper - reference to the {@link ImapHelper} object. - * @param message - {@link MimeMessage} - * @throws MessagingException - */ + * Constructs {@link IncomingImapMessage} object based on {@link MimeMessage} + * + * @param fileInfo - reference to the {@link FileInfo} object representing the message. + * @param serviceRegistry - reference to serviceRegistry object. + * @param message - {@link MimeMessage} + * @throws MessagingException + */ public IncomingImapMessage(FileInfo fileInfo, ServiceRegistry serviceRegistry, MimeMessage message) throws MessagingException { super(Session.getDefaultInstance(new Properties())); diff --git a/source/java/org/alfresco/repo/imap/config/ImapConfigMountPointsBean.java b/source/java/org/alfresco/repo/imap/config/ImapConfigMountPointsBean.java index 7b7660b514..a9903d4a28 100644 --- a/source/java/org/alfresco/repo/imap/config/ImapConfigMountPointsBean.java +++ b/source/java/org/alfresco/repo/imap/config/ImapConfigMountPointsBean.java @@ -69,13 +69,13 @@ public class ImapConfigMountPointsBean extends RepositoryFolderConfigBean /** * Sets the mode. - * - * @param mode - * the new mode (virtual or archive) - * @see MountPointMode - */ - public void setModeName(String mode) - { + * + * @param mode + * the new mode (virtual or archive) + * @see ImapViewMode + */ + public void setModeName(String mode) + { this.mode = ImapViewMode.valueOf(mode); } diff --git a/source/java/org/alfresco/repo/importer/ACPImportPackageHandler.java b/source/java/org/alfresco/repo/importer/ACPImportPackageHandler.java index 3fe4ad3c48..b22b0f5bd0 100644 --- a/source/java/org/alfresco/repo/importer/ACPImportPackageHandler.java +++ b/source/java/org/alfresco/repo/importer/ACPImportPackageHandler.java @@ -48,15 +48,15 @@ public class ACPImportPackageHandler protected String dataFileEncoding; - /** - * Constuct Handler - * - * @param sourceDir source directory - * @param packageDir relative directory within source to place exported content - */ - public ACPImportPackageHandler(File zipFile, String dataFileEncoding) - { - this.file = zipFile; + /** + * Constuct Handler + * + * @param zipFile source file + * @param dataFileEncoding encoding of file + */ + public ACPImportPackageHandler(File zipFile, String dataFileEncoding) + { + this.file = zipFile; this.dataFileEncoding = dataFileEncoding; } diff --git a/source/java/org/alfresco/repo/importer/Importer.java b/source/java/org/alfresco/repo/importer/Importer.java index f6b7cf734d..fee5af740d 100644 --- a/source/java/org/alfresco/repo/importer/Importer.java +++ b/source/java/org/alfresco/repo/importer/Importer.java @@ -83,13 +83,13 @@ public interface Importer */ public NodeRef resolvePath(String path); - /** - * Is excluded Content Model Class? - * - * @param QName the class name to test - * @return true => the provided class is excluded from import - */ - public boolean isExcludedClass(QName className); + /** + * Is excluded Content Model Class? + * + * @param className the class name to test + * @return true => the provided class is excluded from import + */ + public boolean isExcludedClass(QName className); /** * Signal completion of node import diff --git a/source/java/org/alfresco/repo/importer/ImporterBootstrap.java b/source/java/org/alfresco/repo/importer/ImporterBootstrap.java index e4f43774ac..973b5a61d8 100644 --- a/source/java/org/alfresco/repo/importer/ImporterBootstrap.java +++ b/source/java/org/alfresco/repo/importer/ImporterBootstrap.java @@ -1,19 +1,19 @@ /* * Copyright (C) 2005-2013 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.importer; @@ -38,7 +38,7 @@ import org.springframework.extensions.surf.util.I18NUtil; import org.alfresco.repo.security.authentication.AuthenticationContext; import org.alfresco.repo.security.authentication.AuthenticationUtil; import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.StoreRef; @@ -87,7 +87,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean private UUID_BINDING uuidBinding = null; // Dependencies private TransactionService transactionService; - private RetryingTransactionHelper retryingTransactionHelper; + private RetryingTransactionHelper retryingTransactionHelper; private NamespaceService namespaceService; private NodeService nodeService; private ImporterService importerService; @@ -137,31 +137,31 @@ public class ImporterBootstrap extends AbstractLifecycleBean public void setUuidBinding(UUID_BINDING uuidBinding) { this.uuidBinding = uuidBinding; - } - + } + /** * Sets the Transaction Service * - * @param userTransaction the transaction service + * @param transactionService the transaction service */ public void setTransactionService(TransactionService transactionService) { this.transactionService = transactionService; } - + + /** + * Sets the retrying transaction helper specific to the importer bootstrap. This transaction helper's parameters are + * tuned to the longer-running import transaction. + * + * @param retryingTransactionHelper + * the retrying transaction helper + */ + public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper) + { + this.retryingTransactionHelper = retryingTransactionHelper; + } + /** - * Sets the retrying transaction helper specific to the importer bootstrap. This transaction helper's parameters are - * tuned to the longer-running import transaction. - * - * @param retryingTransactionHelper - * the retrying transaction helper - */ - public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper) - { - this.retryingTransactionHelper = retryingTransactionHelper; - } - - /** * Sets the namespace service * * @param namespaceService the namespace service @@ -323,7 +323,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean public void bootstrap() { PropertyCheck.mandatory(this, "transactionService", transactionService); - PropertyCheck.mandatory(this, "retryingTransactionHelper", retryingTransactionHelper); + PropertyCheck.mandatory(this, "retryingTransactionHelper", retryingTransactionHelper); PropertyCheck.mandatory(this, "namespaceService", namespaceService); PropertyCheck.mandatory(this, "nodeService", nodeService); PropertyCheck.mandatory(this, "importerService", importerService); @@ -352,7 +352,7 @@ public class ImporterBootstrap extends AbstractLifecycleBean return null; } }; - return retryingTransactionHelper.doInTransaction(doImportCallback, transactionService.isReadOnly(), false); + return retryingTransactionHelper.doInTransaction(doImportCallback, transactionService.isReadOnly(), false); } }; AuthenticationUtil.runAs(importRunAs, authenticationContext.getSystemUserName()); diff --git a/source/java/org/alfresco/repo/importer/ImporterComponent.java b/source/java/org/alfresco/repo/importer/ImporterComponent.java index 82dc73237b..9690b4ed07 100644 --- a/source/java/org/alfresco/repo/importer/ImporterComponent.java +++ b/source/java/org/alfresco/repo/importer/ImporterComponent.java @@ -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 inputStream the input stream to import from - * @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) { @@ -766,13 +766,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 contentData 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 +1083,13 @@ public class ImporterComponent implements ImporterService return classNames; } - /** - * Bind properties - * - * @param properties - * @return - */ - @SuppressWarnings("unchecked") + /** + * Bind properties + * + * @param context + * @return + */ + @SuppressWarnings("unchecked") private Map bindProperties(ImportNode context) { Map properties = context.getProperties(); @@ -1141,13 +1141,13 @@ public class ImporterComponent implements ImporterService return boundProperties; } - /** - * Bind permissions - binds authorities - * - * @param properties - * @return - */ - private List bindPermissions(List permissions) + /** + * Bind permissions - binds authorities + * + * @param permissions + * @return + */ + private List bindPermissions(List permissions) { List boundPermissions = new ArrayList(permissions.size()); @@ -1285,13 +1285,12 @@ public class ImporterComponent implements ImporterService } } - /** - * Helper to report node created progress - * - * @param progress - * @param childAssocRef - */ - private void reportNodeCreated(ChildAssociationRef childAssocRef) + /** + * Helper to report node created progress + * + * @param childAssocRef + */ + private void reportNodeCreated(ChildAssociationRef childAssocRef) { if (progress != null) { @@ -1299,27 +1298,28 @@ public class ImporterComponent implements ImporterService } } - /** - * Helper to report node linked progress - * - * @param progress - * @param childAssocRef - */ - private void reportNodeLinked(NodeRef childRef, NodeRef parentRef, QName assocType, QName childName) - { + /** + * 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) + { if (progress != null) { progress.nodeLinked(childRef, parentRef, assocType, childName); } } - /** - * Helper to report content created progress - * - * @param progress - * @param nodeRef - * @param sourceUrl - */ + /** + * Helper to report content created progress + * + * @param nodeRef + * @param sourceUrl + */ private void reportContentCreated(NodeRef nodeRef, String sourceUrl) { if (progress != null) @@ -1328,13 +1328,12 @@ public class ImporterComponent implements ImporterService } } - /** - * Helper to report aspect added progress - * - * @param progress - * @param nodeRef - * @param aspect - */ + /** + * Helper to report aspect added progress + * + * @param nodeRef + * @param aspect + */ private void reportAspectAdded(NodeRef nodeRef, QName aspect) { if (progress != null) @@ -1343,13 +1342,12 @@ public class ImporterComponent implements ImporterService } } - /** - * Helper to report property set progress - * - * @param progress - * @param nodeRef - * @param properties - */ + /** + * Helper to report property set progress + * + * @param nodeRef + * @param properties + */ private void reportPropertySet(NodeRef nodeRef, Map properties) { if (progress != null && properties != null) @@ -1387,13 +1385,13 @@ public class ImporterComponent implements ImporterService // force allocation of new UUID, even if one already specified private boolean assignNewUUID; - /** - * Construct - * - * @param newUUID force allocation of new UUID - */ - public CreateNewNodeImporterStrategy(boolean assignNewUUID) - { + /** + * Construct + * + * @param assignNewUUID force allocation of new UUID + */ + public CreateNewNodeImporterStrategy(boolean assignNewUUID) + { this.assignNewUUID = assignNewUUID; } diff --git a/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java b/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java index 1c5b322d96..9ca60a3ef4 100644 --- a/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java +++ b/source/java/org/alfresco/repo/importer/system/SystemInfoBootstrap.java @@ -52,7 +52,7 @@ public class SystemInfoBootstrap extends AbstractLifecycleBean /** * Sets the Transaction Service * - * @param userTransaction the transaction service + * @param transactionService the transaction service */ public void setTransactionService(TransactionService transactionService) { diff --git a/source/java/org/alfresco/repo/importer/view/ElementContext.java b/source/java/org/alfresco/repo/importer/view/ElementContext.java index c73528a9dc..1f454b04bb 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 dictionary - * @param elementName - * @param progress - */ - public ElementContext(QName elementName, DictionaryService dictionary, Importer importer) - { + /** + * Construct + * + * @param elementName + * @param dictionary + * @param 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 1bdd276505..7a3d0cdda6 100644 --- a/source/java/org/alfresco/repo/importer/view/MetaDataContext.java +++ b/source/java/org/alfresco/repo/importer/view/MetaDataContext.java @@ -36,14 +36,13 @@ public class MetaDataContext extends ElementContext /** - * Construct - * - * @param elementName - * @param dictionary - * @param importer - */ - public MetaDataContext(QName elementName, ElementContext context) - { + * Construct + * + * @param elementName + * @param context + */ + public MetaDataContext(QName elementName, ElementContext context) + { super(elementName, context.getDictionaryService(), context.getImporter()); } diff --git a/source/java/org/alfresco/repo/importer/view/NodeItemContext.java b/source/java/org/alfresco/repo/importer/view/NodeItemContext.java index a940d027fa..df75f82d4a 100644 --- a/source/java/org/alfresco/repo/importer/view/NodeItemContext.java +++ b/source/java/org/alfresco/repo/importer/view/NodeItemContext.java @@ -31,15 +31,14 @@ public class NodeItemContext extends ElementContext { private NodeContext nodeContext; - /** - * Construct - * - * @param elementName - * @param dictionary - * @param importer - */ - public NodeItemContext(QName elementName, NodeContext nodeContext) - { + /** + * Construct + * + * @param elementName QName + * @param nodeContext NodeContext + */ + public NodeItemContext(QName elementName, NodeContext nodeContext) + { super(elementName, nodeContext.getDictionaryService(), nodeContext.getImporter()); this.nodeContext = nodeContext; } diff --git a/source/java/org/alfresco/repo/importer/view/ParentContext.java b/source/java/org/alfresco/repo/importer/view/ParentContext.java index f1eabdf51c..3748a807fa 100644 --- a/source/java/org/alfresco/repo/importer/view/ParentContext.java +++ b/source/java/org/alfresco/repo/importer/view/ParentContext.java @@ -46,18 +46,16 @@ public class ParentContext extends ElementContext private QName assocType; - /** - * Construct - * - * @param dictionary - * @param configuration - * @param progress - * @param elementName - * @param parentRef - * @param assocType - */ - public ParentContext(QName elementName, DictionaryService dictionary, Importer importer) - { + /** + * Construct + * + * @param elementName + * @param dictionary + * @param elementName + * @param importer + */ + public ParentContext(QName elementName, DictionaryService dictionary, Importer importer) + { super(elementName, dictionary, importer); parentRef = importer.getRootRef(); assocType = importer.getRootAssocType(); @@ -77,13 +75,13 @@ public class ParentContext extends ElementContext /** * Construct - * - * @param elementName - * @param parent - * @param childDef - */ - public ParentContext(QName elementName, NodeContext parent, AssociationDefinition assocDef) - { + * + * @param elementName + * @param parent + * @param assocDef + */ + 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 405718bc35..067b837e9c 100644 --- a/source/java/org/alfresco/repo/importer/view/ViewParser.java +++ b/source/java/org/alfresco/repo/importer/view/ViewParser.java @@ -208,7 +208,7 @@ public class ViewParser implements Parser * Process start of xml element * * @param xpp - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -344,11 +344,7 @@ public class ViewParser implements Parser * Process Root * * @param xpp - * @param parentRef - * @param childAssocType - * @param configuration - * @param progress - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -367,7 +363,7 @@ public class ViewParser implements Parser * * @param xpp * @param metaDataName - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -398,7 +394,7 @@ public class ViewParser implements Parser * * @param xpp * @param typeDef - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -432,8 +428,8 @@ public class ViewParser implements Parser * Process start reference * * @param xpp - * @param typeDef - * @param contextStack + * @param refName + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -512,7 +508,7 @@ public class ViewParser implements Parser * * @param xpp * @param aspectDef - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -536,7 +532,7 @@ public class ViewParser implements Parser * Process ACL definition * * @param xpp - * @param contextStack + * @param parserContext */ private void processACL(XmlPullParser xpp, ParserContext parserContext) { @@ -557,7 +553,7 @@ public class ViewParser implements Parser * Process ACE definition * * @param xpp - * @param contextStack + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -652,8 +648,8 @@ public class ViewParser implements Parser * Process property definition * * @param xpp - * @param propDef - * @param contextStack + * @param propertyName + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -824,8 +820,8 @@ public class ViewParser implements Parser * Process start of association definition * * @param xpp - * @param AssocDef - * @param contextStack + * @param assocDef + * @param parserContext * @throws XmlPullParserException * @throws IOException */ @@ -847,7 +843,7 @@ public class ViewParser implements Parser * Process end of xml element * * @param xpp - * @param contextStack + * @param parserContext */ private void processEndElement(XmlPullParser xpp, ParserContext parserContext) { @@ -890,7 +886,8 @@ public class ViewParser implements Parser /** * Process end of the child association * - * @param context + * @param parserContext + * @param parent */ private void processEndAssoc(ParserContext parserContext, ParentContext parent) { diff --git a/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java b/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java index ca9bac1e1e..88b6ed79a2 100644 --- a/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java +++ b/source/java/org/alfresco/repo/invitation/InvitationServiceImpl.java @@ -179,14 +179,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli } /** - * Start the invitation process for a NominatedInvitation - * - * @param inviteeUserName Alfresco user name of the invitee - * @param Invitation - * @param ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param serverPath + * 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 * @return the nominated invitation which will contain the invitationId and @@ -213,14 +212,13 @@ 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 Invitation - * @param ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param acceptUrl + * 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 * @return the nominated invitation which will contain the invitationId and * ticket which will uniqely identify this invitation for the rest @@ -249,15 +247,14 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli /** * Start the invitation process for a NominatedInvitation * - * @param inviteeFirstName - * @param inviteeLastName - * @param inviteeEmail - * @param inviteeUserName optional Alfresco user name of the invitee, null - * if not on system. - * @param Invitation .ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param acceptUrl + * @param inviteeFirstName + * @param inviteeLastName + * @param inviteeEmail + * @param inviteeEmail + * @param resourceType Invitation.ResourceType + * @param resourceName + * @param inviteeRole + * @param acceptUrl * @param rejectUrl * @return the nominated invitation which will contain the invitationId and * ticket which will uniqely identify this invitation for the rest @@ -277,15 +274,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli /** * Start the invitation process for a NominatedInvitation * - * @param inviteeFirstName - * @param inviteeLastName - * @param inviteeEmail - * @param inviteeUserName optional Alfresco user name of the invitee, null - * if not on system. - * @param Invitation .ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param serverPath + * @param inviteeFirstName + * @param inviteeLastName + * @param inviteeEmail + * @param resourceType + * @param resourceName + * @param inviteeRole + * @param serverPath * @param acceptUrl * @param rejectUrl * @return the nominated invitation which will contain the invitationId and @@ -321,15 +316,15 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli throw new InvitationException("unknown resource type"); } - /** - * Start the invitation process for a ModeratedInvitation - * - * @param comments why does the invitee want access to the resource ? - * @param inviteeUserName who is to be invited - * @param Invitation .ResourceType 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) { @@ -400,13 +395,13 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli } } - /** - * Moderator approves this invitation - * - * @param request the request to approve - * @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); @@ -1225,20 +1220,22 @@ public class InvitationServiceImpl implements InvitationService, NodeServicePoli } /** - * Starts the Invite workflow - * - * @param inviteeFirstName first name of invitee - * @param inviteeLastNamme 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 - */ - 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) { @@ -1535,13 +1532,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 - * @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); diff --git a/source/java/org/alfresco/repo/invitation/InviteHelper.java b/source/java/org/alfresco/repo/invitation/InviteHelper.java index 7db89dcade..0659150f8e 100644 --- a/source/java/org/alfresco/repo/invitation/InviteHelper.java +++ b/source/java/org/alfresco/repo/invitation/InviteHelper.java @@ -184,13 +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 - * @param serviceRegistry service registry instance - * @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 @@ -232,13 +231,12 @@ 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 siteService - * @param overrideExisting - */ - public void addSiteMembership(final String invitee, final String siteName, final String role, final String runAsUser, final boolean overrideExisting) + * @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) { AuthenticationUtil.runAs(new RunAsWork() { @@ -258,15 +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 - * @param authenticationservice - * @param personService - * @param workflowService - */ - public void deleteAuthenticationIfUnused(final String inviteeUserName, final String currentInviteId) - { + * + * @param inviteeUserName + * @param currentInviteId TODO + */ + public void deleteAuthenticationIfUnused(final String inviteeUserName, final String currentInviteId) + { AuthenticationUtil.runAs(new RunAsWork() { public Object doWork() throws Exception diff --git a/source/java/org/alfresco/repo/jscript/BaseScopableProcessorExtension.java b/source/java/org/alfresco/repo/jscript/BaseScopableProcessorExtension.java index 6a3c3d1a59..6001909157 100644 --- a/source/java/org/alfresco/repo/jscript/BaseScopableProcessorExtension.java +++ b/source/java/org/alfresco/repo/jscript/BaseScopableProcessorExtension.java @@ -37,7 +37,7 @@ public class BaseScopableProcessorExtension extends BaseProcessorExtension imple /** * Set the Scriptable global scope * - * @param script relative global scope + * @param scope relative global scope */ public void setScope(Scriptable scope) { diff --git a/source/java/org/alfresco/repo/jscript/Classification.java b/source/java/org/alfresco/repo/jscript/Classification.java index abbe06e850..e1d0190e65 100644 --- a/source/java/org/alfresco/repo/jscript/Classification.java +++ b/source/java/org/alfresco/repo/jscript/Classification.java @@ -194,16 +194,12 @@ public final class Classification extends BaseScopableProcessorExtension } return qname; } - - /** - * Tag class returned from getCategoryUsage(). - * - * @param CategoryNode - * @param frequency - * @return - */ - 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/People.java b/source/java/org/alfresco/repo/jscript/People.java index cf84894842..6c5099f162 100644 --- a/source/java/org/alfresco/repo/jscript/People.java +++ b/source/java/org/alfresco/repo/jscript/People.java @@ -1134,8 +1134,7 @@ public class People extends BaseScopableProcessorExtension implements Initializi * Gets the members (people) of a group (including all sub-groups) * * @param group the group to retrieve members for - * @param recurse recurse into sub-groups - * + * * @return members of the group as a JavaScript array */ public Scriptable getMembers(ScriptNode group) diff --git a/source/java/org/alfresco/repo/jscript/Scopeable.java b/source/java/org/alfresco/repo/jscript/Scopeable.java index ce6475cffd..da0f064e95 100644 --- a/source/java/org/alfresco/repo/jscript/Scopeable.java +++ b/source/java/org/alfresco/repo/jscript/Scopeable.java @@ -33,7 +33,7 @@ public interface Scopeable /** * Set the Scriptable global scope * - * @param script relative global scope + * @param scope relative global scope */ void setScope(Scriptable scope); } diff --git a/source/java/org/alfresco/repo/jscript/ScriptNode.java b/source/java/org/alfresco/repo/jscript/ScriptNode.java index ba08ce872d..7e2aafd89d 100644 --- a/source/java/org/alfresco/repo/jscript/ScriptNode.java +++ b/source/java/org/alfresco/repo/jscript/ScriptNode.java @@ -1735,7 +1735,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider *

    * Once created the file should have content set using the content property. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the file to create * @@ -1751,7 +1751,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider *

    * Once created the file should have content set using the content property. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the file to create * @param type Type of the file to create (if null, defaults to ContentModel.TYPE_CONTENT) @@ -1776,7 +1776,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Create a new folder (cm:folder) node as a child of this node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the folder to create * @@ -1790,7 +1790,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Create a new folder (cm:folder) node as a child of this node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the folder to create * @param type Type of the folder to create (if null, defaults to ContentModel.TYPE_FOLDER) @@ -1853,7 +1853,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Create a new Node of the specified type as a child of this node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') @@ -1870,7 +1870,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Create a new Node of the specified type as a child of this node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') @@ -1922,7 +1922,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider * Creates a new secondary association between the current node and the specified child node. * The association is given the same name as the child node's primary association. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param node node to add as a child of this node */ @@ -1942,7 +1942,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider * The child node will be cascade deleted if one of the associations was the * primary association, i.e. the one with which the child node was created. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param node child node to remove */ @@ -1956,7 +1956,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Create an association between this node and the specified target node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param target Destination node for the association * @param assocType Association type qname (short form or fully qualified) @@ -1974,7 +1974,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Remove an association between this node and the specified target node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param target Destination node on the end of the association * @param assocType Association type qname (short form or fully qualified) @@ -1991,7 +1991,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Remove this node. Any references to this Node or its NodeRef should be discarded! * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * */ public boolean remove() @@ -2068,7 +2068,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider * This node must have the cm:versionable aspect. It will be checked out if required * but will be checked in after the call. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param history Version history note * @param majorVersion True to save as a major version increment, false for minor version. @@ -2113,7 +2113,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Move this Node to a new parent destination. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param destination Node * @@ -2135,7 +2135,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Move this Node from specified parent to a new parent destination. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param source Node * @param destination Node @@ -2175,7 +2175,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Add an aspect to the Node. As no properties are provided in this call, it can only be used to add aspects that do not require any mandatory properties. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * @param type Type name of the aspect to add * * @return true if the aspect was added successfully, false if an error occured. @@ -2188,7 +2188,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Add an aspect to the Node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param type Type name of the aspect to add * @param props ScriptableObject (generally an assocative array) providing the named properties for the aspect @@ -2272,7 +2272,7 @@ public class ScriptNode implements Scopeable, NamespacePrefixResolverProvider /** * Remove aspect from the node. * - * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link save()} first. + * Beware: Any unsaved property changes will be lost when this is called. To preserve property changes call {@link #save()} first. * * @param type the aspect type * diff --git a/source/java/org/alfresco/repo/jscript/Search.java b/source/java/org/alfresco/repo/jscript/Search.java index cdee78a832..6e0ba9a827 100644 --- a/source/java/org/alfresco/repo/jscript/Search.java +++ b/source/java/org/alfresco/repo/jscript/Search.java @@ -354,7 +354,7 @@ public class Search extends BaseScopableProcessorExtension implements Initializi * Execute a Lucene search (sorted) * * @param search Lucene search string to execute - * @param sortKey property name to sort on + * @param sortColumn column to sort on * @param asc true => ascending sort * * @return JavaScript array of Node results from the search - can be empty but not null @@ -379,7 +379,7 @@ public class Search extends BaseScopableProcessorExtension implements Initializi * * @param store Store reference to search against i.e. workspace://SpacesStore * @param search Lucene search string to execute - * @param sortKey property name to sort on + * @param sortColumn column to sort on * @param asc true => ascending sort * * @return JavaScript array of Node results from the search - can be empty but not null diff --git a/source/java/org/alfresco/repo/jscript/app/IgnorePropertyDecorator.java b/source/java/org/alfresco/repo/jscript/app/IgnorePropertyDecorator.java index f51175fe16..1a1da71273 100644 --- a/source/java/org/alfresco/repo/jscript/app/IgnorePropertyDecorator.java +++ b/source/java/org/alfresco/repo/jscript/app/IgnorePropertyDecorator.java @@ -33,7 +33,7 @@ import org.json.simple.JSONAware; public class IgnorePropertyDecorator extends BasePropertyDecorator { /** - * @see org.alfresco.repo.jscript.app.PropertyDecorator#decorate(org.alfresco.service.cmr.repository.NodeRef, java.io.Serializable) + * @see org.alfresco.repo.jscript.app.PropertyDecorator#decorate(QName, org.alfresco.service.cmr.repository.NodeRef, java.io.Serializable) */ public JSONAware decorate(QName propertyName, NodeRef nodeRef, Serializable value) { diff --git a/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java b/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java index 686b94b574..1339067b09 100644 --- a/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java +++ b/source/java/org/alfresco/repo/jscript/app/JSONConversionComponent.java @@ -375,7 +375,7 @@ public class JSONConversionComponent /** * * @param nodeRef - * @param map + * @param properties * @param useShortQNames * @return * @throws JSONException diff --git a/source/java/org/alfresco/repo/jscript/app/UsernamePropertyDecorator.java b/source/java/org/alfresco/repo/jscript/app/UsernamePropertyDecorator.java index 5956168f82..dbbd4e1d37 100644 --- a/source/java/org/alfresco/repo/jscript/app/UsernamePropertyDecorator.java +++ b/source/java/org/alfresco/repo/jscript/app/UsernamePropertyDecorator.java @@ -46,7 +46,7 @@ public class UsernamePropertyDecorator extends BasePropertyDecorator } /** - * @see org.alfresco.repo.jscript.app.PropertyDecorator#decorate(org.alfresco.service.cmr.repository.NodeRef, java.io.Serializable) + * @see org.alfresco.repo.jscript.app.PropertyDecorator#decorate(QName, org.alfresco.service.cmr.repository.NodeRef, java.io.Serializable) */ @SuppressWarnings("unchecked") public JSONAware decorate(QName propertyName, NodeRef nodeRef, Serializable value) diff --git a/source/java/org/alfresco/repo/lock/LockServiceImpl.java b/source/java/org/alfresco/repo/lock/LockServiceImpl.java index af30667b7c..b7f4258fdc 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, java.lang.String, 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, java.lang.String, 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, java.lang.String, 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, java.lang.String, 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, java.lang.String, 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, java.lang.String, 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, String) - */ - @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,14 +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, String, - * 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 @@ -526,14 +525,13 @@ public class LockServiceImpl implements LockService, unlock(childAssocRef.getChildRef(), unlockChildren); } } - } - - /** - * @see org.alfresco.repo.lock.LockService#unlock(Collection, - * String) - */ - 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); @@ -738,13 +736,12 @@ public class LockServiceImpl implements LockService, private String getUserName() { return this.authenticationService.getCurrentUserName(); - } - - /** - * @see org.alfresco.service.cmr.lock.LockService#getLocks() - * @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( @@ -782,13 +779,12 @@ public class LockServiceImpl implements LockService, } } return result; - } - - /** - * @see org.alfresco.service.cmr.lock.LockService#getLocks(org.alfresco.service.cmr.lock.LockType) - * @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/mem/LockState.java b/source/java/org/alfresco/repo/lock/mem/LockState.java index c7ee3a81ba..98120bd10c 100644 --- a/source/java/org/alfresco/repo/lock/mem/LockState.java +++ b/source/java/org/alfresco/repo/lock/mem/LockState.java @@ -44,13 +44,13 @@ public final class LockState implements Serializable /** * Constructor. * - * @param nodeRef - * @param lockType - * @param owner - * @param secondsToExpire - * @param additionalInfo - */ - private LockState(NodeRef nodeRef, LockType lockType, String owner, Date expires, + * @param nodeRef + * @param lockType + * @param owner + * @param expires + * @param additionalInfo + */ + private LockState(NodeRef nodeRef, LockType lockType, String owner, Date expires, Lifetime lifetime, String additionalInfo) { this.nodeRef = nodeRef; @@ -127,13 +127,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 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/mail/AlfrescoJavaMailSender.java b/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java index 257f2afa6d..a011c46310 100644 --- a/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java +++ b/source/java/org/alfresco/repo/mail/AlfrescoJavaMailSender.java @@ -48,7 +48,7 @@ public class AlfrescoJavaMailSender extends JavaMailSenderImpl private static final Logger log = LoggerFactory.getLogger(AlfrescoJavaMailSender.class); /** - * {@link KeyedPoolableObjectFactory} which uses the {@link Session} returned by {@link JavaMailSenderImpl.getSession()} to create a new + * {@link KeyedPoolableObjectFactory} which uses the {@link Session} returned by {@link JavaMailSenderImpl#getSession()} to create a new * {@link Transport}. */ private final class TransportFactory implements KeyedPoolableObjectFactory @@ -131,9 +131,9 @@ public class AlfrescoJavaMailSender extends JavaMailSenderImpl /** * Wrapper implementation of {@link Transport}, which borrows from a pool on connection, and returns to the pool on close. * - * @see AlfrescoJavaMailSender#getTranport(Session) + * @see AlfrescoJavaMailSender#getTransport(Session) */ - private static class PooledTransportWrapper extends Transport + private static class PooledTransportWrapper extends Transport { private Transport wrapped = null; private String protocol; diff --git a/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java b/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java index 4d0df432fe..71c9575350 100644 --- a/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java +++ b/source/java/org/alfresco/repo/management/SafeApplicationEventMulticaster.java @@ -55,7 +55,7 @@ import org.springframework.core.OrderComparator; * *

    * Implementing ApplicationEventMulticaster's actual {@link #multicastEvent} - * method is left to subclasses. {@link SimpleApplicationEventMulticaster} + * method is left to subclasses. {@link org.springframework.context.event.SimpleApplicationEventMulticaster} * simply multicasts all events to all registered listeners, invoking them in * the calling thread. Alternative implementations could be more sophisticated * in those respects. @@ -63,7 +63,7 @@ import org.springframework.core.OrderComparator; * @author Juergen Hoeller * @since 1.2.3 * @see #getApplicationListeners(ApplicationEvent) - * @see SimpleApplicationEventMulticaster + * @see org.springframework.context.event.SimpleApplicationEventMulticaster */ public class SafeApplicationEventMulticaster implements ApplicationEventMulticaster, ApplicationContextAware { diff --git a/source/java/org/alfresco/repo/management/subsystems/AbstractPropertyBackedBean.java b/source/java/org/alfresco/repo/management/subsystems/AbstractPropertyBackedBean.java index 823db808c9..806c7dbb3f 100644 --- a/source/java/org/alfresco/repo/management/subsystems/AbstractPropertyBackedBean.java +++ b/source/java/org/alfresco/repo/management/subsystems/AbstractPropertyBackedBean.java @@ -844,23 +844,23 @@ public abstract class AbstractPropertyBackedBean implements PropertyBackedBean, } } - /** - * Removes a property added by code within the local node. - * - * @param propertyNames to be removed. - */ - public void removeProperty(String name) - { + /** + * Removes a property added by code within the local node. + * + * @param name to be removed. + */ + public void removeProperty(String name) + { removeProperties(Collections.singleton(name)); } - /** - * Removes properties added by code within the local node. - * - * @param propertyNames to be removed. - */ - public void removeProperties(Collection properties) - { + /** + * Removes properties added by code within the local node. + * + * @param properties to be removed. + */ + public void removeProperties(Collection properties) + { if (logger.isDebugEnabled()) { logger.debug("removeProperties("+properties+")"); diff --git a/source/java/org/alfresco/repo/management/subsystems/ChainingSubsystemProxyFactory.java b/source/java/org/alfresco/repo/management/subsystems/ChainingSubsystemProxyFactory.java index ebd5762ec5..31c0d1b792 100644 --- a/source/java/org/alfresco/repo/management/subsystems/ChainingSubsystemProxyFactory.java +++ b/source/java/org/alfresco/repo/management/subsystems/ChainingSubsystemProxyFactory.java @@ -30,13 +30,13 @@ import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.context.ApplicationContext; /** - * A factory bean, used in conjunction with {@link ChildApplicationContextManager} allowing selected interfaces to be - * proxied to a chain of child application contexts. To decide the target of a particular method call, the returned - * proxy will search the application context chain in sequence and use the first one that has a bean of the required - * name or type that doesn't implement the {@link ActivatableBean} interface or whose whose - * {@link ActivateableBean#isActive()} method returns true. This allows certain functions of a chained - * subsystem (e.g. CIFS authentication, SSO) to be targeted to specific members of the chain. - */ + * A factory bean, used in conjunction with {@link ChildApplicationContextManager} allowing selected interfaces to be + * proxied to a chain of child application contexts. To decide the target of a particular method call, the returned + * proxy will search the application context chain in sequence and use the first one that has a bean of the required + * name or type that doesn't implement the {@link org.alfresco.repo.management.subsystems.ActivateableBean} interface or whose whose + * {@link ActivateableBean#isActive()} method returns true. This allows certain functions of a chained + * subsystem (e.g. CIFS authentication, SSO) to be targeted to specific members of the chain. + */ public class ChainingSubsystemProxyFactory extends ProxyFactoryBean { private static final long serialVersionUID = -2646392556551369220L; diff --git a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java index 7797c0a715..b5ff693d4a 100644 --- a/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java +++ b/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBean.java @@ -76,10 +76,10 @@ public interface PropertyBackedBean extends PropertyBackedBeanState /** * 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 properties - */ - 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 + */ + public void removeProperties(Collection attributes); +} diff --git a/source/java/org/alfresco/repo/management/subsystems/SubsystemProxyFactory.java b/source/java/org/alfresco/repo/management/subsystems/SubsystemProxyFactory.java index 7a9428443d..0084830e35 100644 --- a/source/java/org/alfresco/repo/management/subsystems/SubsystemProxyFactory.java +++ b/source/java/org/alfresco/repo/management/subsystems/SubsystemProxyFactory.java @@ -152,8 +152,8 @@ public class SubsystemProxyFactory extends ProxyFactoryBean implements Applicati * Sets an optional default bean to be used if the target bean is not found. Generally used when a subsystem does not * exist. * - * @param sourceBeanName - * the sourceBeanName to set + * @param defaultBean + * the defaultBean to set */ public void setDefaultBean(Object defaultBean) { diff --git a/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java b/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java index f6a51d5b1f..94d448aeb2 100644 --- a/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java +++ b/source/java/org/alfresco/repo/model/filefolder/FileFolderServiceImpl.java @@ -848,9 +848,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 folders return nodes of type folders. - * @param files return nodes of type files. - * @param subfolder 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 +951,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi } /** - * @see #moveOrCopy(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 +960,7 @@ public class FileFolderServiceImpl extends AbstractBaseCopyService implements Fi } /** - * @see #moveOrCopy(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 diff --git a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java index 0789ac23e1..564870a2d6 100644 --- a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java +++ b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java @@ -614,8 +614,10 @@ public class HiddenAspect /** * Hides the node by applying the hidden and not indexed aspects. The node will be hidden from all clients. * - * @param client - * @param fileInfo + * @param nodeRef nodeRef + * @param cascadeHiddenAspect + * @param cascadeIndexControlAspect + * @param clientControlled * @return */ public void hideNode(NodeRef nodeRef, boolean cascadeHiddenAspect, boolean cascadeIndexControlAspect, boolean clientControlled) diff --git a/source/java/org/alfresco/repo/module/ModuleServiceImpl.java b/source/java/org/alfresco/repo/module/ModuleServiceImpl.java index 0c54f7ee1f..10cdc2e055 100644 --- a/source/java/org/alfresco/repo/module/ModuleServiceImpl.java +++ b/source/java/org/alfresco/repo/module/ModuleServiceImpl.java @@ -1,19 +1,19 @@ /* * Copyright (C) 2005-2013 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.module; @@ -47,7 +47,7 @@ import org.springframework.core.io.support.ResourcePatternResolver; /** * This component controls the execution of - * {@link org.alfresco.repo.module.runtime.ModuleComponent module startup components}. + * {@link org.alfresco.repo.module.ModuleComponent module startup components}. *

    * All required startup executions are performed in a single transaction, so this * component guarantees that the module initialization is consistent. Module components are diff --git a/source/java/org/alfresco/repo/module/tool/ModuleDetailsHelper.java b/source/java/org/alfresco/repo/module/tool/ModuleDetailsHelper.java index bcb42b6d9f..4bb4d66404 100644 --- a/source/java/org/alfresco/repo/module/tool/ModuleDetailsHelper.java +++ b/source/java/org/alfresco/repo/module/tool/ModuleDetailsHelper.java @@ -147,13 +147,13 @@ public class ModuleDetailsHelper } /** - * Saves the module details to the war in the correct location based on the module id - * - * @param warLocation the war location - * @param moduleId the module id - */ - public static void saveModuleDetails(String warLocation, ModuleDetails moduleDetails) - { + * Saves the module details to the war in the correct location based on the module id + * + * @param warLocation the war location + * @param moduleDetails the module id + */ + public static void saveModuleDetails(String warLocation, ModuleDetails moduleDetails) + { // Ensure that it is a valid set of properties String moduleId = moduleDetails.getId(); try diff --git a/source/java/org/alfresco/repo/module/tool/ModuleManagementTool.java b/source/java/org/alfresco/repo/module/tool/ModuleManagementTool.java index 78782a0452..7a323c9c8f 100644 --- a/source/java/org/alfresco/repo/module/tool/ModuleManagementTool.java +++ b/source/java/org/alfresco/repo/module/tool/ModuleManagementTool.java @@ -178,13 +178,13 @@ public class ModuleManagementTool implements LogOutput } } - /** - * Installs a given AMP file into a given WAR file. - * - * @see ModuleManagementTool.installModule(String, String, boolean, boolean, boolean) - * - * @param ampFileLocation the location of the AMP file to be installed - * @param warFileLocation the location of the WAR file into which the AMP file is to be installed + /** + * Installs a given AMP file into a given WAR file. + * + * @see ModuleManagementTool#installModule(String, String, boolean, boolean, boolean) + * + * @param ampFileLocation the location of the AMP file to be installed + * @param warFileLocation the location of the WAR file into which the AMP file is to be installed */ public void installModule(String ampFileLocation, String warFileLocation) { diff --git a/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java b/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java index 2d834a2f35..b6b54f9789 100644 --- a/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java +++ b/source/java/org/alfresco/repo/module/tool/WarHelperImpl.java @@ -295,7 +295,7 @@ public class WarHelperImpl implements WarHelper /** * Reads a .properites file from the war and returns it as a Properties object - * @param propertiesPath Path to the properties file (including .properties) + * @param propertiesFile Path to the properties file (including .properties) * @return Properties object or null */ private Properties loadProperties(TFile propertiesFile) diff --git a/source/java/org/alfresco/repo/node/AbstractNodeServiceImpl.java b/source/java/org/alfresco/repo/node/AbstractNodeServiceImpl.java index 3a5f1ef0e9..f9e2562df3 100644 --- a/source/java/org/alfresco/repo/node/AbstractNodeServiceImpl.java +++ b/source/java/org/alfresco/repo/node/AbstractNodeServiceImpl.java @@ -187,14 +187,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService public int hashCode() { return uuid.hashCode(); - } - - /** - * Registers the node policies as well as node indexing behaviour if the - * {@link #setIndexer(Indexer) indexer} is present. - */ - public void init() - { + } + + /** + * Registers the node policies as well as node indexing behaviour + */ + public void init() + { // Register the various policies beforeCreateStoreDelegate = policyComponent.registerClassPolicy(NodeServicePolicies.BeforeCreateStorePolicy.class); onCreateStoreDelegate = policyComponent.registerClassPolicy(NodeServicePolicies.OnCreateStorePolicy.class); @@ -301,13 +300,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService // execute policy for node type and aspects NodeServicePolicies.OnCreateNodePolicy policy = onCreateNodeDelegate.get(childNodeRef, qnames); policy.onCreateNode(childAssocRef); - } - - /** - * @see NodeServicePolicies.BeforeMoveNodePolicy#onMoveNode(ChildAssociationRef, NodeRef) - */ - protected void invokeBeforeMoveNode(ChildAssociationRef oldChildAssocRef, NodeRef newParentRef) - { + } + + /** + * @see NodeServicePolicies.BeforeMoveNodePolicy#beforeMoveNode(ChildAssociationRef, NodeRef) + */ + protected void invokeBeforeMoveNode(ChildAssociationRef oldChildAssocRef, NodeRef newParentRef) + { NodeRef childNodeRef = oldChildAssocRef.getChildRef(); if (ignorePolicy(childNodeRef)) @@ -407,13 +406,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService // execute policy for node type and aspects NodeServicePolicies.BeforeSetNodeTypePolicy policy = beforeSetNodeTypeDelegate.get(nodeRef, qnames); policy.beforeSetNodeType(nodeRef, oldType, newType); - } - - /** - * @see NodeServicePolicies.OnUpdateProperties#onUpdatePropertiesPolicy(NodeRef, Map, Map) - */ - protected void invokeOnUpdateProperties( - NodeRef nodeRef, + } + + /** + * @see NodeServicePolicies.OnUpdatePropertiesPolicy#onUpdateProperties(NodeRef, Map, Map) + */ + protected void invokeOnUpdateProperties( + NodeRef nodeRef, Map before, Map after) { @@ -480,13 +479,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService // execute policy for node type and aspects NodeServicePolicies.BeforeDeleteNodePolicy policy = beforeDeleteNodeDelegate.get(nodeRef, qnames); policy.beforeDeleteNode(nodeRef); - } - - /** - * @see NodeServicePolicies.BeforeAr - */ - protected void invokeBeforeArchiveNode(NodeRef nodeRef) - { + } + + /** + * @see NodeServicePolicies.BeforeArchiveNodePolicy + */ + protected void invokeBeforeArchiveNode(NodeRef nodeRef) + { if (ignorePolicy(nodeRef)) { return; @@ -497,13 +496,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService // execute policy for node type and aspects NodeServicePolicies.BeforeArchiveNodePolicy policy = beforeArchiveNodeDelegate.get(nodeRef, qnames); policy.beforeArchiveNode(nodeRef); - } - - /** - * @see NodeServicePolicies.OnDeleteNodePolicy#onDeleteNode(ChildAssociationRef) - */ - protected void invokeOnDeleteNode(ChildAssociationRef childAssocRef, QName childNodeTypeQName, Set childAspectQnames, boolean isArchivedNode) - { + } + + /** + * @see NodeServicePolicies.OnDeleteNodePolicy#onDeleteNode(ChildAssociationRef, boolean) + */ + protected void invokeOnDeleteNode(ChildAssociationRef childAssocRef, QName childNodeTypeQName, Set childAspectQnames, boolean isArchivedNode) + { NodeRef childNodeRef = childAssocRef.getChildRef(); Set qnames = null; @@ -531,13 +530,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService NodeServicePolicies.OnDeleteNodePolicy policy = onDeleteNodeDelegate.get(childAssocRef.getChildRef(), qnames); policy.onDeleteNode(childAssocRef, isArchivedNode); } - } - - /** - * @see NodeServicePolicies.OnRestoreNodePolicy#onDeleteNode(ChildAssociationRef) - */ - protected void invokeOnRestoreNode(ChildAssociationRef childAssocRef) - { + } + + /** + * @see NodeServicePolicies.OnRestoreNodePolicy#onRestoreNode(ChildAssociationRef) + */ + protected void invokeOnRestoreNode(ChildAssociationRef childAssocRef) + { NodeRef childNodeRef = childAssocRef.getChildRef(); // get qnames to invoke against Set qnames = getTypeAndAspectQNames(childNodeRef); @@ -573,13 +572,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService NodeServicePolicies.OnAddAspectPolicy policy = onAddAspectDelegate.get(nodeRef, aspectTypeQName); policy.onAddAspect(nodeRef, aspectTypeQName); - } - - /** - * @see NodeServicePolicies.BeforeRemoveAspectPolicy#BeforeRemoveAspect(NodeRef, - * QName) - */ - protected void invokeBeforeRemoveAspect(NodeRef nodeRef, QName aspectTypeQName) + } + + /** + * @see NodeServicePolicies.BeforeRemoveAspectPolicy#beforeRemoveAspect(NodeRef, + * QName) + */ + protected void invokeBeforeRemoveAspect(NodeRef nodeRef, QName aspectTypeQName) { if (ignorePolicy(nodeRef)) { @@ -603,13 +602,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService NodeServicePolicies.OnRemoveAspectPolicy policy = onRemoveAspectDelegate.get(nodeRef, aspectTypeQName); policy.onRemoveAspect(nodeRef, aspectTypeQName); - } - - /** - * @see NodeServicePolicies.OnCreateChildAssociationPolicy#onCreateChildAssociation(ChildAssociationRef) - */ - protected void invokeOnCreateChildAssociation(ChildAssociationRef childAssocRef, boolean isNewNode) - { + } + + /** + * @see NodeServicePolicies.OnCreateChildAssociationPolicy#onCreateChildAssociation(ChildAssociationRef, boolean) + */ + protected void invokeOnCreateChildAssociation(ChildAssociationRef childAssocRef, boolean isNewNode) + { // Get the parent reference and the assoc type qName NodeRef parentNodeRef = childAssocRef.getParentRef(); @@ -664,13 +663,13 @@ public abstract class AbstractNodeServiceImpl implements NodeService // execute policy for node type and aspects NodeServicePolicies.OnDeleteChildAssociationPolicy policy = onDeleteChildAssociationDelegate.get(parentNodeRef, qnames, assocTypeQName); policy.onDeleteChildAssociation(childAssocRef); - } - - /** - * @see NodeServicePolicies.OnCreateAssociationPolicy#onCreateAssociation(NodeRef, NodeRef, QName) - */ - protected void invokeOnCreateAssociation(AssociationRef nodeAssocRef) - { + } + + /** + * @see NodeServicePolicies.OnCreateAssociationPolicy#onCreateAssociation(AssociationRef) + */ + protected void invokeOnCreateAssociation(AssociationRef nodeAssocRef) + { NodeRef sourceNodeRef = nodeAssocRef.getSourceRef(); if (ignorePolicy(sourceNodeRef)) @@ -805,13 +804,12 @@ public abstract class AbstractNodeServiceImpl implements NodeService } /** - * Sets the default property values - * - * @param classDefinition the model type definition for which to get defaults - * @param properties the properties of the node - */ - protected Map getDefaultProperties(ClassDefinition classDefinition) - { + * Sets the default property values + * + * @param classDefinition the model type definition for which to get defaults + */ + protected Map getDefaultProperties(ClassDefinition classDefinition) + { PropertyMap properties = new PropertyMap(); for (Map.Entry entry : classDefinition.getDefaultValues().entrySet()) { diff --git a/source/java/org/alfresco/repo/node/FFCLoadsOfFiles.java b/source/java/org/alfresco/repo/node/FFCLoadsOfFiles.java index 8688b883f5..69ee6df463 100644 --- a/source/java/org/alfresco/repo/node/FFCLoadsOfFiles.java +++ b/source/java/org/alfresco/repo/node/FFCLoadsOfFiles.java @@ -43,13 +43,13 @@ import org.alfresco.service.transaction.TransactionService; import org.alfresco.util.ApplicationContextHelper; import org.springframework.context.ApplicationContext; -/** - * Perform document loads and fetches of child associations in increasing numbers. - *

    - * {@link https://issues.alfresco.com/jira/browse/ETWOTWO-744} - * - * @author Derek Hulley - * @author CACEIS +/** + * Perform document loads and fetches of child associations in increasing numbers. + *

    + * ETWOTWO-744 + * + * @author Derek Hulley + * @author CACEIS * @since 2.2SP2 */ public class FFCLoadsOfFiles diff --git a/source/java/org/alfresco/repo/node/UndeletableAspect.java b/source/java/org/alfresco/repo/node/UndeletableAspect.java index aec2692f1d..f096747dc7 100644 --- a/source/java/org/alfresco/repo/node/UndeletableAspect.java +++ b/source/java/org/alfresco/repo/node/UndeletableAspect.java @@ -39,7 +39,7 @@ import org.alfresco.service.namespace.QName; * This aspect/behaviour combination allows for detailed application control of when node deletion is allowed * or disallowed for particular nodes. It is not related to the normal permissions controls, which of course apply. *

    - * An example of its usage is in the {@link SiteService}, where {@link SiteModel#TYPE_SITE} nodes are given the + * An example of its usage is in the {@link SiteService}, where {@link org.alfresco.repo.site.SiteModel#TYPE_SITE} nodes are given the * {@link ContentModel#ASPECT_UNDELETABLE} as a mandatory aspect. Therefore any attempt to delete such a node will * result in an exception. However, this behaviour is disabled within the {@link SiteService} in order to allow * site node deletion from within that service but from no other code. diff --git a/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java b/source/java/org/alfresco/repo/node/archive/NodeArchiveService.java index 5f2177f492..8ee9fad451 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 storeRef 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); diff --git a/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java b/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java index 7e2e901e95..a51472359e 100644 --- a/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java +++ b/source/java/org/alfresco/repo/node/db/DbNodeServiceImpl.java @@ -1582,7 +1582,7 @@ 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 + * @see DbNodeServiceImpl#NullPropertyValue */ public void setProperty(NodeRef nodeRef, QName qname, Serializable value) throws InvalidNodeRefException { diff --git a/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java b/source/java/org/alfresco/repo/node/db/DeletedNodeCleanupWorker.java index 86d95f79d7..69cc897109 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 txnBlockSize - */ - public void setPurgeSize(int purgeSize) - { + /** + * Set the purge transaction block size. This determines how many unused transactions are purged in one go. + * + * @param purgeSize + */ + 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 9afa4f1abf..fdd5a2c271 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 transactionComponent 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; } @@ -1239,13 +1239,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) - * @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/index/FullIndexRecoveryComponent.java b/source/java/org/alfresco/repo/node/index/FullIndexRecoveryComponent.java index d36d041906..c8872ac1b6 100644 --- a/source/java/org/alfresco/repo/node/index/FullIndexRecoveryComponent.java +++ b/source/java/org/alfresco/repo/node/index/FullIndexRecoveryComponent.java @@ -226,13 +226,13 @@ public class FullIndexRecoveryComponent extends AbstractReindexComponent /** * List transactions up to the specified amount using a sliding time based window. - * This will create smaller result sets which circumvents performance problems using - * sql LIMIT on some jdbc drivers and databases. - * - * @param windowSize the size of collection window in milliseconds. - * @param count the number of transctions to attempt to collect - * @return returns a list of transactions - */ + * This will create smaller result sets which circumvents performance problems using + * sql LIMIT on some jdbc drivers and databases. + * + * @param minWindowSize the size of collection window in milliseconds. + * @param count the number of transctions to attempt to collect + * @return returns a list of transactions + */ private List getTxnsByCommitTimeWindowDescending(final long minWindowSize, final int count) { if (minWindowSize == 0 || count == 0) { @@ -288,13 +288,13 @@ public class FullIndexRecoveryComponent extends AbstractReindexComponent /** * List transactions up to the specified amount using a sliding time based window. - * This will create smaller result sets which circumvents performance problems using - * sql LIMIT on some jdbc drivers and databases. - * - * @param windowSize the size of collection window in milliseconds. - * @param count the number of transctions to attempt to collect - * @return returns a list of transactions - */ + * This will create smaller result sets which circumvents performance problems using + * sql LIMIT on some jdbc drivers and databases. + * + * @param minWindowSize the size of collection window in milliseconds. + * @param count the number of transctions to attempt to collect + * @return returns a list of transactions + */ private List getTxnsByCommitTimeWindowAscending(final long minWindowSize, final int count) { if (minWindowSize == 0 || count == 0) { diff --git a/source/java/org/alfresco/repo/node/integrity/IntegrityRecord.java b/source/java/org/alfresco/repo/node/integrity/IntegrityRecord.java index f7c3efdf55..f923f79f34 100644 --- a/source/java/org/alfresco/repo/node/integrity/IntegrityRecord.java +++ b/source/java/org/alfresco/repo/node/integrity/IntegrityRecord.java @@ -40,13 +40,13 @@ public class IntegrityRecord implements Serializable this.traces = null; } - /** - * Add a stack trace to the list of traces associated with this failure - * - * @param trace a stack trace - */ - public void setTraces(List traces) - { + /** + * Add a stack trace to the list of traces associated with this failure + * + * @param traces a stack trace + */ + public void setTraces(List traces) + { this.traces = traces; } diff --git a/source/java/org/alfresco/repo/nodelocator/NodeLocator.java b/source/java/org/alfresco/repo/nodelocator/NodeLocator.java index fff7cdcf0b..b1e04c058d 100644 --- a/source/java/org/alfresco/repo/nodelocator/NodeLocator.java +++ b/source/java/org/alfresco/repo/nodelocator/NodeLocator.java @@ -37,13 +37,13 @@ public interface NodeLocator { /** * Finds a {@link NodeRef} given a starting {@link NodeRef} and a - * {@link Map} of parameters. - * Returns null if the specified node could not be found. - * - * @param sourceNode the starting point for locating a new node. The source node. Can be null. - * @param params an arbitrary {@link Map} of parameters.Can be null. - * @return the node to be found or null. - */ + * {@link Map} of parameters. + * Returns null if the specified node could not be found. + * + * @param source the starting point for locating a new node. The source node. Can be null. + * @param params an arbitrary {@link Map} of parameters.Can be null. + * @return the node to be found or null. + */ NodeRef getNode(NodeRef source, Map params); /** diff --git a/source/java/org/alfresco/repo/nodelocator/XPathNodeLocator.java b/source/java/org/alfresco/repo/nodelocator/XPathNodeLocator.java index fab0794e7d..e0ff54822a 100644 --- a/source/java/org/alfresco/repo/nodelocator/XPathNodeLocator.java +++ b/source/java/org/alfresco/repo/nodelocator/XPathNodeLocator.java @@ -121,7 +121,7 @@ public class XPathNodeLocator extends AbstractNodeLocator } /** - * @param defaultStore the defaultStore to set + * @param defaultStoreStr the defaultStoreStr to set */ public void setDefaultStore(String defaultStoreStr) { diff --git a/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java b/source/java/org/alfresco/repo/oauth2/OAuth2CredentialsStoreServiceImpl.java index 76b9046100..5c9d2555b5 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 refresh Token - * @param expiresAt - * @param issuedAt if null, the current Datetime will be used - * @return OAuth2CredentialsInfo + * + * @param remoteSystemId + * @param accessToken + * @param refreshToken String + * @param expiresAt + * @param issuedAt if null, the current Datetime will be used + * @return OAuth2CredentialsInfo */ @Override public OAuth2CredentialsInfo storePersonalOAuth2Credentials(String remoteSystemId, diff --git a/source/java/org/alfresco/repo/policy/JavaBehaviour.java b/source/java/org/alfresco/repo/policy/JavaBehaviour.java index 5072a3b353..43ddefc702 100644 --- a/source/java/org/alfresco/repo/policy/JavaBehaviour.java +++ b/source/java/org/alfresco/repo/policy/JavaBehaviour.java @@ -133,7 +133,7 @@ public class JavaBehaviour extends BaseBehaviour /** * Constuct. * - * @param instance the object instance holding the method + * @param behaviour the java behaviour * @param delegateMethod the method to invoke */ private JavaMethodInvocationHandler(JavaBehaviour behaviour, Method delegateMethod) diff --git a/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java b/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java index b5f6d5a0f7..343a845edc 100644 --- a/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java +++ b/source/java/org/alfresco/repo/policy/PolicyComponentImpl.java @@ -84,13 +84,12 @@ public class PolicyComponentImpl implements PolicyComponent } /** - * Construct - * - * @param dictionary dictionary service - * @param behaviourFilter behaviour filter - */ - public PolicyComponentImpl(DictionaryService dictionary) - { + * Construct + * + * @param dictionary dictionary service + */ + public PolicyComponentImpl(DictionaryService dictionary) + { this.dictionary = dictionary; this.registeredPolicies = new HashMap(); } diff --git a/source/java/org/alfresco/repo/policy/PolicyFactory.java b/source/java/org/alfresco/repo/policy/PolicyFactory.java index 8e59aebd81..05f6a048dd 100644 --- a/source/java/org/alfresco/repo/policy/PolicyFactory.java +++ b/source/java/org/alfresco/repo/policy/PolicyFactory.java @@ -74,13 +74,13 @@ import org.alfresco.service.cmr.repository.StoreRef; } - /** - * Sets the Transaction Invocation Handler - * - * @param handlerFactory - */ - protected static void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory) - { + /** + * Sets the Transaction Invocation Handler + * + * @param factory + */ + protected static void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory) + { transactionHandlerFactory = factory; } @@ -218,13 +218,13 @@ import org.alfresco.service.cmr.repository.StoreRef; { private P policyInterface; - /** - * Construct - * - * @param policyInterfaces 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 a8b1883d5f..34ee2bd502 100644 --- a/source/java/org/alfresco/repo/policy/PolicyScope.java +++ b/source/java/org/alfresco/repo/policy/PolicyScope.java @@ -127,13 +127,12 @@ public class PolicyScope extends AspectDetails } /** - * Adds a child association - * - * @param classRef - * @param qname - * @param childAssocRef - */ - public void addChildAssociation(QName classRef, ChildAssociationRef childAssocRef) + * Adds a child association + * + * @param classRef + * @param childAssocRef + */ + public void addChildAssociation(QName classRef, ChildAssociationRef childAssocRef) { if (classRef.equals(this.classRef) == true) { @@ -391,13 +390,13 @@ public class PolicyScope extends AspectDetails } /** - * Add a child association - * - * @param childAssocRef the child assoc reference - * @param alwaysDeepCopy 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) @@ -428,13 +427,12 @@ public class PolicyScope extends AspectDetails return this.childAssocs; } - /** - * Adds an association to be copied - * - * @param qname the qualified name of the association - * @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 419f5d8901..1cc02cceab 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 assocTypeQName + * @param propertyQName * @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 dd101ed353..dfaff72b41 100644 --- a/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java +++ b/source/java/org/alfresco/repo/policy/TransactionBehaviourQueue.java @@ -160,8 +160,6 @@ public class TransactionBehaviourQueue implements TransactionListener /** * Execution Instance Key - to uniquely identify an ExecutionContext - * - * @param

    */ private class ExecutionInstanceKey { diff --git a/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java b/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java index 22cc245a5e..a7d8e62719 100644 --- a/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java +++ b/source/java/org/alfresco/repo/policy/TransactionInvocationHandlerFactory.java @@ -156,8 +156,6 @@ public class TransactionInvocationHandlerFactory /** * Execution Instance Key - to uniquely identify an ExecutionContext - * - * @param

    */ private class ExecutionInstanceKey { diff --git a/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java b/source/java/org/alfresco/repo/policy/annotation/AnnotatedBehaviourPostProcessor.java index d6d2021342..38fe125bc3 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 typeName - * @return - */ - private QName resolveType(BehaviourBean behaviourBean, Behaviour behaviour) + /** + * + * @param behaviourBean + * @param behaviour + * @return + */ + private QName resolveType(BehaviourBean behaviourBean, Behaviour behaviour) { QName type = null; if (!behaviour.isService()) diff --git a/source/java/org/alfresco/repo/processor/BaseProcessorExtension.java b/source/java/org/alfresco/repo/processor/BaseProcessorExtension.java index 0ad82ca3fe..0759e40818 100644 --- a/source/java/org/alfresco/repo/processor/BaseProcessorExtension.java +++ b/source/java/org/alfresco/repo/processor/BaseProcessorExtension.java @@ -39,7 +39,7 @@ public abstract class BaseProcessorExtension implements ProcessorExtension /** * Sets the processor * - * @param scriptProcessor the processor + * @param processor the processor */ public void setProcessor(Processor processor) { @@ -57,7 +57,7 @@ public abstract class BaseProcessorExtension implements ProcessorExtension /** * Sets the extension name * - * @param extensionName the extension name + * @param extension the extension name */ public void setExtensionName(String extension) { diff --git a/source/java/org/alfresco/repo/publishing/MutablePublishingEventImpl.java b/source/java/org/alfresco/repo/publishing/MutablePublishingEventImpl.java index dc9e51c842..f923209558 100644 --- a/source/java/org/alfresco/repo/publishing/MutablePublishingEventImpl.java +++ b/source/java/org/alfresco/repo/publishing/MutablePublishingEventImpl.java @@ -27,13 +27,13 @@ import org.alfresco.service.cmr.publishing.MutablePublishingEvent; * @author Nick Smith * @since 4.0 */ -public class MutablePublishingEventImpl extends PublishingEventImpl implements MutablePublishingEvent -{ - /** - * @param publishingEventImpl - */ - public MutablePublishingEventImpl(PublishingEventImpl event) - { +public class MutablePublishingEventImpl extends PublishingEventImpl implements MutablePublishingEvent +{ + /** + * @param event PublishingEventImpl + */ + public MutablePublishingEventImpl(PublishingEventImpl event) + { super(event); } diff --git a/source/java/org/alfresco/repo/quickshare/QuickShareServiceImpl.java b/source/java/org/alfresco/repo/quickshare/QuickShareServiceImpl.java index 8867dc407c..4c1a037e8e 100644 --- a/source/java/org/alfresco/repo/quickshare/QuickShareServiceImpl.java +++ b/source/java/org/alfresco/repo/quickshare/QuickShareServiceImpl.java @@ -300,7 +300,7 @@ public class QuickShareServiceImpl implements QuickShareService, NodeServicePoli /** * Is this service enable? - * @throws uickShareDisabledException if it isn't. + * @throws QuickShareDisabledException if it isn't. */ private void checkEnabled() { diff --git a/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java b/source/java/org/alfresco/repo/rating/AbstractRatingRollupAlgorithm.java index 824e4c2ac9..cff69b131b 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 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 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 * and sorting of rating-related properties. * * @author Neil McErlean diff --git a/source/java/org/alfresco/repo/rating/RatingServiceImpl.java b/source/java/org/alfresco/repo/rating/RatingServiceImpl.java index 028a0b2f78..1efb1a1ddc 100644 --- a/source/java/org/alfresco/repo/rating/RatingServiceImpl.java +++ b/source/java/org/alfresco/repo/rating/RatingServiceImpl.java @@ -320,13 +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 ratingSchemeName - * @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 + * @param ratingNode + * @return */ private Rating convertNodeRefToRating(String user, NodeRef ratingNode) { diff --git a/source/java/org/alfresco/repo/remotecredentials/OAuth1CredentialsFactory.java b/source/java/org/alfresco/repo/remotecredentials/OAuth1CredentialsFactory.java index 9a61976c75..95112cad61 100644 --- a/source/java/org/alfresco/repo/remotecredentials/OAuth1CredentialsFactory.java +++ b/source/java/org/alfresco/repo/remotecredentials/OAuth1CredentialsFactory.java @@ -69,13 +69,12 @@ public class OAuth1CredentialsFactory implements RemoteCredentialsInfoFactory } /** - * Serializes the given {@link BaseCredentialsInfo} object to node properties. - * - * @param info The Credentials object to serialize - * @param coreProperties The core rc:credentialBase properties for the node - * @return The final set of properties to be serialized for the node - */ - public Map serializeCredentials(BaseCredentialsInfo info) + * Serializes the given {@link BaseCredentialsInfo} object to node properties. + * + * @param info The Credentials object to serialize + * @return The final set of properties to be serialized for the node + */ + public Map serializeCredentials(BaseCredentialsInfo info) { if (! (info instanceof OAuth1CredentialsInfo)) { diff --git a/source/java/org/alfresco/repo/remotecredentials/OAuth2CredentialsFactory.java b/source/java/org/alfresco/repo/remotecredentials/OAuth2CredentialsFactory.java index e3fd4ff6be..97d3cf7842 100644 --- a/source/java/org/alfresco/repo/remotecredentials/OAuth2CredentialsFactory.java +++ b/source/java/org/alfresco/repo/remotecredentials/OAuth2CredentialsFactory.java @@ -76,13 +76,12 @@ public class OAuth2CredentialsFactory implements RemoteCredentialsInfoFactory } /** - * Serializes the given {@link BaseCredentialsInfo} object to node properties. - * - * @param info The Credentials object to serialize - * @param coreProperties The core rc:credentialBase properties for the node - * @return The final set of properties to be serialized for the node - */ - public Map serializeCredentials(BaseCredentialsInfo info) + * Serializes the given {@link BaseCredentialsInfo} object to node properties. + * + * @param info The Credentials object to serialize + * @return The final set of properties to be serialized for the node + */ + public Map serializeCredentials(BaseCredentialsInfo info) { if (! (info instanceof OAuth2CredentialsInfo)) { diff --git a/source/java/org/alfresco/repo/remotecredentials/PasswordCredentialsFactory.java b/source/java/org/alfresco/repo/remotecredentials/PasswordCredentialsFactory.java index c98764001f..b265ac6894 100644 --- a/source/java/org/alfresco/repo/remotecredentials/PasswordCredentialsFactory.java +++ b/source/java/org/alfresco/repo/remotecredentials/PasswordCredentialsFactory.java @@ -66,13 +66,12 @@ public class PasswordCredentialsFactory implements RemoteCredentialsInfoFactory } /** - * Serializes the given {@link BaseCredentialsInfo} object to node properties. - * - * @param info The Credentials object to serialize - * @param coreProperties The core rc:credentialBase properties for the node - * @return The final set of properties to be serialized for the node - */ - public Map serializeCredentials(BaseCredentialsInfo info) + * Serializes the given {@link BaseCredentialsInfo} object to node properties. + * + * @param info The Credentials object to serialize + * @return The final set of properties to be serialized for the node + */ + public Map serializeCredentials(BaseCredentialsInfo info) { if (! (info instanceof PasswordCredentialsInfo)) { diff --git a/source/java/org/alfresco/repo/remoteticket/AlfTicketRemoteAlfrescoTicketImpl.java b/source/java/org/alfresco/repo/remoteticket/AlfTicketRemoteAlfrescoTicketImpl.java index f8bda24d65..442c59c087 100644 --- a/source/java/org/alfresco/repo/remoteticket/AlfTicketRemoteAlfrescoTicketImpl.java +++ b/source/java/org/alfresco/repo/remoteticket/AlfTicketRemoteAlfrescoTicketImpl.java @@ -19,13 +19,13 @@ package org.alfresco.repo.remoteticket; import org.alfresco.repo.security.authentication.Authorization; -import org.alfresco.util.Pair; - -/** - * An implementation of {@link RemoteAlfrescoTicketInfo} which works - * with the regular Alfresco alf_ticket ticket system - * - * @author Nick Burch +import org.alfresco.util.Pair; + +/** + * An implementation of {@link org.alfresco.service.cmr.remoteticket.RemoteAlfrescoTicketInfo} which works + * with the regular Alfresco alf_ticket ticket system + * + * @author Nick Burch * @since 4.0.2 */ public class AlfTicketRemoteAlfrescoTicketImpl extends AbstractRemoteAlfrescoTicketImpl diff --git a/source/java/org/alfresco/repo/remoteticket/GuestRemoteAlfrescoTicketImpl.java b/source/java/org/alfresco/repo/remoteticket/GuestRemoteAlfrescoTicketImpl.java index d5102b3a38..bed5bbe6ef 100644 --- a/source/java/org/alfresco/repo/remoteticket/GuestRemoteAlfrescoTicketImpl.java +++ b/source/java/org/alfresco/repo/remoteticket/GuestRemoteAlfrescoTicketImpl.java @@ -18,13 +18,13 @@ */ package org.alfresco.repo.remoteticket; -import org.alfresco.util.Pair; - -/** - * An implementation of {@link RemoteAlfrescoTicketInfo} which authenticates - * as the Guest user - * - * @author Nick Burch +import org.alfresco.util.Pair; + +/** + * An implementation of {@link org.alfresco.service.cmr.remoteticket.RemoteAlfrescoTicketInfo} which authenticates + * as the Guest user + * + * @author Nick Burch * @since 4.0.2 */ public class GuestRemoteAlfrescoTicketImpl extends AbstractRemoteAlfrescoTicketImpl diff --git a/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java b/source/java/org/alfresco/repo/rendition/CompositeRenditionDefinitionImpl.java index bf1e7290f5..8c96a43873 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 nodeRef - * @param id - */ - 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); } diff --git a/source/java/org/alfresco/repo/rendition/RenditionPreventionRegistry.java b/source/java/org/alfresco/repo/rendition/RenditionPreventionRegistry.java index 0ac540a934..b947a498bc 100644 --- a/source/java/org/alfresco/repo/rendition/RenditionPreventionRegistry.java +++ b/source/java/org/alfresco/repo/rendition/RenditionPreventionRegistry.java @@ -69,7 +69,7 @@ public class RenditionPreventionRegistry /** * Checks if the specified type/aspect is registered as a marker for rendition prevention. - * @param contentClassName aspect name. + * @param aspectQName aspect name. * @return true if this aspect will prevent renditions, else false */ public boolean isContentClassRegistered(QName aspectQName) diff --git a/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java b/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java index f4fbbe9071..407056696c 100644 --- a/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java +++ b/source/java/org/alfresco/repo/rendition/executer/AbstractRenderingEngine.java @@ -761,13 +761,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase private final QName renditionContentProperty; private ChildAssociationRef caNodeRef; - - /** - * @param sourceNode - * @param destinationNode - * @param definition - * @param renditionContentProperty - */ + + /** + * @param sourceNode + * @param definition + * @param renditionContentProperty + */ public RenderingContext(NodeRef sourceNode,// RenditionDefinition definition,// QName renditionContentProperty) diff --git a/source/java/org/alfresco/repo/rendition/executer/DeleteRenditionActionExecuter.java b/source/java/org/alfresco/repo/rendition/executer/DeleteRenditionActionExecuter.java index 1cbb18c0b3..0b88393707 100644 --- a/source/java/org/alfresco/repo/rendition/executer/DeleteRenditionActionExecuter.java +++ b/source/java/org/alfresco/repo/rendition/executer/DeleteRenditionActionExecuter.java @@ -87,13 +87,13 @@ public class DeleteRenditionActionExecuter extends ActionExecuterAbstractBase public void setBehaviourFilter(BehaviourFilter behaviourFilter) { this.behaviourFilter = behaviourFilter; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) - */ - public void executeImpl(final Action action, final NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(Action, NodeRef) + */ + public void executeImpl(final Action action, final NodeRef actionedUponNodeRef) + { // It is possible that the user who triggered the thumbnail update does not have delete permissions on the node // but does have write permissions. e.g. if a SiteCollaborator updates a node which they do not own, any failure // to update renditions would trigger this DeleteRendition action and they would not have permissions to delete. diff --git a/source/java/org/alfresco/repo/rule/RuleServiceImpl.java b/source/java/org/alfresco/repo/rule/RuleServiceImpl.java index b15ab810ae..a82136ee7e 100644 --- a/source/java/org/alfresco/repo/rule/RuleServiceImpl.java +++ b/source/java/org/alfresco/repo/rule/RuleServiceImpl.java @@ -1355,13 +1355,13 @@ public class RuleServiceImpl return result; } - /** - * Register the rule type - * - * @param ruleTypeAdapter the rule type adapter - */ - public void registerRuleType(RuleType ruleType) - { + /** + * Register the rule type + * + * @param ruleType the rule type adapter + */ + public void registerRuleType(RuleType ruleType) + { this.ruleTypes.put(ruleType.getName(), ruleType); } diff --git a/source/java/org/alfresco/repo/rule/RuleTypeImpl.java b/source/java/org/alfresco/repo/rule/RuleTypeImpl.java index 59a812006e..5c266ed1ab 100644 --- a/source/java/org/alfresco/repo/rule/RuleTypeImpl.java +++ b/source/java/org/alfresco/repo/rule/RuleTypeImpl.java @@ -111,13 +111,13 @@ public class RuleTypeImpl extends CommonResourceAbstractBase implements RuleType public String getDisplayLabel() { return I18NUtil.getMessage(this.name + "." + "display-label"); - } - - /** - * @see org.alfresco.service.cmr.rule.RuleType#triggerRuleType(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef) - */ - public void triggerRuleType(NodeRef nodeRef, NodeRef actionedUponNodeRef, boolean executeRuleImmediately) - { + } + + /** + * @see org.alfresco.service.cmr.rule.RuleType#triggerRuleType(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, boolean) + */ + public void triggerRuleType(NodeRef nodeRef, NodeRef actionedUponNodeRef, boolean executeRuleImmediately) + { if (ruleService.isEnabled() == true && nodeService.exists(actionedUponNodeRef) == true && ruleService.isRuleTypeEnabled(this.getName()) == true) diff --git a/source/java/org/alfresco/repo/search/IndexerAndSearcher.java b/source/java/org/alfresco/repo/search/IndexerAndSearcher.java index 78841c2042..6f7a7260d4 100644 --- a/source/java/org/alfresco/repo/search/IndexerAndSearcher.java +++ b/source/java/org/alfresco/repo/search/IndexerAndSearcher.java @@ -58,13 +58,13 @@ public interface IndexerAndSearcher * Do any indexing that may be pending on behalf of the current transaction. * */ - public abstract void flush(); - - /** - * @param luceneAlfrescoFtsQueryLanguage - */ - public abstract void registerQueryLanguage(LuceneQueryLanguageSPI luceneQueryLanguageSPI); - + public abstract void flush(); + + /** + * @param luceneQueryLanguageSPI + */ + public abstract void registerQueryLanguage(LuceneQueryLanguageSPI luceneQueryLanguageSPI); + /** * @return */ 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 9c1e5db11e..db3ebd76b2 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/AbstractLuceneIndexerAndSearcherFactory.java @@ -493,13 +493,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 deltaId - * @return - the searcher made by the concrete implementation. - * @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 + */ protected abstract LuceneSearcher getSearcher(StoreRef storeRef, LuceneIndexer indexer) throws SearcherException; 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 3d21cf09eb..d7acf68774 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/FilterIndexReaderByStringId.java @@ -195,13 +195,12 @@ public class FilterIndexReaderByStringId extends FilterIndexReader String id; - /** - * @param id - * @param in - * @param deletedDocuments - */ - public FilterTermDocs(String id, TermDocs in) - { + /** + * @param id + * @param in + */ + public FilterTermDocs(String id, TermDocs in) + { this.in = in; } @@ -339,13 +338,12 @@ public class FilterIndexReaderByStringId extends FilterIndexReader TermPositions tp; - /** - * @param id - * @param in - * @param deletedDocuements - */ - public FilterTermPositions(String id, TermPositions in) - { + /** + * @param id + * @param in + */ + public FilterTermPositions(String id, TermPositions in) + { super(id, in); tp = in; } 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 052dbdcb2a..798b848ebc 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneCategoryServiceImpl.java @@ -96,13 +96,13 @@ public class LuceneCategoryServiceImpl implements CategoryService this.nodeService = nodeService; } - /** - * Set the public node service - * - * @param nodeService - */ - public void setPublicNodeService(NodeService publicNodeService) - { + /** + * Set the public node service + * + * @param publicNodeService + */ + public void setPublicNodeService(NodeService publicNodeService) + { this.publicNodeService = publicNodeService; } 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 5eaca4400d..9e34a51bb6 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java @@ -74,14 +74,18 @@ public class LuceneResultSet extends AbstractResultSet private int bulkFetchSize = DEFAULT_BULK_FETCH_SIZE; - /** - * Wrap a lucene seach result with node support - * - * @param storeRef - * @param hits - */ - public LuceneResultSet(Hits hits, Searcher searcher, NodeService nodeService, TenantService tenantService, SearchParameters searchParameters, - LuceneConfig config) + /** + * 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) { super(); this.hits = hits; 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 35e417b65f..182e45ec4e 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 position - */ - public LuceneResultSetRow(LuceneResultSet resultSet, int index) - { + * Wrap a position in a lucene Hits class with node support + * + * @param resultSet + * @param index + */ + public LuceneResultSetRow(LuceneResultSet resultSet, int index) + { super(resultSet, index); tenantService = resultSet.getTenantService(); diff --git a/source/java/org/alfresco/repo/search/impl/lucene/SolrJSONResultSet.java b/source/java/org/alfresco/repo/search/impl/lucene/SolrJSONResultSet.java index aa24142994..3c16bac697 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/SolrJSONResultSet.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/SolrJSONResultSet.java @@ -86,7 +86,12 @@ public class SolrJSONResultSet implements ResultSet, JSONResult /** * Detached result set based on that provided - * @param resultSet + * @param json + * @param searchParameters + * @param nodeService + * @param nodeDao + * @param limitBy + * @param maxResults */ public SolrJSONResultSet(JSONObject json, SearchParameters searchParameters, NodeService nodeService, NodeDAO nodeDao, LimitBy limitBy, int maxResults) { diff --git a/source/java/org/alfresco/repo/search/impl/lucene/fts/FTSIndexerAware.java b/source/java/org/alfresco/repo/search/impl/lucene/fts/FTSIndexerAware.java index 2041fdafcb..be77917f1a 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/fts/FTSIndexerAware.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/fts/FTSIndexerAware.java @@ -29,10 +29,10 @@ public interface FTSIndexerAware { /** * Call back used by the background indexer - * - * @param storeRef - * @param remaining - * @param e - */ - public void indexCompleted(StoreRef storeRef, int remaining, Throwable t); -} + * + * @param storeRef + * @param remaining + * @param t + */ + public void indexCompleted(StoreRef storeRef, int remaining, Throwable t); +} diff --git a/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexer.java b/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexer.java index 34ec0535e4..b1aedcebac 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexer.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexer.java @@ -37,13 +37,13 @@ public interface FullTextSearchIndexer extends BeanFactoryAware /** * Call back to report state back to the indexer - * - * @param storeRef - * @param remaining - * @param e - */ - public abstract void indexCompleted(StoreRef storeRef, int remaining, Throwable t); - + * + * @param storeRef + * @param remaining + * @param t + */ + public abstract void indexCompleted(StoreRef storeRef, int remaining, Throwable t); + /** * Pause indexing 9no back ground indexing until a resume is called) * @throws InterruptedException diff --git a/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexerImpl.java b/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexerImpl.java index 39df098299..572fb21409 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexerImpl.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/fts/FullTextSearchIndexerImpl.java @@ -455,13 +455,13 @@ public class FullTextSearchIndexerImpl implements FTSIndexerAware, FullTextSearc } } - - /** - * The maximum maximum batch size - * @param batchSize the batchSize to set - */ - public void setBatchSize(int batchSzie) - { + + /** + * The maximum maximum batch size + * @param batchSzie the batchSize to set + */ + public void setBatchSize(int batchSzie) + { this.batchSize = batchSzie; } diff --git a/source/java/org/alfresco/repo/search/impl/lucene/index/IndexInfo.java b/source/java/org/alfresco/repo/search/impl/lucene/index/IndexInfo.java index c91ee1ec65..eea82db373 100644 --- a/source/java/org/alfresco/repo/search/impl/lucene/index/IndexInfo.java +++ b/source/java/org/alfresco/repo/search/impl/lucene/index/IndexInfo.java @@ -2147,13 +2147,12 @@ public class IndexInfo implements IndexMonitor } } - /** - * Check status must be called holding the file lock. - * - * @param raf - * @throws IOException - */ - private void setStatusFromFile() throws IOException + /** + * Check status must be called holding the file lock. + * + * @throws IOException + */ + private void setStatusFromFile() throws IOException { try { @@ -3359,15 +3358,12 @@ public class IndexInfo implements IndexMonitor if (s_logger.isDebugEnabled()) { dumpInfo(); - } - } - - /** - * @param action - */ - 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/querymodel/impl/db/DBQueryBuilderPredicatePartCommand.java b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommand.java index a289d7f4dc..4cd9d76d6c 100644 --- a/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommand.java +++ b/source/java/org/alfresco/repo/search/impl/querymodel/impl/db/DBQueryBuilderPredicatePartCommand.java @@ -110,7 +110,7 @@ public class DBQueryBuilderPredicatePartCommand } /** - * @param joinAlias the joinAlias to set + * @param alias the joinAlias to set */ public void setAlias(String alias) { 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 53d466d1d7..608f4266ba 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 @@ -72,8 +72,8 @@ public class PropertySupport implements DBQueryBuilderComponent } /** - * @param term - * the term to set + * @param value + * the value to set */ public void setValue(String value) { 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 4d5ed9f337..2ec07657fa 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 @@ -47,7 +47,7 @@ public class UUIDSupport implements DBQueryBuilderComponent private boolean leftOuter; /** - * @param uud the uud to set + * @param uuid the uud to set */ public void setUuid(String uuid) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/DbAftsQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/solr/DbAftsQueryLanguage.java index 682e253098..67856a8156 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/DbAftsQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/solr/DbAftsQueryLanguage.java @@ -53,7 +53,7 @@ public class DbAftsQueryLanguage extends AbstractAlfrescoFtsQueryLanguage } /** - * @param namespacePrefixResolver the namespacePrefixResolver to set + * @param namespaceService the namespaceService to set */ public void setNamespaceService(NamespaceService namespaceService) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/DbOrIndexSwitchingQueryLanguage.java b/source/java/org/alfresco/repo/search/impl/solr/DbOrIndexSwitchingQueryLanguage.java index 3bad2e61f7..a27c80c2c8 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/DbOrIndexSwitchingQueryLanguage.java +++ b/source/java/org/alfresco/repo/search/impl/solr/DbOrIndexSwitchingQueryLanguage.java @@ -73,7 +73,7 @@ public class DbOrIndexSwitchingQueryLanguage extends AbstractLuceneQueryLanguage /** - * @param solrQueryLanguage the solrQueryLanguage to set + * @param indexQueryLanguage the indexQueryLanguage to set */ public void setIndexQueryLanguage(LuceneQueryLanguageSPI indexQueryLanguage) { 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 330a92e804..5fa3d86f2b 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java +++ b/source/java/org/alfresco/repo/search/impl/solr/SolrQueryHTTPClient.java @@ -166,7 +166,7 @@ public class SolrQueryHTTPClient implements BeanFactoryAware } /** - * @param nodeDao the nodeDao to set + * @param nodeDAO the nodeDao to set */ public void setNodeDAO(NodeDAO nodeDAO) { diff --git a/source/java/org/alfresco/repo/search/impl/solr/facet/handler/AbstractFacetLabelDisplayHandler.java b/source/java/org/alfresco/repo/search/impl/solr/facet/handler/AbstractFacetLabelDisplayHandler.java index 8169516a2f..135289ef1a 100644 --- a/source/java/org/alfresco/repo/search/impl/solr/facet/handler/AbstractFacetLabelDisplayHandler.java +++ b/source/java/org/alfresco/repo/search/impl/solr/facet/handler/AbstractFacetLabelDisplayHandler.java @@ -67,13 +67,13 @@ public abstract class AbstractFacetLabelDisplayHandler implements FacetLabelDisp this.supportedFieldFacets = supportedFieldFacets; } - /** - * Set the service registry - * - * @param services the service registry - */ - public void setServiceRegistry(ServiceRegistry serviceRegistry) - { + /** + * Set the service registry + * + * @param serviceRegistry the service registry + */ + public void setServiceRegistry(ServiceRegistry serviceRegistry) + { this.serviceRegistry = serviceRegistry; } diff --git a/source/java/org/alfresco/repo/search/results/SortedResultSet.java b/source/java/org/alfresco/repo/search/results/SortedResultSet.java index 311f49aad8..3326802273 100644 --- a/source/java/org/alfresco/repo/search/results/SortedResultSet.java +++ b/source/java/org/alfresco/repo/search/results/SortedResultSet.java @@ -81,8 +81,10 @@ public class SortedResultSet implements ResultSet * * @param resultSet * @param nodeService - * @param searchParameters + * @param sortDefinitions * @param namespacePrefixResolver + * @param dictionaryService + * @param locale */ public SortedResultSet(ResultSet resultSet, NodeService nodeService, List sortDefinitions, NamespacePrefixResolver namespacePrefixResolver, DictionaryService dictionaryService, Locale locale) diff --git a/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java b/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java index 2aa54dbfb7..ffd00a0543 100644 --- a/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java +++ b/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java @@ -613,24 +613,24 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC return this.defaultGuestUserNames; } - /** - * Sets the user names who for this particular authentication system should be considered administrators by default. - * - * @param defaultAdministratorUserNames - * 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 defaultAdministratorUserNames - */ - public void setDefaultGuestUserNameList(String defaultGuestUserNames) - { + /** + * Convenience method to allow the administrator user names to be specified as a comma separated list + * + * @param defaultGuestUserNames + */ + public void setDefaultGuestUserNameList(String defaultGuestUserNames) + { Set nameSet = new TreeSet(); if (defaultGuestUserNames.length() > 0) { diff --git a/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java b/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java index 886f21eef9..236925872e 100644 --- a/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java +++ b/source/java/org/alfresco/repo/security/authentication/RepositoryAuthenticationDao.java @@ -794,13 +794,12 @@ public class RepositoryAuthenticationDao implements MutableAuthenticationDao, In } } - /** - * Remove from the cache and lock the value for the transaction - * @param key - * @param lock - */ - private void removeAuthenticationFromCache(String key) - { + /** + * Remove from the cache and lock the value for the transaction + * @param key + */ + private void removeAuthenticationFromCache(String key) + { authenticationCache.remove(key); if (authenticationCache instanceof TransactionalCache) { diff --git a/source/java/org/alfresco/repo/security/authentication/ShaPasswordEncoderImpl.java b/source/java/org/alfresco/repo/security/authentication/ShaPasswordEncoderImpl.java index c024861014..46276e0f8a 100644 --- a/source/java/org/alfresco/repo/security/authentication/ShaPasswordEncoderImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/ShaPasswordEncoderImpl.java @@ -29,7 +29,7 @@ package org.alfresco.repo.security.authentication; *

    * As SHA is a one-way hash, the salt can contain any characters. The default * strength for the SHA encoding is SHA-1. If you wish to use higher strengths - * use the argumented constructor. {@link #ShaPasswordEncoder(int strength)} + * use the argumented constructor. {@link #ShaPasswordEncoderImpl(int)} *

    *

    * The applicationContext example... diff --git a/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMAuthenticationComponentImpl.java b/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMAuthenticationComponentImpl.java index e6a248ed27..7b4c93b6ea 100644 --- a/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMAuthenticationComponentImpl.java +++ b/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMAuthenticationComponentImpl.java @@ -534,13 +534,13 @@ public class NTLMAuthenticationComponentImpl extends AbstractAuthenticationCompo } - /** - * Authenticate using a token - * - * @param token Authentication - * @return Authentication - * @throws AuthenticationException - */ + /** + * Authenticate using a token + * + * @param auth Authentication + * @return Authentication + * @throws AuthenticationException + */ public Authentication authenticate(Authentication auth) throws AuthenticationException { // DEBUG @@ -651,13 +651,13 @@ public class NTLMAuthenticationComponentImpl extends AbstractAuthenticationCompo /** * Authenticate a user using local credentials - * - * @param ntlmToken NTLMLocalToken - * @param authSess AuthenticateSession - * @throws AutheticationException - */ - private void authenticateLocal(NTLMLocalToken ntlmToken, AuthenticateSession authSess) - { + * + * @param ntlmToken NTLMLocalToken + * @param authSess AuthenticateSession + * @throws org.alfresco.repo.security.authentication.AuthenticationException + */ + private void authenticateLocal(NTLMLocalToken ntlmToken, AuthenticateSession authSess) + { try { // Get the plaintext password and generate an NTLM1 password hash @@ -770,13 +770,13 @@ public class NTLMAuthenticationComponentImpl extends AbstractAuthenticationCompo } /** - * Authenticate using passthru authentication with a client - * - * @param ntlmToken NTLMPassthruToken - * @throws AuthenticationExcepion - */ - private void authenticatePassthru(NTLMPassthruToken ntlmToken) - { + * Authenticate using passthru authentication with a client + * + * @param ntlmToken NTLMPassthruToken + * @throws org.alfresco.repo.security.authentication.AuthenticationException + */ + private void authenticatePassthru(NTLMPassthruToken ntlmToken) + { // Check if the token has an authentication session, if not then it is either a new token // or the session has been timed out 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 b7d9c11dfd..6401e7f6d9 100644 --- a/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java +++ b/source/java/org/alfresco/repo/security/authentication/ntlm/NTLMPassthruToken.java @@ -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 startTime 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/authority/AbstractAuthorityBridgeDAO.java b/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java index 64beede669..dc5422b770 100644 --- a/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java +++ b/source/java/org/alfresco/repo/security/authority/AbstractAuthorityBridgeDAO.java @@ -159,13 +159,12 @@ public abstract class AbstractAuthorityBridgeDAO implements AuthorityBridgeDAO /** * @param authorityContainerTypeQNameId - * @param memberAssocQNameId - * @param authorityNameQNameId - * @param storeId - * @param user - * @return - */ - protected abstract List selectDirectAuthoritiesForUser(Long authorityContainerTypeQNameId, Long memberAssocQNameId, Long authorityNameQNameId, Long storeId, + * @param memberAssocQNameId + * @param authorityNameQNameId + * @param storeId + * @return + */ + protected abstract List selectDirectAuthoritiesForUser(Long authorityContainerTypeQNameId, Long memberAssocQNameId, Long authorityNameQNameId, Long storeId, Long nodeId); /** diff --git a/source/java/org/alfresco/repo/security/authority/AuthorityBridgeParametersEntity.java b/source/java/org/alfresco/repo/security/authority/AuthorityBridgeParametersEntity.java index c6cb1fc62c..51cf0f563e 100644 --- a/source/java/org/alfresco/repo/security/authority/AuthorityBridgeParametersEntity.java +++ b/source/java/org/alfresco/repo/security/authority/AuthorityBridgeParametersEntity.java @@ -123,13 +123,13 @@ public class AuthorityBridgeParametersEntity public Long getNodeId() { return nodeId; - } - - /** - * @param childName the childName to set - */ - public void setNodeId(Long nodeId) - { + } + + /** + * @param nodeId the node id to set + */ + public void setNodeId(Long nodeId) + { this.nodeId = nodeId; } diff --git a/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java b/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java index 237610bdc3..d74a1e7890 100644 --- a/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java +++ b/source/java/org/alfresco/repo/security/authority/AuthorityServiceImpl.java @@ -734,13 +734,12 @@ public class AuthorityServiceImpl implements AuthorityService, InitializingBean private Set positiveHits; private Set negativeHits; private boolean allAuthoritiesLoaded; - - /** - * @param username - * @param auths - */ - public UserAuthoritySet(String username) - { + + /** + * @param username + */ + public UserAuthoritySet(String username) + { this.username = username; positiveHits = new TreeSet(); negativeHits = new TreeSet(); 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 10fef13048..279880d6f4 100644 --- a/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java +++ b/source/java/org/alfresco/repo/security/authority/script/ScriptGroup.java @@ -631,7 +631,7 @@ public class ScriptGroup implements Authority, Serializable /** * Returns an array of ScriptGroup objects representing the given paged results. * - * @param groups The paged results + * @param pagedGroups The paged results * @param paging Object representing the paging details * @param sortBy field for sorting * @param sortAsc sort ascending or not @@ -666,7 +666,7 @@ public class ScriptGroup implements Authority, Serializable /** * Returns an array of ScriptGroup objects representing the given paged results. * - * @param groups sorted paged results (the page of results get sorted again taking I18n into account) + * @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 diff --git a/source/java/org/alfresco/repo/security/permissions/PermissionCheckedValue.java b/source/java/org/alfresco/repo/security/permissions/PermissionCheckedValue.java index 71c67616ee..944288dcd8 100644 --- a/source/java/org/alfresco/repo/security/permissions/PermissionCheckedValue.java +++ b/source/java/org/alfresco/repo/security/permissions/PermissionCheckedValue.java @@ -45,13 +45,13 @@ public interface PermissionCheckedValue { super(); } - /** - * Helper method to create a {@link PermissionCheckedValue} from an existing Object. - * - * @param collection the Object to proxy - * @return a Object of the same type but including the - * {@link PermissionCheckedValue} interface - */ + /** + * Helper method to create a {@link PermissionCheckedValue} from an existing Object. + * + * @param object the Object to proxy + * @return a Object of the same type but including the + * {@link PermissionCheckedValue} interface + */ @SuppressWarnings("unchecked") public static final T create(T object) { 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 506881484f..d493e2137d 100644 --- a/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java +++ b/source/java/org/alfresco/repo/security/permissions/impl/PermissionServiceImpl.java @@ -609,13 +609,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } protected AccessStatus hasPermission(Long aclId, PermissionContext context, PermissionReference permission) - { - if (aclId == null) - { + { + if (aclId == null) + { // Enforce store ACLs if set - if (context.getStoreAcl() == null) - { - return AccessStatus.ALLOWED; + if (context.getStoreAcl() == null) + { + return AccessStatus.ALLOWED; } else { @@ -1691,14 +1691,12 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm /** * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param granters - - * the set of granters - * @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 */ @@ -1836,15 +1834,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } /** - * Internal hook point for recursion - * - * @param authorisations - * @param nodeRef - * @param denied - * @param recursiveIn - * @return true if granted - */ - boolean evaluate(Set authorisations, Long aclId, PermissionContext context) + * Internal hook point for recursion + * + * @param authorisations + * @param aclId + * @param context + * @return true if granted + */ + boolean evaluate(Set authorisations, Long aclId, PermissionContext context) { // Start out true and "and" all other results boolean success = true; @@ -1910,14 +1907,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } /** - * Check that a given authentication is available on a node - * - * @param authorisations - * @param nodeRef - * @param denied - * @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 + * @param aclId + * @param context + * @return true if a check is required + */ + boolean checkRequired(Set authorisations, Long aclId, PermissionContext context) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -1955,20 +1952,18 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param granters - - * the set of granters - * @param authorisations - - * the set of authorities - * @param denied - - * the set of denied permissions/authority pais - * @return true if granted - */ - private boolean isGranted(AccessControlEntry ace, Set authorisations, Set> denied, PermissionContext context) + /** + * 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) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.DENIED) @@ -2028,20 +2023,18 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param granters - - * the set of granters - * @param authorisations - - * the set of authorities - * @param denied - - * the set of denied permissions/authority pais - * @return true if granted - */ - private boolean isDenied(AccessControlEntry ace, Set authorisations, Set> allowed, PermissionContext context) + /** + * 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) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.ALLOWED) @@ -2183,16 +2176,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm granters.add(OLD_ALL_PERMISSIONS_REFERENCE); } - /** - * Internal hook point for recursion - * - * @param authorisations - * @param nodeRef - * @param denied - * @param recursiveIn - * @return true if granted - */ - boolean evaluate(String authority, Long aclId) + /** + * Internal hook point for recursion + * + * @param authority + * @param aclId + * @return true if granted + */ + boolean evaluate(String authority, Long aclId) { // Start out true and "and" all other results boolean success = true; @@ -2246,13 +2237,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } - /** - * Check if we have a global permission - * - * @param authorisations - * @return true if granted - */ - private boolean checkGlobalPermissions(String authority) + /** + * Check if we have a global permission + * + * @param authority + * @return true if granted + */ + private boolean checkGlobalPermissions(String authority) { for (PermissionEntry pe : modelDAO.getGlobalPermissionEntries()) { @@ -2264,15 +2255,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Check that a given authentication is available on a node - * - * @param authorisations - * @param nodeRef - * @param denied - * @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 + * @param aclId + * @return true if a check is required + */ + boolean checkRequired(String authority, Long aclId) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -2295,18 +2285,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param granters - - * the set of granters - * @param authorisations - - * the set of authorities - * @param denied - - * the set of denied permissions/authority pais - * @return true if granted + /** + * Is a permission granted + * + * @param ace + * @param authority + * @param denied - + * the set of denied permissions/authority pais + * @return true if granted */ private boolean isGranted(AccessControlEntry ace, String authority, Set> denied) { @@ -2447,16 +2433,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm granters.add(OLD_ALL_PERMISSIONS_REFERENCE); } - /** - * Internal hook point for recursion - * - * @param authorisations - * @param nodeRef - * @param denied - * @param recursiveIn - * @return true if granted - */ - boolean evaluate(String authority, Long aclId) + /** + * Internal hook point for recursion + * + * @param authority + * @param aclId + * @return true if granted + */ + boolean evaluate(String authority, Long aclId) { // Start out true and "and" all other results boolean success = true; @@ -2510,13 +2494,13 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm } - /** - * Check if we have a global permission - * - * @param authorisations - * @return true if granted - */ - private boolean checkGlobalPermissions(String authority) + /** + * Check if we have a global permission + * + * @param authority + * @return true if granted + */ + private boolean checkGlobalPermissions(String authority) { for (PermissionEntry pe : modelDAO.getGlobalPermissionEntries()) { @@ -2528,15 +2512,14 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Check that a given authentication is available on a node - * - * @param authorisations - * @param nodeRef - * @param denied - * @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 + * @param aclId + * @return true if a check is required + */ + boolean checkRequired(String authority, Long aclId) { AccessControlList acl = aclDaoComponent.getAccessControlList(aclId); @@ -2559,20 +2542,16 @@ public class PermissionServiceImpl extends AbstractLifecycleBean implements Perm return false; } - /** - * Is a permission granted - * - * @param pe - - * the permissions entry to consider - * @param granters - - * the set of granters - * @param authorisations - - * the set of authorities - * @param denied - - * the set of denied permissions/authority pais - * @return true if granted - */ - private boolean isDenied(AccessControlEntry ace, String authority, Set> allowed) + /** + * 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) { // If the permission entry denies then we just deny if (ace.getAccessStatus() == AccessStatus.ALLOWED) @@ -2687,13 +2666,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 nodeRef - 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 6e855196a0..7d3d640b26 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 @@ -194,13 +194,13 @@ public class ACLEntryAfterInvocationProvider implements AfterInvocationProvider, { this.maxPermissionCheckTimeMillis = maxPermissionCheckTimeMillis; } - - /** - * Types and aspects for which we will abstain on voting if they are present. - * @param abstainFor - */ - public void setUnfilteredFor(Set unfilteredFor) - { + + /** + * Types and aspects for which we will abstain on voting if they are present. + * @param unfilteredFor + */ + 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 d4b89d3f99..04715d7aed 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 @@ -162,13 +162,13 @@ public class ACLEntryVoter implements AccessDecisionVoter, InitializingBean { this.nodeService = nodeService; } - - /** - * Set the ownable service - * @param nodeService - */ - public void setOwnableService(OwnableService ownableService) - { + + /** + * Set the ownable service + * @param ownableService + */ + public void setOwnableService(OwnableService ownableService) + { this.ownableService = ownableService; } diff --git a/source/java/org/alfresco/repo/security/person/HomeFolderProvider2.java b/source/java/org/alfresco/repo/security/person/HomeFolderProvider2.java index d31981ca48..5520fc9a1c 100644 --- a/source/java/org/alfresco/repo/security/person/HomeFolderProvider2.java +++ b/source/java/org/alfresco/repo/security/person/HomeFolderProvider2.java @@ -75,13 +75,13 @@ public interface HomeFolderProvider2 * @return the node to copy or {@code null} if not required. */ NodeRef getTemplateNodeRef(); - - /** - * Set the authority to use as the owner of all home folder nodes. - * If {@code null} the {@link ContentModel.PROP_USERNAME} value of - * the person is used. - */ - String getOwner(); + + /** + * Set the authority to use as the owner of all home folder nodes. + * If {@code null} the {@link org.alfresco.model.ContentModel#PROP_USERNAME} value of + * the person is used. + */ + String getOwner(); /** * Gets the PermissionsManager used on creating the home folder @@ -92,10 +92,10 @@ public interface HomeFolderProvider2 * Gets the PermissionsManager used on referencing the home folder */ PermissionsManager getOnReferencePermissionsManager(); - - /** - * Callback from {@link PortableHomeFolderManager} to locate or create a home folder. - * Implementations normally call {@link PortableHomeFolderManager.getHomeFolder}. - */ - HomeSpaceNodeRef getHomeFolder(NodeRef person); -} + + /** + * Callback from {@link PortableHomeFolderManager} to locate or create a home folder. + * Implementations normally call {@link PortableHomeFolderManager#getHomeFolder}. + */ + HomeSpaceNodeRef getHomeFolder(NodeRef person); +} diff --git a/source/java/org/alfresco/repo/security/person/HomeFolderProviderSynchronizer.java b/source/java/org/alfresco/repo/security/person/HomeFolderProviderSynchronizer.java index 630944bd1d..641f7067e1 100644 --- a/source/java/org/alfresco/repo/security/person/HomeFolderProviderSynchronizer.java +++ b/source/java/org/alfresco/repo/security/person/HomeFolderProviderSynchronizer.java @@ -456,13 +456,14 @@ public class HomeFolderProviderSynchronizer extends AbstractLifecycleBean }.doWork(); } - /** - * Creates the new home folder structure, before we move home folders so that - * we don't have race conditions that result in unnecessary retries. - * @param parentFolderStructure - */ - private void createParentFolders(NodeRef person, String overrideProviderName) - { + /** + * Creates the new home folder structure, before we move home folders so that + * we don't have race conditions that result in unnecessary retries. + * @param person person nodeRef + * @param overrideProviderName override provider name + */ + private void createParentFolders(NodeRef person, String overrideProviderName) + { // We could short cut this process and build all the home folder from the // ParentFolderStructure in the calling method, but that would complicate // the code a little more and might result in transaction size problems. diff --git a/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java b/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java index 704208bd6f..ce2b172b4f 100644 --- a/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java +++ b/source/java/org/alfresco/repo/security/person/PortableHomeFolderManager.java @@ -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/sync/ChainingUserRegistrySynchronizer.java b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizer.java index 1c75e679b4..3d655471f8 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)} 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 cedfb5af05..e972d0e4d3 100644 --- a/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java +++ b/source/java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerStatus.java @@ -54,7 +54,7 @@ public interface ChainingUserRegistrySynchronizerStatus /** * Get the synchronization status - * @param zone + * @param zoneId - zone id * @return the status */ public String getSynchronizationStatus(String zoneId); diff --git a/source/java/org/alfresco/repo/security/sync/UserRegistrySynchronizerJob.java b/source/java/org/alfresco/repo/security/sync/UserRegistrySynchronizerJob.java index cf68f516c3..bad9fba101 100644 --- a/source/java/org/alfresco/repo/security/sync/UserRegistrySynchronizerJob.java +++ b/source/java/org/alfresco/repo/security/sync/UserRegistrySynchronizerJob.java @@ -27,7 +27,7 @@ import org.quartz.JobExecutionException; /** * A scheduled job that regularly invokes a {@link UserRegistrySynchronizer}. Supports a * synchronizeChangesOnly string parameter. When "false" means that the - * {@link UserRegistrySynchronizer#synchronize(boolean)} method will be called with a true forceUpdate + * {@link UserRegistrySynchronizer#synchronize(boolean, boolean)} method will be called with a true forceUpdate * argument rather than the default false. * * @author dward diff --git a/source/java/org/alfresco/repo/service/StoreRedirectorProxyFactory.java b/source/java/org/alfresco/repo/service/StoreRedirectorProxyFactory.java index 0fff8afcf0..00722020e9 100644 --- a/source/java/org/alfresco/repo/service/StoreRedirectorProxyFactory.java +++ b/source/java/org/alfresco/repo/service/StoreRedirectorProxyFactory.java @@ -85,7 +85,7 @@ public class StoreRedirectorProxyFactory implements FactoryBean, Initializing /** * Sets the default component binding * - * @param binding + * @param defaultBinding * the component to call by default */ public void setDefaultBinding(I defaultBinding) @@ -96,7 +96,7 @@ public class StoreRedirectorProxyFactory implements FactoryBean, Initializing /** * Sets the binding of store type (protocol string) to component * - * @param bindings + * @param protocolBindings * the bindings */ public void setRedirectedProtocolBindings(Map protocolBindings) @@ -115,7 +115,7 @@ public class StoreRedirectorProxyFactory implements FactoryBean, Initializing /** * Sets the binding of store type (protocol string) to component * - * @param bindings + * @param storeBindings * the bindings */ public void setRedirectedStoreBindings(Map storeBindings) diff --git a/source/java/org/alfresco/repo/site/DocLibNodeLocator.java b/source/java/org/alfresco/repo/site/DocLibNodeLocator.java index b7816854fc..43424babe6 100644 --- a/source/java/org/alfresco/repo/site/DocLibNodeLocator.java +++ b/source/java/org/alfresco/repo/site/DocLibNodeLocator.java @@ -43,13 +43,13 @@ public class DocLibNodeLocator extends AbstractNodeLocator private Repository repositoryHelper; /** - * Finds the site in which the source {@link NodeRef} resides and returns the Document Library container for that site. - * If no site can be found or the site does not have a Document Library then the Company Home is returned. - * - * @param sourceNode the starting point for locating the site Document Library. - * @param params Not used. - * @return the Document Library or the Company Home. - */ + * Finds the site in which the source {@link NodeRef} resides and returns the Document Library container for that site. + * If no site can be found or the site does not have a Document Library then the Company Home is returned. + * + * @param source the starting point for locating the site Document Library. + * @param params Not used. + * @return the Document Library or the Company Home. + */ @Override public NodeRef getNode(NodeRef source, Map params) { diff --git a/source/java/org/alfresco/repo/site/SiteInfoImpl.java b/source/java/org/alfresco/repo/site/SiteInfoImpl.java index 0e2bb85e3d..0bfdf00a9a 100644 --- a/source/java/org/alfresco/repo/site/SiteInfoImpl.java +++ b/source/java/org/alfresco/repo/site/SiteInfoImpl.java @@ -101,7 +101,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getNodeRef() + * @see org.alfresco.service.cmr.site.SiteInfo#getNodeRef() */ public NodeRef getNodeRef() { @@ -109,7 +109,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getSitePreset() + * @see org.alfresco.service.cmr.site.SiteInfo#getSitePreset() */ public String getSitePreset() { @@ -117,7 +117,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getShortName() + * @see org.alfresco.service.cmr.site.SiteInfo#getShortName() */ public String getShortName() { @@ -125,7 +125,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getTitle() + * @see org.alfresco.service.cmr.site.SiteInfo#getTitle() */ public String getTitle() { @@ -134,7 +134,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#setTitle(java.lang.String) + * @see org.alfresco.service.cmr.site.SiteInfo#setTitle(java.lang.String) */ public void setTitle(String title) { @@ -142,7 +142,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getDescription() + * @see org.alfresco.service.cmr.site.SiteInfo#getDescription() */ public String getDescription() { @@ -150,7 +150,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#setDescription(java.lang.String) + * @see org.alfresco.service.cmr.site.SiteInfo#setDescription(java.lang.String) */ public void setDescription(String description) { @@ -158,7 +158,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#setIsPublic(boolean) + * @see org.alfresco.service.cmr.site.SiteInfo#setIsPublic(boolean) */ public void setIsPublic(boolean isPublic) { @@ -173,7 +173,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getIsPublic() + * @see org.alfresco.service.cmr.site.SiteInfo#getIsPublic() */ public boolean getIsPublic() { @@ -202,7 +202,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getCustomProperties() + * @see org.alfresco.service.cmr.site.SiteInfo#getCustomProperties() */ public Map getCustomProperties() { @@ -210,7 +210,7 @@ public class SiteInfoImpl implements SiteInfo } /** - * @see org.alfresco.repo.site.SiteInfo#getCustomProperty(org.alfresco.service.namespace.QName) + * @see org.alfresco.service.cmr.site.SiteInfo#getCustomProperty(org.alfresco.service.namespace.QName) */ public Serializable getCustomProperty(QName name) { diff --git a/source/java/org/alfresco/repo/site/SiteServiceImpl.java b/source/java/org/alfresco/repo/site/SiteServiceImpl.java index 16b622b4d7..e2f0b6c15b 100644 --- a/source/java/org/alfresco/repo/site/SiteServiceImpl.java +++ b/source/java/org/alfresco/repo/site/SiteServiceImpl.java @@ -1184,7 +1184,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic * This method returns the {@link SiteInfo siteInfos} for sites to which the specified user has access. * Note that if the user has access to more than 1000 sites, the list will be truncated to 1000 entries. * - * @param userName the username + * @param group the group * @return a list of {@link SiteInfo site infos}. */ public String resolveSite(String group) @@ -2131,7 +2131,7 @@ 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 filter + * @param nameFilters * @param username * @return */ @@ -2680,7 +2680,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic /** - * @see org.alfresco.service.cmr.site.SiteService#getContainer(java.lang.String) + * @see org.alfresco.service.cmr.site.SiteService#getContainer(java.lang.String, String) */ public NodeRef getContainer(String shortName, String componentId) { @@ -2726,7 +2726,7 @@ public class SiteServiceImpl extends AbstractLifecycleBean implements SiteServic } /** - * @see org.alfresco.service.cmr.site.SiteService#hasContainer(java.lang.String) + * @see org.alfresco.service.cmr.site.SiteService#hasContainer(java.lang.String, String) */ public boolean hasContainer(final String shortName, final String componentId) { diff --git a/source/java/org/alfresco/repo/site/script/Site.java b/source/java/org/alfresco/repo/site/script/Site.java index c817d84a08..fddbcb1f2b 100644 --- a/source/java/org/alfresco/repo/site/script/Site.java +++ b/source/java/org/alfresco/repo/site/script/Site.java @@ -744,7 +744,8 @@ public class Site implements Serializable /** * Apply a set of permissions to the node. * - * @param nodeRef node reference + * @param node node + * @param permissions permissions */ public void setPermissions(final ScriptNode node, final Object permissions) { @@ -811,7 +812,7 @@ public class Site implements Serializable *

    * All permissions will be deleted and the node set to inherit permissions. * - * @param nodeRef node reference + * @param node node */ public void resetAllPermissions(ScriptNode node) { diff --git a/source/java/org/alfresco/repo/solr/NodeMetaData.java b/source/java/org/alfresco/repo/solr/NodeMetaData.java index 5ee8521518..c11a6b0630 100644 --- a/source/java/org/alfresco/repo/solr/NodeMetaData.java +++ b/source/java/org/alfresco/repo/solr/NodeMetaData.java @@ -134,7 +134,7 @@ public class NodeMetaData } /** * @param parentAssocs - * @param crc + * @param parentAssocsCrc */ 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 309cd7c4e5..c5bf1e796e 100644 --- a/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java +++ b/source/java/org/alfresco/repo/solr/SOLRTrackingComponent.java @@ -77,7 +77,6 @@ public interface SOLRTrackingComponent * Get the nodes satisfying the constraints in nodeParameters * * @param nodeParameters set of constraints for which nodes to return - * @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results * @param callback a callback to receive the results */ public void getNodes(NodeParameters nodeParameters, NodeQueryCallback callback); @@ -85,8 +84,8 @@ public interface SOLRTrackingComponent /** * Returns metadata for a set of node ids * - * @param nodeIds a set of nodeIds for which to return node metadata - * @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results + * @param nodeMetaDataParameters NodeMetaDataParameters + * @param resultFilter MetaDataResultsFilter * @param callback a callback to receive the results */ public void getNodesMetadata(NodeMetaDataParameters nodeMetaDataParameters, MetaDataResultsFilter resultFilter, NodeMetaDataQueryCallback callback); @@ -130,7 +129,7 @@ public interface SOLRTrackingComponent /** * Handle a node. * - * @param node the node meta data + * @param nodeMetaData the node meta data * @return Return true to continue processing rows or false to stop */ boolean handleNodeMetaData(NodeMetaData nodeMetaData); diff --git a/source/java/org/alfresco/repo/tagging/TagDetailsImpl.java b/source/java/org/alfresco/repo/tagging/TagDetailsImpl.java index adbb0d8db8..d318d7dc94 100644 --- a/source/java/org/alfresco/repo/tagging/TagDetailsImpl.java +++ b/source/java/org/alfresco/repo/tagging/TagDetailsImpl.java @@ -36,7 +36,6 @@ public class TagDetailsImpl implements TagDetails /** * Constructor * - * @param tagScope tag scope * @param tagName tag name * @param tagCount tag count */ @@ -47,7 +46,7 @@ public class TagDetailsImpl implements TagDetails } /** - * @see org.alfresco.service.cmr.tagging.TagDetails#getTagName() + * @see org.alfresco.service.cmr.tagging.TagDetails#getName() */ public String getName() { @@ -55,7 +54,7 @@ public class TagDetailsImpl implements TagDetails } /** - * @see org.alfresco.service.cmr.tagging.TagDetails#getTagCount() + * @see org.alfresco.service.cmr.tagging.TagDetails#getCount() */ public int getCount() { diff --git a/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java b/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java index a5994d1782..33664491ad 100644 --- a/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java +++ b/source/java/org/alfresco/repo/tagging/TaggingServiceImpl.java @@ -443,7 +443,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#isTag(java.lang.String) + * @see org.alfresco.service.cmr.tagging.TaggingService#isTag(StoreRef, java.lang.String) */ public boolean isTag(StoreRef storeRef, String tag) { @@ -452,7 +452,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#createTag(java.lang.String) + * @see org.alfresco.service.cmr.tagging.TaggingService#createTag(StoreRef, java.lang.String) */ public NodeRef createTag(StoreRef storeRef, String tag) { @@ -517,7 +517,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#getTags() + * @see org.alfresco.service.cmr.tagging.TaggingService#getTags(StoreRef) */ public List getTags(StoreRef storeRef) { @@ -1056,7 +1056,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#refreshTagScopt(org.alfresco.service.cmr.repository.NodeRef, boolean) + * @see org.alfresco.service.cmr.tagging.TaggingService#refreshTagScope(org.alfresco.service.cmr.repository.NodeRef, boolean) */ public void refreshTagScope(NodeRef nodeRef, boolean async) { @@ -1207,7 +1207,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(java.lang.String) + * @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(StoreRef, java.lang.String) */ public List findTaggedNodes(StoreRef storeRef, String tag) { @@ -1232,7 +1232,7 @@ public class TaggingServiceImpl implements TaggingService, } /** - * @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(java.lang.String, org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(StoreRef, java.lang.String, org.alfresco.service.cmr.repository.NodeRef) */ public List findTaggedNodes(StoreRef storeRef, String tag, NodeRef nodeRef) { @@ -1415,7 +1415,7 @@ public class TaggingServiceImpl implements TaggingService, /** * Records the fact that the given tag for the given node will need to * be added or removed from its parent tags scopes. - * {@link #updateTagScope(NodeRef, Map, boolean)} will schedule the update + * {@link #updateTagScope(NodeRef, Map)} will schedule the update * to occur, and an async action will do it. */ @SuppressWarnings("unchecked") diff --git a/source/java/org/alfresco/repo/template/XSLTProcessor.java b/source/java/org/alfresco/repo/template/XSLTProcessor.java index e83c9b8461..d9c5e14784 100644 --- a/source/java/org/alfresco/repo/template/XSLTProcessor.java +++ b/source/java/org/alfresco/repo/template/XSLTProcessor.java @@ -123,7 +123,7 @@ public class XSLTProcessor extends BaseProcessor implements TemplateProcessor /** * @param templateSource - * @param xsltModel + * @param model * @param out */ private void process(TemplateSource templateSource, Object model, Writer out) diff --git a/source/java/org/alfresco/repo/thumbnail/AddFailedThumbnailActionExecuter.java b/source/java/org/alfresco/repo/thumbnail/AddFailedThumbnailActionExecuter.java index b9a32e07ea..458649989a 100644 --- a/source/java/org/alfresco/repo/thumbnail/AddFailedThumbnailActionExecuter.java +++ b/source/java/org/alfresco/repo/thumbnail/AddFailedThumbnailActionExecuter.java @@ -136,13 +136,13 @@ public class AddFailedThumbnailActionExecuter extends ActionExecuterAbstractBase public void setBehaviourFilter(BehaviourFilter behaviourFilter) { this.behaviourFilter = behaviourFilter; - } - - /** - * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.repository.NodeRef, NodeRef) - */ - public void executeImpl(final Action ruleAction, final NodeRef actionedUponNodeRef) - { + } + + /** + * @see org.alfresco.repo.action.executer.ActionExecuter#execute(org.alfresco.service.cmr.action.Action, NodeRef) + */ + public void executeImpl(final Action ruleAction, final NodeRef actionedUponNodeRef) + { // This logic must always be executed as the 'system' user as it is possible that // a user with read-only access to a node will trigger a thumbnail failure and thereby // trigger the execution of this action. diff --git a/source/java/org/alfresco/repo/thumbnail/FailureHandlingOptions.java b/source/java/org/alfresco/repo/thumbnail/FailureHandlingOptions.java index 653dc93271..02c01608c1 100644 --- a/source/java/org/alfresco/repo/thumbnail/FailureHandlingOptions.java +++ b/source/java/org/alfresco/repo/thumbnail/FailureHandlingOptions.java @@ -74,13 +74,13 @@ public class FailureHandlingOptions { this.quietPeriodRetriesEnabled = quietPeriodRetriesEnabled; } - - /** - * Sets the initial minimum retry period for thumbnail creation/update. - * @param initialMinimumRetryPeriod minimum retry period in ms. - */ - public void setRetryPeriod(long retryPeriod) - { + + /** + * Sets the initial minimum retry period for thumbnail creation/update. + * @param retryPeriod minimum retry period in ms. + */ + public void setRetryPeriod(long retryPeriod) + { this.retryPeriod = retryPeriod; } @@ -88,13 +88,13 @@ public class FailureHandlingOptions { return this.retryPeriod; } - - /** - * Sets the minimum retry period for thumbnail creation/update. - * @param minimumRetryPeriodLong minimum retry period in ms. - */ - public void setQuietPeriod(long quietPeriod) - { + + /** + * Sets the minimum retry period for thumbnail creation/update. + * @param quietPeriod minimum retry period in ms. + */ + public void setQuietPeriod(long quietPeriod) + { this.quietPeriod = quietPeriod; } diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java index 9ef960dcc6..502d0425e7 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java @@ -411,7 +411,7 @@ public class ThumbnailRegistry implements ApplicationContextAware, ApplicationLi /** * Get the definition of a named thumbnail * - * @param thumbnailNam the thumbnail name + * @param thumbnailName the thumbnail name * @return ThumbnailDetails the details of the thumbnail */ public ThumbnailDefinition getThumbnailDefinition(String thumbnailName) diff --git a/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java b/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java index 7a26173bed..2de28087ec 100644 --- a/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java +++ b/source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImpl.java @@ -611,7 +611,7 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Creates a {@link RenditionDefinition} with no parameters set. - * @param thumbnailName + * @param thumbnailQName * @param transformationOptions * @return */ @@ -631,7 +631,7 @@ public class ThumbnailServiceImpl implements ThumbnailService, * @param contentProperty * @param mimetype * @param transformationOptions - * @param thumbnailName + * @param thumbnailQName * @param assocDetails * @return */ @@ -675,7 +675,7 @@ public class ThumbnailServiceImpl implements ThumbnailService, /** * Sets the thumbnail name if the rendition is of type cm:thumbnail. - * @param thumbnailAssoc + * @param thumbnail * @param thumbnailName */ private void setThumbnailNameProperty(NodeRef thumbnail, String thumbnailName) diff --git a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java index 39ace4ca58..e382b831fc 100644 --- a/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java +++ b/source/java/org/alfresco/repo/thumbnail/script/ScriptThumbnailService.java @@ -79,7 +79,7 @@ public class ScriptThumbnailService extends BaseScopableProcessorExtension /** * Gets the resource path for the place holder thumbnail for the given named thumbnail and the given mime type. * If there is no icon available for the specified MIME type, a generic icon will be used instead. - * The generic icon is that returned by {@link getPlaceHolderResourcePath(String)} + * The generic icon is that returned by {@link #getPlaceHolderResourcePath(String)} * If neither a MIME-specific icon nor a generic icon is available, null is returned. * * @param thumbnailName the thumbnail name diff --git a/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java b/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java index d49644ae38..be3bc1cafb 100644 --- a/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java +++ b/source/java/org/alfresco/repo/transaction/AlfrescoTransactionSupport.java @@ -261,13 +261,13 @@ public abstract class AlfrescoTransactionSupport extends TransactionSupportUtil /** * Method that registers a Listener against * the transaction. - *

    will be better for the caller - * to only bind once per transaction, if possible. - * - * @param indexerAndSearcher the Lucene indexer to perform transaction completion - * tasks on - * - * @since 5.0 + *

    will be better for the caller + * to only bind once per transaction, if possible. + * + * @param listener the transaction listener + * tasks on + * + * @since 5.0 */ public static void bindListener(TransactionListener listener) { diff --git a/source/java/org/alfresco/repo/transaction/TransactionUtil.java b/source/java/org/alfresco/repo/transaction/TransactionUtil.java index 39237e4ff6..fafbf0c19f 100644 --- a/source/java/org/alfresco/repo/transaction/TransactionUtil.java +++ b/source/java/org/alfresco/repo/transaction/TransactionUtil.java @@ -146,8 +146,6 @@ public class TransactionUtil * * @param transactionService the transaction service * @param transactionWork the transaction work - * @param ignoreException indicates whether errors raised in the work are - * ignored or re-thrown * @param nonPropagatingUserTransaction indicates whether the transaction * should be non propigating or not * @param readOnly true if the transaction should be read-only diff --git a/source/java/org/alfresco/repo/transfer/AlienProcessor.java b/source/java/org/alfresco/repo/transfer/AlienProcessor.java index 97013ab81c..3f06a54202 100644 --- a/source/java/org/alfresco/repo/transfer/AlienProcessor.java +++ b/source/java/org/alfresco/repo/transfer/AlienProcessor.java @@ -60,12 +60,12 @@ public interface AlienProcessor /** * Called before deleting an alien node. - *

    - * The tree needs to be walked upwards to take account of the removed alien node. - * - * @param nodeBeingDeleted node about to be deleted - * @param oldRef null if the deleted node is still "in place" and readable else the old ref prior to - * the node being moved. - */ + *

    + * The tree needs to be walked upwards to take account of the removed alien node. + * + * @param deletedNodeRef node about to be deleted + * @param oldRef null if the deleted node is still "in place" and readable else the old ref prior to + * the node being moved. + */ public void beforeDeleteAlien(NodeRef deletedNodeRef, ChildAssociationRef oldRef); } diff --git a/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java b/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java index 53527134af..7a11ac5dbf 100644 --- a/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/AlienProcessorImpl.java @@ -508,7 +508,7 @@ public class AlienProcessorImpl implements AlienProcessor * The retreat will stop is there is a "sub-invasion". *

    * @param nodeRef the top of the tree - * @param repoId the repository that is retreating. + * @param fromRepositoryId the repository that is retreating. */ private void retreatDownwards(NodeRef nodeRef, String fromRepositoryId) { diff --git a/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java b/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java index c6bc183611..b8786944ac 100644 --- a/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.java +++ b/source/java/org/alfresco/repo/transfer/ChildAssociatedNodeFinder.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 . */ @@ -48,7 +48,7 @@ import org.alfresco.service.namespace.RegexQNamePattern; crawler.setNodeFinders(new ChildAssociatedNodeFinder(ContentModel.ASSOC_CONTAINS)); Set crawledNodes = crawler.crawl(rootNode); - * @see NodeCrawlerFactory + * @see org.alfresco.service.cmr.transfer.NodeCrawlerFactory * */ public class ChildAssociatedNodeFinder extends AbstractNodeFinder @@ -122,7 +122,6 @@ public class ChildAssociatedNodeFinder extends AbstractNodeFinder /** * @param thisNode - * @param serviceRegistry * @return */ private Set processExcludedSet(NodeRef thisNode) diff --git a/source/java/org/alfresco/repo/transfer/ContentClassFilter.java b/source/java/org/alfresco/repo/transfer/ContentClassFilter.java index 9be94cf3fb..4e3ca001d8 100644 --- a/source/java/org/alfresco/repo/transfer/ContentClassFilter.java +++ b/source/java/org/alfresco/repo/transfer/ContentClassFilter.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 . */ @@ -82,9 +82,6 @@ public class ContentClassFilter extends AbstractNodeFilter return (!exclude && (typeIsInSet || aspectIsInSet)) || (exclude && (!typeIsInSet && !aspectIsInSet)); } - /** - * @param serviceRegistry - */ public void init() { super.init(); diff --git a/source/java/org/alfresco/repo/transfer/ContentDataPart.java b/source/java/org/alfresco/repo/transfer/ContentDataPart.java index 343bc5c8e6..f1330ceef2 100644 --- a/source/java/org/alfresco/repo/transfer/ContentDataPart.java +++ b/source/java/org/alfresco/repo/transfer/ContentDataPart.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 . */ @@ -47,9 +47,9 @@ public class ContentDataPart extends PartBase /** * ContentDataPart - * @param contentService + * @param contentService content service * @param partName - * @param data + * @param data data */ public ContentDataPart(ContentService contentService, String partName, ContentData data) { super(partName, data.getMimetype(), data.getEncoding(), null); @@ -62,7 +62,7 @@ public class ContentDataPart extends PartBase * Write the disposition header to the output stream * @param out The output stream * @throws IOException If an IO problem occurs - * @see Part#sendDispositionHeader(OutputStream) + * @see org.apache.commons.httpclient.methods.multipart.Part#sendDispositionHeader(OutputStream) */ protected void sendDispositionHeader(OutputStream out) throws IOException { diff --git a/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java b/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java index e0f16c6528..937f8f994c 100644 --- a/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.java +++ b/source/java/org/alfresco/repo/transfer/LoggingTransferProgressMonitorImpl.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 . */ @@ -60,7 +60,7 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit * @param obj * @param ex * @throws TransferException - * @see org.alfresco.repo.transfer.TransferProgressMonitor#log(java.lang.String, java.lang.Object, java.lang.Throwable) + * @see org.alfresco.repo.transfer.TransferProgressMonitor#logException(java.lang.String, java.lang.Object, java.lang.Throwable) */ public void logException(String transferId, Object obj, Throwable ex) throws TransferException { @@ -72,7 +72,7 @@ public class LoggingTransferProgressMonitorImpl implements TransferProgressMonit * @param transferId * @param obj * @throws TransferException - * @see org.alfresco.repo.transfer.TransferProgressMonitor#log(java.lang.String, java.lang.Object) + * @see org.alfresco.repo.transfer.TransferProgressMonitor#logComment(java.lang.String, java.lang.Object) */ public void logComment(String transferId, Object obj) throws TransferException { diff --git a/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java b/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java index cb7d197ddd..b6a4ed758e 100644 --- a/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.java +++ b/source/java/org/alfresco/repo/transfer/PeerAssociatedNodeFinder.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 . */ @@ -113,7 +113,6 @@ public class PeerAssociatedNodeFinder extends AbstractNodeFinder /** * @param thisNode - * @param serviceRegistry * @return */ 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 186f7f6561..ec74689b01 100644 --- a/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoPrimaryManifestProcessorImpl.java @@ -397,7 +397,8 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB /** * Delete this node - * @param exNode + * @param node + * @param nodeToDelete */ protected void delete(TransferManifestDeletedNode node, NodeRef nodeToDelete) { @@ -758,7 +759,7 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB * The noderef of the existing node in the local repo that is to be updated with these properties. May be * null, indicating that these properties are destined for a brand new local node. * @param props the new properties - * @param the existing properties, null if this is a create + * @param existingProps the existing properties, null if this is a create * @return A map containing the content properties which are going to be replaced from the supplied "props" map */ private Map processProperties(NodeRef nodeToUpdate, Map props, @@ -847,7 +848,6 @@ public class RepoPrimaryManifestProcessorImpl extends AbstractManifestProcessorB } /** - * @param node * @param nodeToUpdate * @param contentProps */ diff --git a/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java b/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java index fc3c8de39b..2290a9056c 100644 --- a/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoSecondaryManifestProcessorImpl.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 . */ @@ -119,7 +119,7 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso * * @param requiredAssocs * @param currentAssocs - * @param correspondingNodeRef + * @param nodeRef * @param isSource */ private void processPeerAssociations(List requiredAssocs, @@ -329,9 +329,7 @@ public class RepoSecondaryManifestProcessorImpl extends AbstractManifestProcesso /** * - * @param sourceRef - * @param targetRef - * @param assocTypeQName + * @param ref */ public AssociationRefKey(AssociationRef ref) { diff --git a/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java b/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java index f4c4b57851..f621a2f148 100644 --- a/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java +++ b/source/java/org/alfresco/repo/transfer/RepoTransferReceiverImpl.java @@ -719,13 +719,13 @@ public class RepoTransferReceiverImpl implements TransferReceiver, lock.enableLockTimeout(); } - } - - /** - * @param stagingFolder - */ - private void deleteFile(File file) - { + } + + /** + * @param file + */ + private void deleteFile(File file) + { if (file.isDirectory()) { File[] fileList = file.listFiles(); @@ -1495,13 +1495,13 @@ public class RepoTransferReceiverImpl implements TransferReceiver, } - /** - * Make the lock - called on main thread - * - * @throws LockAquisitionException - */ - public synchronized void makeLock() - { + /** + * Make the lock - called on main thread + * + * @throws org.alfresco.repo.lock.LockAcquisitionException + */ + public synchronized void makeLock() + { if(log.isDebugEnabled()) { log.debug("makeLock" + lockQName); diff --git a/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java b/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java index 7e572cf27b..377345bb05 100644 --- a/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.java +++ b/source/java/org/alfresco/repo/transfer/StandardNodeCrawlerImpl.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 . */ @@ -69,8 +69,8 @@ public class StandardNodeCrawlerImpl implements NodeCrawler } /** - * @param nodeService - * the nodeService to set + * @param serviceRegistry + * the serviceRegistry to set */ public void setServiceRegistry(ServiceRegistry serviceRegistry) { diff --git a/source/java/org/alfresco/repo/transfer/TransferCommons.java b/source/java/org/alfresco/repo/transfer/TransferCommons.java index 4beab04ed4..d3f7401642 100644 --- a/source/java/org/alfresco/repo/transfer/TransferCommons.java +++ b/source/java/org/alfresco/repo/transfer/TransferCommons.java @@ -76,7 +76,7 @@ public class TransferCommons /** * Mapping between contentUrl and part name. * - * @param URL + * @param contentUrl * @return the part name */ public final static String URLToPartName(String contentUrl) diff --git a/source/java/org/alfresco/repo/transfer/TransferEventImpl.java b/source/java/org/alfresco/repo/transfer/TransferEventImpl.java index 3fddea80bf..d5c36bb42f 100644 --- a/source/java/org/alfresco/repo/transfer/TransferEventImpl.java +++ b/source/java/org/alfresco/repo/transfer/TransferEventImpl.java @@ -26,7 +26,7 @@ import org.alfresco.service.cmr.transfer.TransferEvent; * An abstract implementation of TransferEvent. * Also implements the operations required by RangedTransferEvent. * @see TransferEvent - * @see RangedTransferEvent + * @see org.alfresco.service.cmr.transfer.RangedTransferEvent */ public abstract class TransferEventImpl implements TransferEvent { diff --git a/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java b/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java index d0001fc851..c31b791b20 100644 --- a/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java +++ b/source/java/org/alfresco/repo/transfer/TransferEventProcessor.java @@ -110,7 +110,6 @@ public class TransferEventProcessor /** * - * @param data * @param range * @param position */ diff --git a/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java b/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java index 3c16f08a7d..8c61bb1ce4 100644 --- a/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.java +++ b/source/java/org/alfresco/repo/transfer/TransferProgressMonitor.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 . */ @@ -68,7 +68,6 @@ public interface TransferProgressMonitor * @param sourceNode * @param destNode * @param path The path of the updated node - * @param orphan */ void logUpdated(String transferId, NodeRef sourceNode, NodeRef destNode, String path); @@ -79,7 +78,6 @@ public interface TransferProgressMonitor * @param sourceNode * @param destNode * @param path The path of the deleted node - * @param orphan */ void logDeleted(String transferId, NodeRef sourceNode, NodeRef destNode, String path); diff --git a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeFactory.java b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeFactory.java index a5e954aa13..5b62ad9728 100644 --- a/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeFactory.java +++ b/source/java/org/alfresco/repo/transfer/manifest/TransferManifestNodeFactory.java @@ -26,7 +26,7 @@ public interface TransferManifestNodeFactory { /** * Create an object that represents the specified node in a form that can be used to transfer it elsewhere. - * Calling this operation is identical to calling {@link TransferManifestNodeFactory#createTransferManifestNode(NodeRef, TransferDefinition, boolean)} + * Calling this operation is identical to calling {@link TransferManifestNodeFactory#createTransferManifestNode(NodeRef, TransferDefinition, TransferContext, boolean)} * specifying false as the value of the forceDelete parameter. * @param nodeRef The identifier of the node to be distilled for transfer * @param definition The transfer definition against which the node is being transferred diff --git a/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestReader.java b/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestReader.java index 2153d79a1e..5070538648 100644 --- a/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestReader.java +++ b/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestReader.java @@ -718,7 +718,7 @@ public class XMLTransferManifestReader extends DefaultHandler implements Content } /** - * @param uri + * @param namespaceURI * @return the prefix */ public Collection getPrefixes(String namespaceURI) throws NamespaceException diff --git a/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestWriter.java b/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestWriter.java index ee0342dcc9..abe56dbe60 100644 --- a/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestWriter.java +++ b/source/java/org/alfresco/repo/transfer/manifest/XMLTransferManifestWriter.java @@ -259,7 +259,7 @@ public class XMLTransferManifestWriter implements TransferManifestWriter /** * Write a normal transfer manifest node * - * @param nodeRef + * @param node * @throws SAXException */ public void writeTransferManifestNode(TransferManifestNormalNode node) throws SAXException diff --git a/source/java/org/alfresco/repo/transfer/report/TransferReporter.java b/source/java/org/alfresco/repo/transfer/report/TransferReporter.java index 6f43364293..36b04748ef 100644 --- a/source/java/org/alfresco/repo/transfer/report/TransferReporter.java +++ b/source/java/org/alfresco/repo/transfer/report/TransferReporter.java @@ -36,13 +36,13 @@ public interface TransferReporter /** * Create a transfer report of success + * @param transferName - the unique name of this transfer - probably based upon the time of transfer. + * @param transfer the transfer. * @param target the target of the transfer * @param definition the definition of the transfer * @param events the transfer events generated by the transfer. * @param snapshotFile the snapshot file - * @param destinationReport the destination report, may be null if it does not exist. - * @param transferName - the unique name of this transfer - probably based upon the time of transfer. - * + * * @return the node ref of the transfer report */ public NodeRef createTransferReport(String transferName, @@ -76,7 +76,6 @@ public interface TransferReporter * * @param transferName the unique name of this transfer - probably based upon the time of transfer. * @param target the target of the transfer - * @param definition the definition of the transfer * @param tempFile the temporary file containing the contents of the destination side transfer report. * @return the node ref of the transfer report */ diff --git a/source/java/org/alfresco/repo/transfer/requisite/TransferRequsiteWriter.java b/source/java/org/alfresco/repo/transfer/requisite/TransferRequsiteWriter.java index 2350aa7ff4..7bba11c1ca 100644 --- a/source/java/org/alfresco/repo/transfer/requisite/TransferRequsiteWriter.java +++ b/source/java/org/alfresco/repo/transfer/requisite/TransferRequsiteWriter.java @@ -37,7 +37,6 @@ public interface TransferRequsiteWriter /** * - * @param writer */ void startTransferRequsite() ; diff --git a/source/java/org/alfresco/repo/transfer/requisite/XMLTransferRequsiteReader.java b/source/java/org/alfresco/repo/transfer/requisite/XMLTransferRequsiteReader.java index 2c017db635..ff2460c02c 100644 --- a/source/java/org/alfresco/repo/transfer/requisite/XMLTransferRequsiteReader.java +++ b/source/java/org/alfresco/repo/transfer/requisite/XMLTransferRequsiteReader.java @@ -107,7 +107,7 @@ public class XMLTransferRequsiteReader extends DefaultHandler implements Content } /** - * @param uri + * @param namespaceURI * @return the prefix */ public Collection getPrefixes(String namespaceURI) throws NamespaceException diff --git a/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java b/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java index 92bfcbe0d4..6b4056b123 100644 --- a/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java +++ b/source/java/org/alfresco/repo/transfer/script/ScriptTransferService.java @@ -121,7 +121,7 @@ public class ScriptTransferService extends BaseScopableProcessorExtension * Nodes are to be locked read only on target. * * @param targetName the name of the target to transfer to - * @param nodes the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String + * @param nodesToTransfer the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String * @return node ref of transfer report. */ @SuppressWarnings("unchecked") @@ -178,7 +178,7 @@ public class ScriptTransferService extends BaseScopableProcessorExtension * Nodes are not locked on the target. * * @param targetName the name of the target to transfer to - * @param nodes the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String + * @param nodesToTransfer the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String * @return node ref of transfer report. */ @SuppressWarnings("unchecked") @@ -234,7 +234,7 @@ public class ScriptTransferService extends BaseScopableProcessorExtension * Nodes are not locked on the target. * * @param targetName the name of the target to transfer to - * @param nodes the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String + * @param nodesToRemove the nodes to transfer - Java Script Array of either ScriptNodes, NodeRef or String * @return node ref of transfer report. */ @SuppressWarnings("unchecked") diff --git a/source/java/org/alfresco/repo/usage/ContentUsageImpl.java b/source/java/org/alfresco/repo/usage/ContentUsageImpl.java index f00e0991fc..a0949b3cf0 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 userName - * @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 + */ + 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 - * @param currentQuota - */ - 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 662cd544d8..414c69548a 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() 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 {@link #updateUsage(UsageType) 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/NodeServiceImpl.java b/source/java/org/alfresco/repo/version/NodeServiceImpl.java index 198c5cfdb8..845a125d3a 100644 --- a/source/java/org/alfresco/repo/version/NodeServiceImpl.java +++ b/source/java/org/alfresco/repo/version/NodeServiceImpl.java @@ -647,13 +647,13 @@ public class NodeServiceImpl implements NodeService, VersionModel throw new UnsupportedOperationException(MSG_UNSUPPORTED); } - /** - * Gets an association by ID. - * - * @param assocId - * the association id - * @return the association, or null if it does not exist - */ + /** + * Gets an association by ID. + * + * @param id + * the association id + * @return the association, or null if it does not exist + */ public AssociationRef getAssoc(Long id) { return null; diff --git a/source/java/org/alfresco/repo/version/Version2ServiceImpl.java b/source/java/org/alfresco/repo/version/Version2ServiceImpl.java index 3749c3c6ee..865aa2c5a6 100644 --- a/source/java/org/alfresco/repo/version/Version2ServiceImpl.java +++ b/source/java/org/alfresco/repo/version/Version2ServiceImpl.java @@ -439,12 +439,12 @@ public class Version2ServiceImpl extends VersionServiceImpl implements VersionSe /** * Creates a new version node, setting the properties both calculated and specified. * - * @param versionableNodeRef the reference to the node being versioned + * @param sourceTypeRef the reference to the node being versioned * @param versionHistoryRef version history node reference - * @param preceedingNodeRef the version node preceeding this in the version history - * , null if none + * @param standardVersionProperties version properties * @param versionProperties version properties * @param versionNumber the version number + * @param nodeDetails PolicyScope * @return the version node reference */ protected NodeRef createNewVersion( diff --git a/source/java/org/alfresco/repo/version/VersionServiceImpl.java b/source/java/org/alfresco/repo/version/VersionServiceImpl.java index bad29dec01..b2408fe283 100644 --- a/source/java/org/alfresco/repo/version/VersionServiceImpl.java +++ b/source/java/org/alfresco/repo/version/VersionServiceImpl.java @@ -203,7 +203,7 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl } /** - * @see VersionCounterService#nextVersionNumber(StoreRef) + * @see VersionService#createVersion(NodeRef, Map) */ public Version createVersion( NodeRef nodeRef, @@ -352,7 +352,7 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl * accordingly. * * @param nodeRef a node reference - * @param versionProperties the version properties + * @param origVersionProperties the version properties * @param versionNumber the version number * @return the newly created version * @throws ReservedVersionNameException @@ -592,10 +592,9 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl * * @param versionableNodeRef the reference to the node being versioned * @param versionHistoryRef version history node reference - * @param preceedingNodeRef the version node preceeding this in the version history - * , null if none + * @param standardVersionProperties version properties * @param versionProperties version properties - * @param versionNumber the version number + * @param nodeDetails PolicyScope * @return the version node reference */ private NodeRef createNewVersion( @@ -950,7 +949,7 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl } /** - * @see org.alfresco.cms.version.VersionService#ensureVersioningEnabled(NodeRef,Map) + * @see VersionService#ensureVersioningEnabled(NodeRef,Map) */ public void ensureVersioningEnabled(NodeRef nodeRef, Map versionProperties) { @@ -1312,7 +1311,7 @@ public abstract class VersionServiceImpl extends AbstractVersionServiceImpl impl } /** - * @see org.alfresco.cms.version.VersionService#deleteVersionHistory(NodeRef) + * @see VersionService#deleteVersionHistory(NodeRef) */ public void deleteVersionHistory(NodeRef nodeRef) throws AspectMissingException diff --git a/source/java/org/alfresco/repo/version/VersionServicePolicies.java b/source/java/org/alfresco/repo/version/VersionServicePolicies.java index d41627ac67..9205824fcc 100644 --- a/source/java/org/alfresco/repo/version/VersionServicePolicies.java +++ b/source/java/org/alfresco/repo/version/VersionServicePolicies.java @@ -97,26 +97,27 @@ public interface VersionServicePolicies PolicyScope nodeDetails); } - /** - * - * Called for all types and aspects before reverting a node. - * - * @param classRef the type or aspect qualified name - * @param revertDetails the details of the impending revert - * @return Return the callback that will be used to modify the revert behaviour for this - * type or aspect. Return null to assume the default. - * - * - * @since V4.2 - */ + public interface OnRevertVersionPolicy extends ClassPolicy { public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "getRevertVersionCallback"); - + + /** + * + * Called for all types and aspects before reverting a node. + * + * @param classRef the type or aspect qualified name + * @param copyDetails the details of the impending revert + * @return Return the callback that will be used to modify the revert behaviour for this + * type or aspect. Return null to assume the default. + * + * + * @since V4.2 + */ VersionRevertCallback getRevertVersionCallback(QName classRef, VersionRevertDetails copyDetails); } - + /** * Calculate version lable policy interface */ @@ -128,8 +129,8 @@ public interface VersionServicePolicies int versionNumber, MapverisonProperties); } - - + + /** * After create version policy interface * @@ -138,11 +139,11 @@ public interface VersionServicePolicies { public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "afterVersionRevert"); /** - * Called after the version has been reverted - * + * Called after the version has been reverted + * * @param nodeRef the node that has been reverted * @param version the reverted version */ public void afterVersionRevert(NodeRef nodeRef, Version version); - } + } } diff --git a/source/java/org/alfresco/repo/version/common/VersionLabelComparator.java b/source/java/org/alfresco/repo/version/common/VersionLabelComparator.java index 7ed1b14aa2..a52aa41e90 100644 --- a/source/java/org/alfresco/repo/version/common/VersionLabelComparator.java +++ b/source/java/org/alfresco/repo/version/common/VersionLabelComparator.java @@ -28,7 +28,7 @@ import org.alfresco.util.VersionNumber; * * @author Yanick Pignot * - * @deprecated See {@link VersionHistory} + * @deprecated See {@link org.alfresco.service.cmr.version.VersionHistory} */ public class VersionLabelComparator implements Comparator { diff --git a/source/java/org/alfresco/repo/version/common/VersionUtil.java b/source/java/org/alfresco/repo/version/common/VersionUtil.java index 02b5682fd3..8185329236 100644 --- a/source/java/org/alfresco/repo/version/common/VersionUtil.java +++ b/source/java/org/alfresco/repo/version/common/VersionUtil.java @@ -66,7 +66,7 @@ public class VersionUtil * Checks that the names of the additional version properties are valid and that they do not clash * with the reserved properties. * - * @param versionProperties the property names + * @param names the property names * @return true is the names are considered valid, false otherwise * @throws ReservedVersionNameException */ @@ -85,7 +85,7 @@ public class VersionUtil /** * Create Version Store Ref * - * @param store ref + * @param storeRef ref * @return store ref for version store */ public static StoreRef convertStoreRef(StoreRef storeRef) diff --git a/source/java/org/alfresco/repo/version/common/versionlabel/SerialVersionLabelPolicy.java b/source/java/org/alfresco/repo/version/common/versionlabel/SerialVersionLabelPolicy.java index 1b2dd26ebc..3ad837e1f7 100644 --- a/source/java/org/alfresco/repo/version/common/versionlabel/SerialVersionLabelPolicy.java +++ b/source/java/org/alfresco/repo/version/common/versionlabel/SerialVersionLabelPolicy.java @@ -39,9 +39,9 @@ public class SerialVersionLabelPolicy implements CalculateVersionLabelPolicy /** * Get the version label value base on the data provided. - * + * + * @param classRef QName * @param preceedingVersion the preceeding version, null if none - * @param versionNumber the new version number * @param versionProperties the version property values * @return the version label */ @@ -123,7 +123,7 @@ public class SerialVersionLabelPolicy implements CalculateVersionLabelPolicy /** * Constructor * - * @param version the vesion to take the version from + * @param versionLabel the vesion label to take the version from */ public SerialVersionLabel(String versionLabel) { diff --git a/source/java/org/alfresco/repo/webdav/LockInfo.java b/source/java/org/alfresco/repo/webdav/LockInfo.java index b8465cc159..beb5bef760 100644 --- a/source/java/org/alfresco/repo/webdav/LockInfo.java +++ b/source/java/org/alfresco/repo/webdav/LockInfo.java @@ -168,13 +168,13 @@ 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 lockTimeout - */ - 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 + */ + 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. diff --git a/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java b/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java index d87befa057..7423a3ef98 100644 --- a/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java +++ b/source/java/org/alfresco/repo/workflow/AbstractWorkflowPropertyHandler.java @@ -43,13 +43,12 @@ public abstract class AbstractWorkflowPropertyHandler implements WorkflowPropert private static final TypeConverter typeConverter = DefaultTypeConverter.INSTANCE; protected WorkflowNodeConverter nodeConverter; - protected MessageService messageService; - - /** - * @param task - * @param value - * @param assocDef - */ + protected MessageService messageService; + + /** + * @param value + * @param assocDef + */ protected Object handleAssociation(Serializable value, AssociationDefinition assocDef) { if (assocDef.isProtected()) @@ -58,13 +57,12 @@ public abstract class AbstractWorkflowPropertyHandler implements WorkflowPropert } // Convert association to ActivitiScriptNode / List return convertAssociationValue(assocDef, value); - } - - /** - * @param task - * @param value - * @param propDef - * @return + } + + /** + * @param value + * @param propDef + * @return */ protected Object handleProperty(Serializable value, PropertyDefinition propDef) { diff --git a/source/java/org/alfresco/repo/workflow/TaskComponent.java b/source/java/org/alfresco/repo/workflow/TaskComponent.java index 0542eafea2..e32bb0285b 100644 --- a/source/java/org/alfresco/repo/workflow/TaskComponent.java +++ b/source/java/org/alfresco/repo/workflow/TaskComponent.java @@ -58,7 +58,7 @@ public interface TaskComponent /** * Gets the pooled tasks available to the specified authority * - * @param authority the authority + * @param authorities the list of authorities * @param lazyInitialization hint in order to return partially-initialized entities * @return the list of pooled tasks */ @@ -123,7 +123,7 @@ public interface TaskComponent * End the Task (i.e. complete the task) * * @param taskId the task id to end - * @param transition the task transition to take on completion (or null, for the default transition) + * @param transitionId the task transition id to take on completion (or null, for the default transition) * @return the updated task */ public WorkflowTask endTask(String taskId, String transitionId); diff --git a/source/java/org/alfresco/repo/workflow/TaskUpdater.java b/source/java/org/alfresco/repo/workflow/TaskUpdater.java index 4daf2ebcae..c5864e80f3 100644 --- a/source/java/org/alfresco/repo/workflow/TaskUpdater.java +++ b/source/java/org/alfresco/repo/workflow/TaskUpdater.java @@ -98,7 +98,7 @@ public class TaskUpdater } /** - * @param suffix + * @param isAdd * @return */ 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 a125454df7..0bbdd2396f 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowAuthorityManager.java @@ -50,8 +50,8 @@ public class WorkflowAuthorityManager /** * Convert authority name to an Alfresco Authority * - * @param names - * the authority names to convert + * @param name + * the authority name to convert * @return the Alfresco authorities */ public NodeRef mapNameToAuthority(String name) diff --git a/source/java/org/alfresco/repo/workflow/WorkflowComponent.java b/source/java/org/alfresco/repo/workflow/WorkflowComponent.java index 6603f06132..2fdd814899 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowComponent.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowComponent.java @@ -289,7 +289,7 @@ public interface WorkflowComponent * process. * * @param pathId the workflow path to signal on - * @param transition the transition to follow (or null, for the default transition) + * @param transitionId the transition id to follow (or null, for the default transition) * @return the updated workflow path */ public WorkflowPath signal(String pathId, String transitionId); diff --git a/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java b/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java index 17d459c0d2..e970eae90d 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowDeployer.java @@ -100,7 +100,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Sets the Transaction Service * - * @param userTransaction the transaction service + * @param transactionService the transaction service */ public void setTransactionService(TransactionService transactionService) { @@ -150,7 +150,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Sets the tenant admin service * - * @param tenantService the tenant admin service + * @param tenantAdminService the tenant admin service */ public void setTenantAdminService(TenantAdminService tenantAdminService) { @@ -190,7 +190,7 @@ public class WorkflowDeployer extends AbstractLifecycleBean /** * Sets the initial list of Workflow resource bundles to bootstrap with * - * @param modelResources the model names + * @param labels the list of labels */ public void setLabels(List labels) { diff --git a/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java b/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java index 67a520a47a..1f5f564bc6 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowNodeConverter.java @@ -44,7 +44,7 @@ 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 value * @param isMany * @return */ diff --git a/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java b/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java index f09d01e9ec..21f6b500b5 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowNotificationUtils.java @@ -88,10 +88,9 @@ public class WorkflowNotificationUtils /** - * - * @param services + * * @param taskId - * @param title + * @param taskTitle * @param description * @param dueDate * @param priority @@ -186,8 +185,8 @@ public class WorkflowNotificationUtils /** * Send workflow assigned email notification. * - * @param services service registry * @param taskId workflow global task id + * @param taskType task type * @param assignedAuthorites assigned authorities * @param pooled true if pooled task, false otherwise */ @@ -215,8 +214,8 @@ public class WorkflowNotificationUtils /** * Send workflow assigned email notification. * - * @param services service registry * @param taskId workflow global task id + * @param taskType task type * @param assignedAuthority assigned authority * @param pooled true if pooled task, false otherwise */ diff --git a/source/java/org/alfresco/repo/workflow/WorkflowObjectFactory.java b/source/java/org/alfresco/repo/workflow/WorkflowObjectFactory.java index d274c836e3..3a6673c1dd 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowObjectFactory.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowObjectFactory.java @@ -97,9 +97,9 @@ public class WorkflowObjectFactory /** * Create a new {@link WorkflowDeployment}. - * @param wfDef - * @param problems - * @return + * @param wfDef WorkflowDefinition + * @param problems String + * @return WorkflowDeployment */ public WorkflowDeployment createDeployment(WorkflowDefinition wfDef, String... problems) { @@ -109,13 +109,13 @@ public class WorkflowObjectFactory /** * Create a new {@link WorkflowDefinition}. - * @param defId - * @param defName - * @param version - * @param defaultTitle - * @param startTaskDef - * @param processDef - * @return + * @param defId String + * @param defName String + * @param version int + * @param defaultTitle String + * @param defaultDescription String + * @param startTaskDef WorkflowTaskDefinition + * @return WorkflowDefinition */ public WorkflowDefinition createDefinition(String defId, String defName, int version, @@ -290,7 +290,7 @@ public class WorkflowObjectFactory * * @param displayId message resource id lookup * @param labelKey label to lookup (title or description) - * @param defaultLabel default value if not found in message resource bundle + * @param defaults default values if not found in message resource bundle * @return the label */ private String getLabel(String displayId, String labelKey, String... defaults) @@ -314,9 +314,9 @@ public class WorkflowObjectFactory } /** - * @param label - * @param defaults - * @return + * @param label String + * @param defaults String + * @return String */ private String getDefaultLabel(String label, String... defaults) { @@ -362,7 +362,7 @@ public class WorkflowObjectFactory /** * Throws exception if domain mismatch - * @param defName + * @param defName String */ public void checkDomain(String defName) { diff --git a/source/java/org/alfresco/repo/workflow/WorkflowPropertyConverter.java b/source/java/org/alfresco/repo/workflow/WorkflowPropertyConverter.java index 7956f2afa1..1e0157e889 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowPropertyConverter.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowPropertyConverter.java @@ -55,8 +55,8 @@ public class WorkflowPropertyConverter /** * Sets Properties of Task * - * @param instance - * task instance + * @param taskDef + * task definition * @param properties * properties to set */ diff --git a/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java b/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java index 84d6f9ba63..ba147ddf87 100644 --- a/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java +++ b/source/java/org/alfresco/repo/workflow/WorkflowServiceImpl.java @@ -1357,7 +1357,6 @@ public class WorkflowServiceImpl implements WorkflowService } /** - * @param contents * @param workflowPackage */ private List getRepositoryPackageContents(NodeRef workflowPackage) diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiTypeConverter.java index 50bcdbf071..5755c6e58b 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 completedInstances - * @param function - * @return - */ - public List doSpecialTenantFilterAndSafeConvert(List values, Function processKeyGetter) + * 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) { List filtered = factory.doSpecialTenantFilter(values, processKeyGetter); factory.setIgnoreTenantCheck(factory.isDefaultDomain()); @@ -146,13 +146,13 @@ public class ActivitiTypeConverter WorkflowDefinition wfDef = convert(processDef); return factory.createDeployment(wfDef); } - - /** - * Convert a {@link ProcessDefinition} into a {@link WorkflowDefinition}. - * @param processDef - * @return - */ - public WorkflowDefinition convert(ProcessDefinition definition) + + /** + * Convert a {@link ProcessDefinition} into a {@link WorkflowDefinition}. + * @param definition + * @return + */ + public WorkflowDefinition convert(ProcessDefinition definition) { if(definition==null) return null; @@ -206,13 +206,14 @@ public class ActivitiTypeConverter return factory.createTaskDefinition(taskDefId, node, taskDefId, false); } - - /** - * Get the taskDefinition key based on the Activiti task definition id, - * @param taskDefinitionId id of the {@link TaskDefinition} - * @return - */ - public WorkflowTaskDefinition getTaskDefinition(String taskDefinitionKey, String processDefinitionId) + + /** + * Get the taskDefinition key based on the Activiti task definition id, + * @param taskDefinitionKey + * @param processDefinitionId + * @return + */ + public WorkflowTaskDefinition getTaskDefinition(String taskDefinitionKey, String processDefinitionId) { ProcessDefinitionEntity procDef = (ProcessDefinitionEntity) activitiUtil.getDeployedProcessDefinition(processDefinitionId); Collection userTasks = findUserTasks(procDef.getInitial()); diff --git a/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowManagerFactory.java b/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowManagerFactory.java index 1f4972a7b7..7a4d253b53 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowManagerFactory.java +++ b/source/java/org/alfresco/repo/workflow/activiti/ActivitiWorkflowManagerFactory.java @@ -230,12 +230,12 @@ public class ActivitiWorkflowManagerFactory implements FactoryBean 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 d5fcb76e2a..3b49f18424 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 instance - * 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 @@ -543,13 +543,13 @@ public class ActivitiPropertyConverter return getHistoricVariables(query); } - /** - * Get all variable updates for activity, latest updates on top - * - * @param taskId - * @return - */ - public Map getHistoricActivityVariables(String activityId) + /** + * Get all variable updates for activity, latest updates on top + * + * @param activityId + * @return + */ + public Map getHistoricActivityVariables(String activityId) { HistoricDetailQuery query = activitiUtil.getHistoryService() .createHistoricDetailQuery() @@ -649,14 +649,15 @@ public class ActivitiPropertyConverter return property; } } - - /** - * Converts a {@link Serializable} value to the type of the specified property. - * @param value - * @param definition - * @return - */ - public Serializable convertValueToPropertyType(Task task, Serializable value, QName propertyName) + + /** + * 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) { TypeDefinition taskDef = typeManager.getFullTaskDefinition(task); PropertyDefinition propDef = taskDef.getProperties().get(propertyName); diff --git a/source/java/org/alfresco/repo/workflow/activiti/tasklistener/TaskNotificationListener.java b/source/java/org/alfresco/repo/workflow/activiti/tasklistener/TaskNotificationListener.java index 82c052d5c7..ad7f1e91f3 100644 --- a/source/java/org/alfresco/repo/workflow/activiti/tasklistener/TaskNotificationListener.java +++ b/source/java/org/alfresco/repo/workflow/activiti/tasklistener/TaskNotificationListener.java @@ -52,7 +52,7 @@ public class TaskNotificationListener implements TaskListener private ActivitiPropertyConverter propertyConverter; /** - * @param services the service registry + * @param service the service registry */ public void setWorkflowNotification(WorkflowNotificationUtils service) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java b/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java index 809d2736e8..7ef857765f 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/JBPMEngine.java @@ -216,9 +216,9 @@ 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"; - + // engine ID + public static final String ENGINE_ID = "jbpm"; + public JBPMEngine() { super(); @@ -226,9 +226,9 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine 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 + /** + * Sets the JBPM Template used for accessing JBoss JBPM in the correct + * context * * @param jbpmTemplate */ @@ -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) - */ + /* + * @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 - { + { + try + { return (WorkflowDeployment)jbpmTemplate.execute(new JbpmCallback() { public Object doInJbpm(JbpmContext context) @@ -2722,13 +2722,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** - * Construct a Process Definition from the provided Process Definition - * stream - * - * @param workflowDefinition - * 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 properties 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 properties 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) - { + */ + protected void setDefaultTaskProperties(TaskInstance instance) + { Map existingValues = getTaskProperties(instance, false); - Map defaultValues = new HashMap(); - - // construct an anonymous type that flattens all mandatory aspects + Map defaultValues = new HashMap(); + + // construct an anonymous type that flattens all mandatory aspects ClassDefinition classDef = getFullTaskDefinition(instance); Map propertyDefs = classDef.getProperties(); @@ -3463,13 +3463,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine return value; } - /** - * Convert person name to an Alfresco Person - * - * @param names - * 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 names - * 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; @@ -3586,14 +3586,12 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Creates a Workflow Path - * - * @param token - * JBoss JBPM Token - * @param wfInstance - * @param node - * @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; @@ -3772,13 +3770,13 @@ public class JBPMEngine extends AlfrescoBpmEngine implements WorkflowEngine /** * Creates a Workflow Task - * - * @param task - * JBoss Task Instance - * @param taskDef - * @param path - * @param properties - * @return Workflow Task + * + * @param task + * JBoss Task Instance + * @param definition task definition + * @param path + * @param properties + * @return Workflow Task */ private WorkflowTask createWorkflowTask(TaskInstance task, WorkflowTaskDefinition definition, WorkflowPath path, Map properties) { diff --git a/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java b/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java index 77a488f73c..67a1bc7a98 100644 --- a/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java +++ b/source/java/org/alfresco/repo/workflow/jbpm/NodeListConverter.java @@ -107,7 +107,7 @@ public class NodeListConverter extends SerializableToByteArrayConverter } /** - * @param nodeRefs + * @param value Object * @return */ @SuppressWarnings("unchecked") diff --git a/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java b/source/java/org/alfresco/repo/workflow/jscript/JscriptWorkflowTask.java index c05a1df003..962611ae3e 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 transition - * 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); } diff --git a/source/java/org/alfresco/service/cmr/action/ActionCondition.java b/source/java/org/alfresco/service/cmr/action/ActionCondition.java index a42231c4f1..7f1ae5b229 100644 --- a/source/java/org/alfresco/service/cmr/action/ActionCondition.java +++ b/source/java/org/alfresco/service/cmr/action/ActionCondition.java @@ -27,14 +27,12 @@ import org.alfresco.api.AlfrescoPublicApi; */ @AlfrescoPublicApi public interface ActionCondition extends ParameterizedItem -{ - /** - * Get the action condition definition name - * - * @param the action condition definition name - */ - public String getActionConditionDefinitionName(); - +{ + /** + * Get the action condition definition name + */ + public String getActionConditionDefinitionName(); + /** * Set whether the condition result should be inverted. *

    diff --git a/source/java/org/alfresco/service/cmr/action/ActionStatus.java b/source/java/org/alfresco/service/cmr/action/ActionStatus.java index c3af452fa5..83e3d873d8 100644 --- a/source/java/org/alfresco/service/cmr/action/ActionStatus.java +++ b/source/java/org/alfresco/service/cmr/action/ActionStatus.java @@ -53,19 +53,19 @@ public enum ActionStatus * {@link CancellableAction}, detected that a * cancellation was requested and cancelled itself. */ - Cancelled, - /** - * The Action failed to run to completion. Call - * {@link Action#getExecutionFailureCause()} to find - * out why. - */ - Failed, - /** - * The Action failed with a transient exception. Call - * {@link Action#getExecutionFailureCause()} to find - * out why. - * @since 4.0.1 - */ + Cancelled, + /** + * The Action failed to run to completion. Call + * {@link Action#getExecutionFailureMessage()} to find + * out why. + */ + Failed, + /** + * The Action failed with a transient exception. Call + * {@link Action#getExecutionFailureMessage()} to find + * out why. + * @since 4.0.1 + */ Declined ; diff --git a/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java b/source/java/org/alfresco/service/cmr/action/ActionTrackingService.java index f739f7ee55..76a6dfc33c 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 action The action to request the cancel of - */ - void requestActionCancellation(ExecutionSummary executionSummary); - + * If the specified action is not a cancellable + * action, nothing will happen. + * + * @param executionSummary + */ + void requestActionCancellation(ExecutionSummary executionSummary); + /** * Has cancellation been requested for the given * action? diff --git a/source/java/org/alfresco/service/cmr/activities/ActivityService.java b/source/java/org/alfresco/service/cmr/activities/ActivityService.java index aae6e27311..d075639fb4 100644 --- a/source/java/org/alfresco/service/cmr/activities/ActivityService.java +++ b/source/java/org/alfresco/service/cmr/activities/ActivityService.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.service.cmr.activities; @@ -62,7 +62,7 @@ public interface ActivityService extends ActivityPostService * @param userId - required * @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 excludeOthersUsers - if TRUE then will exclude activities for other users (hence returning this user only) + * @param excludeOtherUsers - if TRUE then will exclude activities for other users (hence returning this user only) * @return list of JSON feed entries */ @NotAuditable @@ -83,7 +83,7 @@ public interface ActivityService extends ActivityPostService * @param userId - required * @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 excludeOthersUsers - if TRUE then will exclude activities for other users (hence returning this user only) + * @param excludeOtherUsers - if TRUE then will exclude activities for other users (hence returning this user only) * @param userFilter - if not NULL then will only return activities of users in this set * @param actvityFilter - if not NULL then will only return activities that are in this set * @return list of JSON feed entries @@ -102,11 +102,11 @@ public interface ActivityService extends ActivityPostService * - my user activities (excludeThisUser = false, excludeOtherUsers = true) * note: if both excludes are true then no activities will be returned. * - * @param userId - required + * @param feedUserId - required * @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 excludeOthersUsers - if TRUE then will exclude activities for other users (hence returning this user only) - * @param onlyFollowing - if TRUE then will only return activities of users this user follows + * @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 */ @@ -124,11 +124,10 @@ public interface ActivityService extends ActivityPostService * - my user activities (excludeThisUser = false, excludeOtherUsers = true) * note: if both excludes are true then no activities will be returned. * - * @param userId - required + * @param feedUserId - required * @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 excludeOthersUsers - if TRUE then will exclude activities for other users (hence returning this user only) - * @param onlyFollowing - if TRUE then will only return activities of users this user follows + * @param excludeOtherUsers - if TRUE then will exclude activities for other users (hence returning this user only) * @param userFilter - if not NULL then will only return activities of users in this set * @param actvityFilter - if not NULL then will only return activities that are in this set * @param minFeedId - inclusive from min feed DB id, if -1 then return all available @@ -143,7 +142,7 @@ public interface ActivityService extends ActivityPostService /** * Retrieve site feed * - * @param activityType - required + * @param siteId - required * @return list of JSON feed entries */ @NotAuditable diff --git a/source/java/org/alfresco/service/cmr/attributes/AttributeService.java b/source/java/org/alfresco/service/cmr/attributes/AttributeService.java index 55693ff0eb..492e70e73e 100644 --- a/source/java/org/alfresco/service/cmr/attributes/AttributeService.java +++ b/source/java/org/alfresco/service/cmr/attributes/AttributeService.java @@ -84,13 +84,13 @@ public interface AttributeService */ public void getAttributes(AttributeQueryCallback callback, Serializable ... keys); - /** - * Set an attribute, overwriting its prior value if it already existed. null - * values are treated as unique i.e. if the value set is null then - * {@link #exists(String...)} will still return true. If the attribute doesn't - * exist, it will be created otherwise it will be modified. - * - * @param value The value to store (can be a collection or null) + /** + * Set an attribute, overwriting its prior value if it already existed. null + * values are treated as unique i.e. if the value set is null then + * {@link #exists(Serializable...)} will still return true. If the attribute doesn't + * exist, it will be created otherwise it will be modified. + * + * @param value The value to store (can be a collection or null) * @param keys List of 1 to 3 keys to uniquely identify the attribute */ public void setAttribute(Serializable value, Serializable ... keys); diff --git a/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java b/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java index 5987556947..78a16202df 100644 --- a/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java +++ b/source/java/org/alfresco/service/cmr/calendar/CalendarTimezoneHelper.java @@ -275,7 +275,7 @@ public class CalendarTimezoneHelper * and should be replaced with something more general. * Until then, it is deliberately not public. * - * @param params iCal params for the event, and the TZ (prefixed) + * @param icalText iCal text for the event, and the TZ (prefixed) */ protected static Map getICalParams(String icalText) { diff --git a/source/java/org/alfresco/service/cmr/discussion/PostInfo.java b/source/java/org/alfresco/service/cmr/discussion/PostInfo.java index c3c8c637d0..f513ee1725 100644 --- a/source/java/org/alfresco/service/cmr/discussion/PostInfo.java +++ b/source/java/org/alfresco/service/cmr/discussion/PostInfo.java @@ -28,7 +28,7 @@ import org.alfresco.service.cmr.repository.NodeRef; * This class represents a Post in a Forum Topic. * * To retrieve replies to this, see - * {@link DiscussionService#listPostReplies(PostInfo, int, org.alfresco.query.PagingRequest)} + * {@link DiscussionService#listPostReplies(PostInfo, int)} * * @author Nick Burch * @since 4.0 diff --git a/source/java/org/alfresco/service/cmr/discussion/PostWithReplies.java b/source/java/org/alfresco/service/cmr/discussion/PostWithReplies.java index 66e73df48f..35e3317e7a 100644 --- a/source/java/org/alfresco/service/cmr/discussion/PostWithReplies.java +++ b/source/java/org/alfresco/service/cmr/discussion/PostWithReplies.java @@ -26,7 +26,7 @@ import org.alfresco.service.cmr.repository.NodeRef; /** * This class holds a post and all replies to it, possibly nested. * - * This is used with {@link DiscussionService#listPostReplies(PostWithReplies, int, org.alfresco.query.PagingRequest)} + * This is used with {@link DiscussionService#listPostReplies(PostInfo, int)} * * @author Nick Burch * @since 4.0 diff --git a/source/java/org/alfresco/service/cmr/discussion/TopicInfo.java b/source/java/org/alfresco/service/cmr/discussion/TopicInfo.java index 516674b064..643f3847d2 100644 --- a/source/java/org/alfresco/service/cmr/discussion/TopicInfo.java +++ b/source/java/org/alfresco/service/cmr/discussion/TopicInfo.java @@ -30,7 +30,7 @@ import org.alfresco.service.cmr.repository.NodeRef; * * To retrieve either the Primary Post, or all Posts, * use {@link DiscussionService#getPrimaryPost(TopicInfo)} - * and {@link DiscussionService#listPostReplies(TopicInfo, int, org.alfresco.query.PagingRequest)} + * and {@link DiscussionService#listPostReplies(TopicInfo, int)} * * @author Nick Burch * @since 4.0 diff --git a/source/java/org/alfresco/service/cmr/download/DownloadStatus.java b/source/java/org/alfresco/service/cmr/download/DownloadStatus.java index 3ad2e32004..654804a40d 100644 --- a/source/java/org/alfresco/service/cmr/download/DownloadStatus.java +++ b/source/java/org/alfresco/service/cmr/download/DownloadStatus.java @@ -54,7 +54,7 @@ public class DownloadStatus implements Serializable * @param status Current status of the download * @param done Done count * @param total Total to be de done - * @param filesAddedCount Number of files added to the archive + * @param filesAdded Number of files added to the archive * @param totalFiles The number of files that will eventually be added to the archive */ public DownloadStatus(Status status, long done, long total, long filesAdded, long totalFiles) diff --git a/source/java/org/alfresco/service/cmr/email/EmailService.java b/source/java/org/alfresco/service/cmr/email/EmailService.java index a3b2e53c20..2426b3a4a0 100644 --- a/source/java/org/alfresco/service/cmr/email/EmailService.java +++ b/source/java/org/alfresco/service/cmr/email/EmailService.java @@ -39,21 +39,21 @@ public interface EmailService { /** * Processes an email message. The message's content is intended for a node found by - * examining the email's target address. - * @param delivery instructions - who gets the message and who is it from - * @param message the email message - * @throws EmailMessageRejectException if the message is rejected for any reason - */ - @Auditable(parameters = { "message" }) - void importMessage(EmailDelivery delivery, EmailMessage message); + * examining the email's target address. + * @param delivery instructions - who gets the message and who is it from + * @param message the email message + * @throws org.alfresco.service.cmr.email.EmailMessageException if the message is rejected for any reason + */ + @Auditable(parameters = { "message" }) + void importMessage(EmailDelivery delivery, EmailMessage message); /** * Process an email message. The message's content is intended for a specific node. - * @param delivery instructions - who gets the message and who is it from - * @param nodeRef the node to import the message to - * @param message the email message - * @throws EmailMessageRejectException if the message is rejected for any reason - */ - @Auditable(parameters = { "nodeRef", "message" }) - void importMessage(EmailDelivery delivery, NodeRef nodeRef, EmailMessage message); + * @param delivery instructions - who gets the message and who is it from + * @param nodeRef the node to import the message to + * @param message the email message + * @throws org.alfresco.service.cmr.email.EmailMessageException if the message is rejected for any reason + */ + @Auditable(parameters = { "nodeRef", "message" }) + void importMessage(EmailDelivery delivery, NodeRef nodeRef, EmailMessage message); } diff --git a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java index fb1a99f6fb..91d81ca62e 100644 --- a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java +++ b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java @@ -44,13 +44,13 @@ 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 + * 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 * * @return the nominated invitation which will contain the invitationId and @@ -81,13 +81,13 @@ 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 Invitation.ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param acceptUrl + * @param inviteeFirstName + * @param inviteeLastName + * @param inviteeEmail + * @param resourceType Invitation.ResourceType + * @param resourceName + * @param inviteeRole + * @param acceptUrl * @param rejectUrl * * @return the nominated invitation which will contain the invitationId and ticket which @@ -116,13 +116,13 @@ 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 + * 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 * @@ -155,13 +155,13 @@ 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 Invitation.ResourceType resourceType - * @param resourceName - * @param inviteeRole - * @param serverPath + * @param inviteeFirstName + * @param inviteeLastName + * @param inviteeEmail + * @param resourceType Invitation.ResourceType + * @param resourceName + * @param inviteeRole + * @param serverPath * @param acceptUrl * @param rejectUrl * @@ -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 Invitation.ResourceType 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", @@ -223,13 +223,13 @@ public interface InvitationService @Auditable(parameters = {"inviteeId", "siteShortName", "inviteeComments"}) ModeratedInvitation updateModeratedInvitation(String inviteeId, String siteShortName, String inviteeComments); - /** - * For a Nominated Invitation invitee accepts this invitation - * - * @param request - * @param ticket - * @return the invitation - */ + /** + * For a Nominated Invitation invitee accepts this invitation + * + * @param invitationId + * @param ticket + * @return the invitation + */ @Auditable(parameters = {"invitationId", "reason"}) public Invitation accept(String invitationId, String ticket); diff --git a/source/java/org/alfresco/service/cmr/lock/LockService.java b/source/java/org/alfresco/service/cmr/lock/LockService.java index 6dee4739a2..f403922265 100644 --- a/source/java/org/alfresco/service/cmr/lock/LockService.java +++ b/source/java/org/alfresco/service/cmr/lock/LockService.java @@ -43,13 +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 userName a reference to the user that will own the lock - * @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) @@ -263,36 +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 - * @param userName the user reference - * @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, 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, 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"}) diff --git a/source/java/org/alfresco/service/cmr/lock/NodeLockedException.java b/source/java/org/alfresco/service/cmr/lock/NodeLockedException.java index 65cefc3cfc..b626fc2830 100644 --- a/source/java/org/alfresco/service/cmr/lock/NodeLockedException.java +++ b/source/java/org/alfresco/service/cmr/lock/NodeLockedException.java @@ -48,13 +48,13 @@ public class NodeLockedException extends AlfrescoRuntimeException public NodeLockedException() { super("TEST CONSTRUCTOR INVOKED FOR NodeLockedException"); - } - - /** - * @param message - */ - public NodeLockedException(NodeRef nodeRef) - { + } + + /** + * @param nodeRef NodeRef + */ + public NodeLockedException(NodeRef nodeRef) + { super(MessageFormat.format(ERROR_MESSAGE, new Object[]{nodeRef.getId()})); } diff --git a/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java b/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java index 55c01359e2..f8ed1c63cd 100644 --- a/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java +++ b/source/java/org/alfresco/service/cmr/ml/MultilingualContentService.java @@ -160,13 +160,13 @@ public interface MultilingualContentService /** * Copies the given cm:mlContainer. *

    - * This involves the copy of the cm:mlContainer node and the copy of its cm:mlDocument. - *

    - * - * @param translationNodeRef The cm:mlContainer to copy - * @param newParentRef The new parent of the copied cm:mlDocument - * @param prefixName The prefix of the name of the copied translations. Can be null. - * @return The copied cm:mlContainer + * This involves the copy of the cm:mlContainer node and the copy of its cm:mlDocument. + *

    + * + * @param mlContainerNodeRef The nodeRef to copy + * @param newParentRef The new parent of the copied cm:mlDocument + * @param prefixName The prefix of the name of the copied translations. Can be null. + * @return The copied cm:mlContainer * @throws FileNotFoundException * @throws FileExistsException * @throws Exception @@ -177,13 +177,13 @@ public interface MultilingualContentService /** * Moves the location of the given cm:mlContainer. *

    - * This not involves changing the cm:mlContainer node but moves its cm:mlDocument. - *

    - * - * @param translationNodeRef The cm:mlContainer to move - * @param newParentRef The new parent of the moved cm:mlDocument - * @throws FileExistsException - * @throws FileNotFoundException + * This not involves changing the cm:mlContainer node but moves its cm:mlDocument. + *

    + * + * @param mlContainerNodeRef The nodeRef> to move + * @param newParentRef The new parent of the moved cm:mlDocument + * @throws FileExistsException + * @throws FileNotFoundException */ @Auditable(parameters = {"mlContainerNodeRef", "newParentRef"}) void moveTranslationContainer(NodeRef mlContainerNodeRef, NodeRef newParentRef) throws FileExistsException, FileNotFoundException; diff --git a/source/java/org/alfresco/service/cmr/model/FileFolderService.java b/source/java/org/alfresco/service/cmr/model/FileFolderService.java index 675dbd3fdf..5954ec1228 100644 --- a/source/java/org/alfresco/service/cmr/model/FileFolderService.java +++ b/source/java/org/alfresco/service/cmr/model/FileFolderService.java @@ -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 folderNodeRef the folder 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); /** diff --git a/source/java/org/alfresco/service/cmr/module/ModuleDetails.java b/source/java/org/alfresco/service/cmr/module/ModuleDetails.java index 4e510c8de2..104fdb145e 100644 --- a/source/java/org/alfresco/service/cmr/module/ModuleDetails.java +++ b/source/java/org/alfresco/service/cmr/module/ModuleDetails.java @@ -157,10 +157,10 @@ public interface ModuleDetails extends Serializable */ List getEditions(); - /** - * Sets the editions of Alfresco the module is valid for - * - * @param edition comma seperated list of editions. e.g. community,Enterprise - */ - void setEditions(List editions); -} + /** + * Sets the editions of Alfresco the module is valid for + * + * @param editions comma seperated list of editions. e.g. community,Enterprise + */ + void setEditions(List editions); +} diff --git a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java index 93dc8a1187..a4481963ed 100644 --- a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java +++ b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusNotPublished.java @@ -26,13 +26,12 @@ import org.alfresco.service.cmr.repository.NodeRef; * @since 4.0 */ public class NodePublishStatusNotPublished extends BaseNodePublishStatus -{ - /** - * @param node - * @param environment - * @param channelName TODO - */ - public NodePublishStatusNotPublished(NodeRef node, String channelName) +{ + /** + * @param node + * @param channelName TODO + */ + public NodePublishStatusNotPublished(NodeRef node, String channelName) { super(node, channelName); } diff --git a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java index 79a9312528..9a1f1aaadf 100644 --- a/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java +++ b/source/java/org/alfresco/service/cmr/publishing/NodePublishStatusPublishedAndOnQueue.java @@ -30,13 +30,12 @@ public class NodePublishStatusPublishedAndOnQueue extends BaseNodePublishStatus private final PublishingEvent queuedPublishingEvent; private final PublishingEvent latestPublishingEvent; - - /** - * @param nodeRef - * @param environment - * @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 + * @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) 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 ad3336bd22..5076e9440d 100644 --- a/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java +++ b/source/java/org/alfresco/service/cmr/publishing/channels/Channel.java @@ -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 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); /** diff --git a/source/java/org/alfresco/service/cmr/rating/RatingService.java b/source/java/org/alfresco/service/cmr/rating/RatingService.java index 3b4ff131f0..c21532c4d6 100644 --- a/source/java/org/alfresco/service/cmr/rating/RatingService.java +++ b/source/java/org/alfresco/service/cmr/rating/RatingService.java @@ -34,13 +34,13 @@ import org.alfresco.service.cmr.repository.NodeRef; * These ratings are defined by {@link RatingScheme rating schemes} * which are injected via spring (see rating-service-context.xml). The rating * schemes define a minimum and a maximum score value for that scheme. - *

    - * Ratings can be {@link RatingService#applyRating(NodeRef, float, String) applied}, - * {@link RatingService#applyRating(NodeRef, float, String) updated} and - * {@link RatingService#removeRatingByCurrentUser(NodeRef, RatingScheme) removed}. - * - * @author Neil McErlean - * @since 3.4 + *

    + * Ratings can be {@link RatingService#applyRating(NodeRef, float, String) applied}, + * {@link RatingService#applyRating(NodeRef, float, String) updated} and + * {@link RatingService#removeRatingByCurrentUser(NodeRef, String) removed}. + * + * @author Neil McErlean + * @since 3.4 */ public interface RatingService { @@ -80,13 +80,13 @@ public interface RatingService /** * This method gets the number of individual ratings which have been applied to - * the specified node in the specified {@link RatingScheme}. - * - * @param targetNode the node on which the rating is sought. - * @param ratingScheme the rating scheme to use. - * - * @return the number of individual ratings applied to this node. - * @see RatingService#getRatingSchemes() + * the specified node in the specified {@link RatingScheme}. + * + * @param targetNode the node on which the rating is sought. + * @param ratingSchemeName the rating scheme name to use. + * + * @return the number of individual ratings applied to this node. + * @see RatingService#getRatingSchemes() * @see RatingScheme */ @NotAuditable @@ -96,13 +96,13 @@ public interface RatingService * This method gets the total accumulated rating score for * the specified node in the specified {@link RatingScheme}. * That is, the rating scores for all users for the specified - * node are summed to give the result. - * - * @param targetNode the node on which the rating total is sought. - * @param ratingScheme the rating scheme to use. - * - * @return the sum of all individual ratings applied to this node in the specified scheme. - * @see RatingService#getRatingSchemes() + * node are summed to give the result. + * + * @param targetNode the node on which the rating total is sought. + * @param ratingSchemeName the rating scheme name to use. + * + * @return the sum of all individual ratings applied to this node in the specified scheme. + * @see RatingService#getRatingSchemes() * @see RatingScheme */ @NotAuditable @@ -120,13 +120,13 @@ public interface RatingService /** * This method gets the {@link Rating} applied by the current user to the specified node in the specified - * {@link RatingScheme} - if there is one. - * - * @param targetNode the node on which the rating is sought. - * @param ratingScheme the rating scheme to use. - * - * @return the Rating object if there is one, else null. - * @see RatingService#getRatingSchemes() + * {@link RatingScheme} - if there is one. + * + * @param targetNode the node on which the rating is sought. + * @param ratingSchemeName the rating scheme name to use. + * + * @return the Rating object if there is one, else null. + * @see RatingService#getRatingSchemes() * @see RatingScheme */ @NotAuditable @@ -148,13 +148,13 @@ public interface RatingService /** * This method removes any {@link Rating} applied by the current user to the specified node in the specified - * {@link RatingScheme}. - * - * @param targetNode the node from which the rating is to be removed. - * @param ratingScheme the rating scheme to use. - * - * @return the deleted Rating object if there was one, else null. - * @see RatingService#getRatingSchemes() + * {@link RatingScheme}. + * + * @param targetNode the node from which the rating is to be removed. + * @param ratingSchemeName the rating scheme name to use. + * + * @return the deleted Rating object if there was one, else null. + * @see RatingService#getRatingSchemes() * @see RatingScheme */ @NotAuditable diff --git a/source/java/org/alfresco/service/cmr/repository/ContentService.java b/source/java/org/alfresco/service/cmr/repository/ContentService.java index 4577c585e4..8185b75545 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 org.aflresco.service.cmr.repository.ContentService.transform(ContentReader, ContentReader) - * @see org.aflresco.service.cmr.repository.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 - * - * @depricated - * 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 org.aflresco.service.cmr.repository.ContentService.transform(ContentReader, ContentReader) - * - * 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 the source mimetype - * @param the target mimetype - * @return Returns a transformer that can be used, or null if one was not available - * - * @see org.alfresco.service.cmr.respository.ContentService.getTransformer(String, 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,15 +269,15 @@ 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 - * @param targetMimetype - * @param 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); /** @@ -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(String, String, long, String, 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/CopyService.java b/source/java/org/alfresco/service/cmr/repository/CopyService.java index 26f8450d21..455431634c 100644 --- a/source/java/org/alfresco/service/cmr/repository/CopyService.java +++ b/source/java/org/alfresco/service/cmr/repository/CopyService.java @@ -228,13 +228,12 @@ public interface CopyService /** * Get the copies of a given node - * - * @param originalNodeRef the original node reference - * @param copyParentNodeRef only find copies that are homed in this node - * @param copyNodeAspectsToIgnore only find copies that don't have these aspects - * @param pagingRequest page request details - * @return the page(s) of nodes that were copied from the given node - */ + * + * @param originalNodeRef the original node reference + * @param copyParentNodeRef only find copies that are homed in this node + * @param pagingRequest page request details + * @return the page(s) of nodes that were copied from the given node + */ @Auditable(parameters = {"originalNodeRef", "copyParentNodeRef"}) public PagingResults getCopies( NodeRef originalNodeRef, @@ -247,14 +246,13 @@ public interface CopyService * * @param sourceNodeRef the node reference used as the source of the copy * @param targetParentRef the intended parent of the new node - * @param assocTypeQName the type of the new child assoc - * @param assocQName the qualified name of the child association from the - * parent to the new node - * @param copyChildren indicates that the children of the node should also be copied - * - * @return new name if top-level node will be renamed during copy or - * null if it will remain the same - */ + * @param assocTypeQName the type of the new child assoc + * @param assocQName the qualified name of the child association from the + * parent to the new node + * + * @return new name if top-level node will be renamed during copy or + * null if it will remain the same + */ public String getTopLevelNodeNewName(NodeRef sourceNodeRef, NodeRef targetParentRef, QName assocTypeQName, QName assocQName); diff --git a/source/java/org/alfresco/service/cmr/repository/ScriptService.java b/source/java/org/alfresco/service/cmr/repository/ScriptService.java index 21058196f9..2bb450f608 100644 --- a/source/java/org/alfresco/service/cmr/repository/ScriptService.java +++ b/source/java/org/alfresco/service/cmr/repository/ScriptService.java @@ -209,8 +209,7 @@ public interface ScriptService * @param script Optional ref to the script itself * @param document Optional ref to a document Node * @param space Optional ref to a space Node - * @param resolver Image resolver to resolve icon images etc. - * + * * @return A Map of global scope scriptable Node objects */ @Auditable(parameters = {"person", "companyHome", "userHome", "script", "document", "document"}) diff --git a/source/java/org/alfresco/service/cmr/repository/TemplateService.java b/source/java/org/alfresco/service/cmr/repository/TemplateService.java index 01c6d57ab9..080be0b22f 100644 --- a/source/java/org/alfresco/service/cmr/repository/TemplateService.java +++ b/source/java/org/alfresco/service/cmr/repository/TemplateService.java @@ -110,9 +110,8 @@ public interface TemplateService * Process a template using the supplied locale against the supplied data model and write to the out. * * @param engine Name of the template engine to use - * @param template Template (qualified classpath name or noderef) + * @param templateRef Template ref (qualified classpath name or noderef) * @param model Object model to process template against - * @param out Writer object to send output too * @param locale Locale to process the template as */ @Auditable(parameters = {"engine", "template", "model", "out", "locale"}) diff --git a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java index 7c7207adda..8949958612 100644 --- a/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java +++ b/source/java/org/alfresco/service/cmr/repository/TransformationOptions.java @@ -344,7 +344,7 @@ public class TransformationOptions implements Cloneable * Sets a limit in terms of the amount of data read (by time) to limit transformations where * only the start of the content is needed. After this limit is reached the InputStream reports * end of file. - * @param readLimitBytes if less than or equal to zero (the default) there is no limit. + * @param readLimitTimeMs if less than or equal to zero (the default) there is no limit. * If greater than zero the {@code timeoutMs} must not be set. */ public void setReadLimitTimeMs(long readLimitTimeMs) @@ -525,7 +525,7 @@ public class TransformationOptions implements Cloneable /** * Gets the appropriate source options for the given mimetype if available. * - * @param sourceMimetype + * @param clazz * @return the source options for the mimetype */ @SuppressWarnings("unchecked") @@ -549,7 +549,7 @@ public class TransformationOptions implements Cloneable *

  • {@link #OPT_USE}
  • *
  • {@link TransformationOptionLimits#OPT_TIMEOUT_MS}
  • *
  • {@link TransformationOptionLimits#OPT_READ_LIMIT_TIME_MS}
  • - *
  • {@link TransformationOptionLimits#OPT_MAX_SOURCE_SIZE_K_BYTES
  • + *
  • {@link TransformationOptionLimits#OPT_MAX_SOURCE_SIZE_K_BYTES}
  • *
  • {@link TransformationOptionLimits#OPT_READ_LIMIT_K_BYTES}
  • *
  • {@link TransformationOptionLimits#OPT_MAX_PAGES}
  • *
  • {@link TransformationOptionLimits#OPT_PAGE_LIMIT}
  • diff --git a/source/java/org/alfresco/service/cmr/security/AuthorityService.java b/source/java/org/alfresco/service/cmr/security/AuthorityService.java index b1b81ac641..3eba09efe8 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 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 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 authorityZone - * 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); @@ -312,13 +312,13 @@ public interface AuthorityService 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)} - * 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, 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 * group. * * @param type - @@ -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#DEFAULT_ZONE} 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 zone - */ - @Auditable(parameters = {"authorityName", "zones"}) - public void addAuthorityToZones(String authorityName, Set zones); + /** + * Add a zone to an authority. + * @param authorityName + * @param zones + */ + @Auditable(parameters = {"authorityName", "zones"}) + public void addAuthorityToZones(String authorityName, Set zones); - /** - * Remove a zone from an authority - * @param authorityName - * @param zone - */ - @Auditable(parameters = {"authorityName", "zones"}) - public void removeAuthorityFromZones(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); /** * Get the name of the default zone. diff --git a/source/java/org/alfresco/service/cmr/security/PersonService.java b/source/java/org/alfresco/service/cmr/security/PersonService.java index 0ef935c4e7..ee2b3211f6 100644 --- a/source/java/org/alfresco/service/cmr/security/PersonService.java +++ b/source/java/org/alfresco/service/cmr/security/PersonService.java @@ -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 person 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; @@ -327,13 +327,13 @@ public interface PersonService public PagingResults getPeople(String pattern, List filterProps, List> sortProps, PagingRequest pagingRequest); - /** - * Get paged list of people optionally filtered and/or sorted - * - * @param filterProps 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 * @since 4.0 @@ -342,17 +342,17 @@ public interface PersonService @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 filterProps 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 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 includeAdministrators true to include administrators in the results. - * @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 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 * @since 4.0 */ diff --git a/source/java/org/alfresco/service/cmr/site/SiteService.java b/source/java/org/alfresco/service/cmr/site/SiteService.java index c3437d151c..cb16781a9a 100644 --- a/source/java/org/alfresco/service/cmr/site/SiteService.java +++ b/source/java/org/alfresco/service/cmr/site/SiteService.java @@ -425,7 +425,6 @@ public interface SiteService * * @param shortName short name of site * @param componentId component id - * @param folderType type of folder to create (if null, creates standard folder) * @return noderef of container */ @NotAuditable diff --git a/source/java/org/alfresco/service/cmr/subscriptions/SubscriptionService.java b/source/java/org/alfresco/service/cmr/subscriptions/SubscriptionService.java index 5418ea12a6..d7c80a7d82 100644 --- a/source/java/org/alfresco/service/cmr/subscriptions/SubscriptionService.java +++ b/source/java/org/alfresco/service/cmr/subscriptions/SubscriptionService.java @@ -127,8 +127,6 @@ public interface SubscriptionService extends ActivateableBean * * @param userId * the id of the user - * @param type - * the type of the nodes */ @NotAuditable int getFollowingCount(String userId); @@ -138,8 +136,6 @@ public interface SubscriptionService extends ActivateableBean * * @param userId * the id of the user - * @param type - * the type of the nodes */ @NotAuditable int getFollowersCount(String userId); diff --git a/source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java b/source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java index fcb6efdbde..4e825675ab 100644 --- a/source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java +++ b/source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java @@ -59,7 +59,7 @@ public interface ThumbnailService * The returned node reference is to the 'rn:rendition' content node that contains * the thumbnail content in the standard 'cm:content' property. * - * @see org.alfresco.service.cmr.thumnail.ThumbnailDefinition + * @see org.alfresco.repo.thumbnail.ThumbnailDefinition * * @param node the source content node * @param contentProperty the content property diff --git a/source/java/org/alfresco/service/cmr/usage/ContentUsageService.java b/source/java/org/alfresco/service/cmr/usage/ContentUsageService.java index 369a2a34a2..5ec97cd83f 100644 --- a/source/java/org/alfresco/service/cmr/usage/ContentUsageService.java +++ b/source/java/org/alfresco/service/cmr/usage/ContentUsageService.java @@ -49,7 +49,8 @@ public interface ContentUsageService * * Note: -1 means no quota limit set * - * @param User's new quota (in bytes) + * @param userName User name + * @param newQuota User's new quota (in bytes) */ @Auditable public void setUserQuota(String userName, long newQuota); diff --git a/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java b/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java index 6325fd7c84..bbef7f3d28 100644 --- a/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java +++ b/source/java/org/alfresco/service/cmr/view/ExporterCrawlerParameters.java @@ -254,13 +254,13 @@ public class ExporterCrawlerParameters return referenceType; } - /** - * Sets the format of exported references (child and association references) - * - * @param reference 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/workflow/WorkflowService.java b/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java index 1a7bae7d97..5b392405c1 100644 --- a/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java +++ b/source/java/org/alfresco/service/cmr/workflow/WorkflowService.java @@ -352,7 +352,7 @@ public interface WorkflowService * Signal the transition from one Workflow Node to another * * @param pathId the workflow path to signal on - * @param transition the transition to follow (or null, for the default transition) + * @param transitionId the transition id to follow (or null, for the default transition) * @return the updated workflow path */ @Auditable(parameters = {"pathId", "transitionId"}) @@ -481,7 +481,7 @@ public interface WorkflowService * Gets the pooled tasks available to the specified authority * * @param authority the authority - * @param lazyInitialization hint to the underlying workflow-engine to allow returning {@link WorkflowTask}s which + * @param lazyinitialization hint to the underlying workflow-engine to allow returning {@link WorkflowTask}s which * aren't fully initialized but will be when the required values are required. If true, the * returned enities should be used inside of the transaction-boundaries of this service-call. * If false, fully initialized entities are returned, just as with {@link #getPooledTasks(String)}. @@ -533,7 +533,7 @@ public interface WorkflowService * End the Task (i.e. complete the task) * * @param taskId the task id to end - * @param transition the task transition to take on completion (or null, for the default transition) + * @param transitionId the task transition id to take on completion (or null, for the default transition) * @return the updated task */ @Auditable(parameters = {"taskId", "transitionId"}) diff --git a/source/java/org/alfresco/service/license/LicenseService.java b/source/java/org/alfresco/service/license/LicenseService.java index 8599c55336..06d7420cd1 100644 --- a/source/java/org/alfresco/service/license/LicenseService.java +++ b/source/java/org/alfresco/service/license/LicenseService.java @@ -87,7 +87,7 @@ public interface LicenseService /** * Inteface for components wishing to know when the license has changed * - * @see registerOnLicenseChange + * @see #registerOnLicenseChange(LicenseChangeHandler) */ public interface LicenseChangeHandler { diff --git a/source/java/org/alfresco/tools/RenameUser.java b/source/java/org/alfresco/tools/RenameUser.java index 66bd017c95..cd95be9ec2 100644 --- a/source/java/org/alfresco/tools/RenameUser.java +++ b/source/java/org/alfresco/tools/RenameUser.java @@ -52,13 +52,13 @@ import org.alfresco.service.transaction.TransactionService; import org.alfresco.util.VmShutdownListener; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; - -/** - * Rename user tool. This tool provides minimal support for renaming users. - * See {@link displayHelp} message for restrictions. - *
    - * Usage: renameUser -user username [options] oldUsername newUsername");
    - *        renameUser -user username [options] -file filename");
    +
    +/**
    + * Rename user tool. This tool provides minimal support for renaming users.
    + * See {@link #displayHelp} message for restrictions.
    + * 
    + * Usage: renameUser -user username [options] oldUsername newUsername");
    + *        renameUser -user username [options] -file filename");
      * 
    * The csv file has a simple comma separated list, with * a pair of usernames on each line. Comments and blank diff --git a/source/java/org/alfresco/util/JodCoordinationBoolean.java b/source/java/org/alfresco/util/JodCoordinationBoolean.java index 10004e3b6e..9da91b3181 100644 --- a/source/java/org/alfresco/util/JodCoordinationBoolean.java +++ b/source/java/org/alfresco/util/JodCoordinationBoolean.java @@ -18,13 +18,13 @@ */ package org.alfresco.util; -import org.alfresco.util.bean.BooleanBean; - -/** - * Wraps a {@link #JodCoordination} object to return one of its boolean methods, - * so that it may be used as the input to another bean. - * - * @author Alan Davis +import org.alfresco.util.bean.BooleanBean; + +/** + * Wraps a {@link org.alfresco.util.JodCoordination} object to return one of its boolean methods, + * so that it may be used as the input to another bean. + * + * @author Alan Davis */ public class JodCoordinationBoolean implements BooleanBean { diff --git a/source/java/org/alfresco/util/RuntimeSystemPropertiesSetter.java b/source/java/org/alfresco/util/RuntimeSystemPropertiesSetter.java index d2896118f9..14600a0a99 100644 --- a/source/java/org/alfresco/util/RuntimeSystemPropertiesSetter.java +++ b/source/java/org/alfresco/util/RuntimeSystemPropertiesSetter.java @@ -39,25 +39,25 @@ import org.springframework.core.io.support.ResourcePatternResolver; * the runtime environment (e.g.: alfresco.jmx.dir). The motivation for this * is that certain values must be set within spring must be computed in advance * for org.springframework.beans.factory.config.PropertyPlaceholderConfigurer - * to work properly. - * - * @author Jon Cox - * @see #setProperties(String) -*/ -public class RuntimeSystemPropertiesSetter implements BeanFactoryPostProcessor, ApplicationContextAware, PriorityOrdered -{ + * to work properly. + * + * @author Jon Cox + * @see #setJvmProperties(Map) +*/ +public class RuntimeSystemPropertiesSetter implements BeanFactoryPostProcessor, ApplicationContextAware, PriorityOrdered +{ private static Log logger = LogFactory.getLog(RuntimeSystemPropertiesSetter.class ); /** default: just before PropertyPlaceholderConfigurer */ private int order = Integer.MAX_VALUE - 1; - private ResourcePatternResolver resolver; - - /** - * @see #setProperties(String) - */ - private Map jvmProperties; - + private ResourcePatternResolver resolver; + + /** + * @see #setJvmProperties(Map) + */ + private Map jvmProperties; + public RuntimeSystemPropertiesSetter() { jvmProperties = new HashMap(7); diff --git a/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java b/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java index f7aa425b16..bad01450ec 100644 --- a/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java +++ b/source/java/org/alfresco/util/ThreadPoolExecutorFactoryBean.java @@ -148,7 +148,7 @@ public class ThreadPoolExecutorFactoryBean implements FactoryBean, InitializingB * The maximum number of queued work instances to keep before blocking * against further adds. * - * @param size the queue size before blocks, or -1 default + * @param workQueueSize the queue size before blocks, or -1 default * to indicate no upper bound */ public void setWorkQueueSize(int workQueueSize) diff --git a/source/java/org/alfresco/util/TypeConstraint.java b/source/java/org/alfresco/util/TypeConstraint.java index 4529142551..267b783881 100644 --- a/source/java/org/alfresco/util/TypeConstraint.java +++ b/source/java/org/alfresco/util/TypeConstraint.java @@ -101,7 +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 excludeTypeNames + * @param typeNames * @return Set Valid type QNames */ protected void preprocessExcludedTypes(List typeNames) @@ -129,7 +129,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 excludeTypeNames + * @param typeNames * @return Set Valid type QNames */ protected void preprocessExpectedTypes(List typeNames) diff --git a/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java b/source/java/org/alfresco/util/config/RepositoryFolderConfigBean.java index 6f2d163147..3e6e5b5676 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 RepositoryPathConfigBean#getPath() 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 + * {@link #getFolderNames() 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 RepositoryPathConfigBean#getPath() 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 #getPath() 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 {@link #getFolderNames() 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 #getPath() 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 {@link #getFolderNames() 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 #getPath() 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 {@link #getFolderNames() 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/config/RepositoryPathConfigBean.java b/source/java/org/alfresco/util/config/RepositoryPathConfigBean.java index 75f49e3b0e..7b871bd33c 100644 --- a/source/java/org/alfresco/util/config/RepositoryPathConfigBean.java +++ b/source/java/org/alfresco/util/config/RepositoryPathConfigBean.java @@ -60,13 +60,13 @@ public class RepositoryPathConfigBean return store == null ? null : store.toString(); } - /** - * Sets the Alfresco store name. - * - * @param store - * the Alfresco store name - */ - public void setStore(String storeRef) + /** + * Sets the Alfresco store name. + * + * @param storeRef + * the Alfresco store name + */ + public void setStore(String storeRef) { PropertyCheck.mandatory(this, "store", storeRef); this.store = new StoreRef(storeRef); diff --git a/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java b/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java index c02c4c543f..276b335b62 100644 --- a/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java +++ b/source/java/org/alfresco/util/schemacomp/ComparisonUtils.java @@ -48,36 +48,36 @@ public interface ComparisonUtils 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 Where#IN_BOTH_NO_DIFFERENCE in both with no difference}. - * - * @param leftProperty - * @param rightProperty - * @param ctx - */ - void compareSimpleCollections(DbProperty leftProperty, DbProperty rightProperty, DiffContext ctx); - - /** - * Compare collections of {@link DbObject}s using their {@link DbObject#diff(DbObject, Differences)} method. - * - * @param leftCollection - * @param rightCollection - * @param differences - */ - 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 + * @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 '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 differences - */ - void compareSimple(DbProperty left, DbProperty right, DiffContext ctx); - + * + * @param left + * @param right + * @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/ExportDb.java b/source/java/org/alfresco/util/schemacomp/ExportDb.java index 716dfee516..a8b7f1e0fb 100644 --- a/source/java/org/alfresco/util/schemacomp/ExportDb.java +++ b/source/java/org/alfresco/util/schemacomp/ExportDb.java @@ -89,14 +89,16 @@ public class ExportDb } - /** - * Create a new instance of the tool within the context of an existing database connection - * - * @param connection the database connection to use for metadata queries - * @param dialect the Hibernate dialect - */ - 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; @@ -129,14 +131,13 @@ public class ExportDb } } - - /** - * Initializes the fields ready to perform the database metadata reading - * @param dialect the Hibernate dialect - * @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 diff --git a/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java b/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java index 2f94c2bf7a..42838809d6 100644 --- a/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java +++ b/source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java @@ -158,14 +158,14 @@ public abstract class AbstractDbObject implements DbObject sb.append("]"); return sb.toString(); - } - - /** - * Provides an implementation of {@link DbObject#diff(DbObject, Results)}. The template - * method {@link #doDiff(DbObject, Results)} 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 differences - */ - protected void doDiff(DbObject right, DiffContext ctx) - { + * Override this method to provide subclass specific diffing logic. + * + * @param right + * @param ctx + */ + protected void doDiff(DbObject right, DiffContext ctx) + { } diff --git a/source/java/org/alfresco/util/schemacomp/model/Schema.java b/source/java/org/alfresco/util/schemacomp/model/Schema.java index 389e83c361..d97d5717fa 100644 --- a/source/java/org/alfresco/util/schemacomp/model/Schema.java +++ b/source/java/org/alfresco/util/schemacomp/model/Schema.java @@ -107,7 +107,7 @@ public class Schema extends AbstractDbObject implements Iterable } /** - * @param identifier + * @param object * @return */ public boolean contains(DbObject object) diff --git a/source/test-java/org/alfresco/Repository03TestSuite.java b/source/test-java/org/alfresco/Repository03TestSuite.java index 922f732fc5..9304e14ae0 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 RepositoryMisc01TestSuite} - * - * @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 cf1528aafa..949b021c82 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 RepositoryMisc01TestSuite} - * - * @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 55187197f8..1ac94e2ece 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 RepositoryMisc01TestSuite} - * - * @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 6686cea9b8..57a182b3c7 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 RepositoryMisc01TestSuite} - * - * @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 01ea336264..8dabc8d630 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 RepositoryMisc01TestSuite} - * - * @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 f24baf86d7..be1ae4dbbf 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 RepositoryMisc01TestSuite} - * - * @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 fb8d27ae78..06c80ef98a 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 RepositoryMisc01TestSuite} - * - * @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 353a93c823..ef61a66fb8 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 RepositoryMisc01TestSuite} - * - * @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 582768d05b..ab16f136ad 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 RepositoryMisc01TestSuite} - * - * @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 8cd54fe19a..71f3e08d66 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 RepositoryMisc01TestSuite} - * - * @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 958231b070..9af6de604b 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 RepositoryMisc01TestSuite} - * - * @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 b1caa03028..fe1c51f2a6 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 RepositoryMisc01TestSuite} - * - * @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 e1df4bc1a1..1e242a0cb4 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 RepositoryMisc01TestSuite} - * - * @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 7e3c605485..af240554d5 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 RepositoryMisc01TestSuite} - * - * @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 cfec0b2c5e..b05087a649 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 RepositoryMisc01TestSuite} - * - * @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 de254f7892..0013a25296 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 RepositoryMisc01TestSuite} - * - * @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 4b85843a7f..d6ba447b52 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 RepositoryMisc01TestSuite} - * - * @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 11b30978fe..cefdfa1894 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 RepositoryMisc01TestSuite} - * - * @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 e044d77a1e..113a15b442 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 RepositoryMisc01TestSuite} - * - * @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 dda72cefa7..0ba01e6b03 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 RepositoryMisc01TestSuite} - * - * @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 77a5f514f7..fc546cad59 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 RepositoryMisc01TestSuite} - * - * @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 cb5f91f975..412bc473f1 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 RepositoryMisc01TestSuite} - * - * @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 83cd7974e9..3db594a1c9 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 RepositoryMisc01TestSuite} - * - * @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 331d68db09..d645cdd8fe 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 RepositoryMisc01TestSuite} - * - * @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 01633bdb5b..8b70f3c14c 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 RepositoryMisc01TestSuite} - * - * @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 6631b21982..ee01925c7c 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 RepositoryMisc01TestSuite} - * - * @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 a6ea5aea14..79dd07c103 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 RepositoryMisc01TestSuite} - * - * @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 5c8d4d0a6d..85200aa507 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 RepositoryMisc01TestSuite} - * - * @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 8415f94281..be426962da 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 RepositoryMisc01TestSuite} - * - * @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 688c43fd97..c6d061578b 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 RepositoryMisc01TestSuite} - * - * @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 19275e435b..fc8d633758 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 RepositoryMisc01TestSuite} - * - * @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 875b30ab91..cab9d94415 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 RepositoryMisc01TestSuite} - * - * @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 ef358b8796..95f001a2f1 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 RepositoryMisc01TestSuite} - * - * @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 61c419d1c3..35dfb6ce97 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 RepositoryMisc01TestSuite} - * - * @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 71d39832d3..030d42f797 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 RepositoryMisc01TestSuite} - * - * @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 e8e7010c3c..f15a9b300e 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 RepositoryMisc01TestSuite} - * - * @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 a90014d267..a95dd387a1 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 RepositoryMisc01TestSuite} - * - * @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 8ef4f81c9b..2f90e987c3 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 RepositoryMisc01TestSuite} - * - * @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 7a3584ade1..131773e1f8 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 RepositoryMisc01TestSuite} - * - * @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 ef57b0b827..47f444e924 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 RepositoryMisc01TestSuite} - * - * @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 33af3a3dd7..5864755274 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 RepositoryMisc01TestSuite} - * - * @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 4722e154a1..e08abd0f42 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 RepositoryMisc01TestSuite} - * - * @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 6e446379e9..46f474c14a 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 RepositoryMisc01TestSuite} - * - * @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 0f7cccae27..6b9f1ae955 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 RepositoryMisc01TestSuite} - * - * @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 ba423cbe66..2fda440b6f 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 RepositoryMisc01TestSuite} - * - * @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 c4274e2735..b90f8887fe 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 RepositoryMisc01TestSuite} - * - * @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 1d2a35de2a..97cf65ccba 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 RepositoryMisc01TestSuite} - * - * @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 093d4372b0..40742f9b93 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 RepositoryMisc01TestSuite} - * - * @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 5890da68fd..f91be46e89 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 RepositoryMisc01TestSuite} - * - * @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 52466cdc55..1340843bf8 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 RepositoryMisc01TestSuite} - * - * @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/Repository60TestSuite.java b/source/test-java/org/alfresco/Repository60TestSuite.java index 0a2805a7fb..c954c234b2 100644 --- a/source/test-java/org/alfresco/Repository60TestSuite.java +++ b/source/test-java/org/alfresco/Repository60TestSuite.java @@ -19,13 +19,13 @@ package org.alfresco; import junit.framework.Test; -import junit.framework.TestSuite; - -/** - * See {@link RepositoryMisc01TestSuite} - * - * @Author Alan Davis - */ +import junit.framework.TestSuite; + +/** + * See {@link Repository01TestSuite} + * + * @Author Alan Davis + */ public class Repository60TestSuite 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 6d532feb69..ef113de8cb 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 RepositoryMisc01TestSuite} - * - * @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 6da8931a5c..4670b73b42 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 RepositoryMisc01TestSuite} - * - * @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 c43994d7fe..34e4734b66 100644 --- a/source/test-java/org/alfresco/Repository65TestSuite.java +++ b/source/test-java/org/alfresco/Repository65TestSuite.java @@ -22,7 +22,7 @@ import junit.framework.Test; import junit.framework.TestSuite; /** - * See {@link RepositoryMisc01TestSuite} + * See {@link Repository01TestSuite} * * @Author Alexey Bogdanov */ diff --git a/source/test-java/org/alfresco/repo/action/ActionConditionDefinitionImplTest.java b/source/test-java/org/alfresco/repo/action/ActionConditionDefinitionImplTest.java index 947ca0abc6..00360185cf 100644 --- a/source/test-java/org/alfresco/repo/action/ActionConditionDefinitionImplTest.java +++ b/source/test-java/org/alfresco/repo/action/ActionConditionDefinitionImplTest.java @@ -28,15 +28,12 @@ public class ActionConditionDefinitionImplTest extends BaseParameterizedItemDefi { /** * Constants used during tests - */ - private static final String CONDITION_EVALUATOR = "conditionEvaluator"; - - /** - * @see org.alfresco.repo.rule.common.RuleItemDefinitionImplTest#create() - */ - protected ParameterizedItemDefinitionImpl create() - { - // Test duplicate param name + */ + private static final String CONDITION_EVALUATOR = "conditionEvaluator"; + + protected ParameterizedItemDefinitionImpl create() + { + // Test duplicate param name try { ActionConditionDefinitionImpl temp = new ActionConditionDefinitionImpl(NAME); diff --git a/source/test-java/org/alfresco/repo/action/ActionConditionImplTest.java b/source/test-java/org/alfresco/repo/action/ActionConditionImplTest.java index dffb722f80..54c35706b5 100644 --- a/source/test-java/org/alfresco/repo/action/ActionConditionImplTest.java +++ b/source/test-java/org/alfresco/repo/action/ActionConditionImplTest.java @@ -22,15 +22,12 @@ import org.alfresco.service.cmr.action.ActionCondition; /** * @author Roy Wetherall - */ -public class ActionConditionImplTest extends BaseParameterizedItemImplTest -{ - /** - * @see org.alfresco.repo.rule.common.RuleItemImplTest#create() - */ - @Override - protected ParameterizedItemImpl create() - { + */ +public class ActionConditionImplTest extends BaseParameterizedItemImplTest +{ + @Override + protected ParameterizedItemImpl create() + { return new ActionConditionImpl( ID, NAME, diff --git a/source/test-java/org/alfresco/repo/action/ActionImplTest.java b/source/test-java/org/alfresco/repo/action/ActionImplTest.java index dcf473c476..a12d9da6b8 100644 --- a/source/test-java/org/alfresco/repo/action/ActionImplTest.java +++ b/source/test-java/org/alfresco/repo/action/ActionImplTest.java @@ -33,15 +33,12 @@ public class ActionImplTest extends BaseParameterizedItemImplTest private static final String ID_COND2 = "idCond2"; private static final String ID_COND3 = "idCond3"; private static final String NAME_COND1 = "nameCond1"; - private static final String NAME_COND2 = "nameCond2"; - private static final String NAME_COND3 = "nameCond3"; - - /** - * @see org.alfresco.repo.rule.common.RuleItemImplTest#create() - */ - @Override - protected ParameterizedItemImpl create() - { + private static final String NAME_COND2 = "nameCond2"; + private static final String NAME_COND3 = "nameCond3"; + + @Override + protected ParameterizedItemImpl create() + { return new ActionImpl( null, ID, diff --git a/source/test-java/org/alfresco/repo/action/ActionServiceImplTest.java b/source/test-java/org/alfresco/repo/action/ActionServiceImplTest.java index 722f301568..345fae2058 100644 --- a/source/test-java/org/alfresco/repo/action/ActionServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/action/ActionServiceImplTest.java @@ -973,13 +973,12 @@ public class ActionServiceImplTest extends BaseAlfrescoSpringTest /** * - * @param sleepTime - * @param maxTries - * @param test - * @param context - */ - public static void postAsyncActionTest( - TransactionService transactionService, + * @param sleepTime + * @param maxTries + * @param test + */ + public static void postAsyncActionTest( + TransactionService transactionService, final long sleepTime, final int maxTries, final AsyncTest test) diff --git a/source/test-java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinitionTest.java b/source/test-java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinitionTest.java index b9a0506141..afe2e3a826 100644 --- a/source/test-java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinitionTest.java +++ b/source/test-java/org/alfresco/repo/action/scheduled/CronScheduledQueryBasedTemplateActionDefinitionTest.java @@ -55,13 +55,13 @@ import org.springframework.context.ApplicationContext; /** * Test for {@link CronScheduledQueryBasedTemplateActionDefinition} class. The test assumes that not all test-cases require scheduling. Hence, * {@link CronScheduledQueryBasedTemplateActionDefinition} instance is not registered as scheduled job. But in the same time this instance is unregistered as scheduled job after - * every test-case execution. Also default query template is not set for {@link CronScheduledQueryBasedTemplateActionDefinition} instance - * - * @author Dmitry Velichkevich - * @see CronScheduledQueryBasedTemplateActionDefinitionTest#initializeScheduler(ServiceRegistry) - */ -public class CronScheduledQueryBasedTemplateActionDefinitionTest extends TestCase -{ + * every test-case execution. Also default query template is not set for {@link CronScheduledQueryBasedTemplateActionDefinition} instance + * + * @author Dmitry Velichkevich + * @see CronScheduledQueryBasedTemplateActionDefinitionTest#initializeScheduler() + */ +public class CronScheduledQueryBasedTemplateActionDefinitionTest extends TestCase +{ private static final int AMOUNT_OF_DAYS_BEFORE = -4; private static final int TEST_DOCUMENTS_AMOUNT = 5; diff --git a/source/test-java/org/alfresco/repo/audit/AuditableAspectTest.java b/source/test-java/org/alfresco/repo/audit/AuditableAspectTest.java index a510569b38..8320c7299b 100644 --- a/source/test-java/org/alfresco/repo/audit/AuditableAspectTest.java +++ b/source/test-java/org/alfresco/repo/audit/AuditableAspectTest.java @@ -45,13 +45,13 @@ import org.alfresco.test_category.OwnJVMTestsCategory; import org.alfresco.util.ApplicationContextHelper; import org.alfresco.util.debug.NodeStoreInspector; import org.junit.experimental.categories.Category; -import org.springframework.context.ApplicationContext; - -/** - * Checks that the behaviour of the {@link org.alfresco.repo.audit.AuditableAspect auditable aspect} - * is correct. - * - * @author Derek Hulley +import org.springframework.context.ApplicationContext; + +/** + * Checks that the behaviour of the {@link ContentModel#ASPECT_AUDITABLE auditable aspect} + * is correct. + * + * @author Derek Hulley */ @Category(OwnJVMTestsCategory.class) public class AuditableAspectTest extends TestCase 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 a731de79b9..cbfeac6941 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 @@ -46,7 +46,7 @@ import org.alfresco.service.cmr.repository.ContentWriter; * Attempts to write content using any of the getWriter() methods will succeed. Though the content does not actually * get stored anywhere. *

    - * Both reads and writes are slow - the readers and writers returned by this class sleep for {@link pauseMillis} after + * Both reads and writes are slow - the readers and writers returned by this class sleep for {@link #pauseMillis} after * each operation. * * @author Matt Ward 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 daa5386cf7..609e94f702 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 the 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 the 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 { diff --git a/source/test-java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformerTest.java b/source/test-java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformerTest.java index 3270f90e49..926100d118 100644 --- a/source/test-java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformerTest.java +++ b/source/test-java/org/alfresco/repo/content/transform/PoiOOXMLContentTransformerTest.java @@ -150,13 +150,13 @@ public class PoiOOXMLContentTransformerTest extends AbstractContentTransformerTe assertFalse("Writable channel was not closed after transformation attempt!", tempWriter.isChannelOpen()); } - /** - * Configures timeout for given transformer - * - * @param extractor - {@link PoiOOXMLContentTransformer} instance - * @param timeout - {@link Long} value which specifies timeout for transformer - */ - private void configureExtractorLimits(PoiOOXMLContentTransformer transformer, final long timeout) + /** + * Configures timeout for given transformer + * + * @param transformer - {@link PoiOOXMLContentTransformer} instance + * @param timeout - {@link Long} value which specifies timeout for transformer + */ + private void configureExtractorLimits(PoiOOXMLContentTransformer transformer, final long timeout) { transformer.setTransformerConfig(new TransformerConfigImpl() { diff --git a/source/test-java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractorTest.java b/source/test-java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractorTest.java index e717ba4e29..a49f4486ff 100644 --- a/source/test-java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractorTest.java +++ b/source/test-java/org/alfresco/repo/content/transform/TransformerPropertyNameExtractorTest.java @@ -102,8 +102,8 @@ public class TransformerPropertyNameExtractorTest * a) returns all the supplied mimetypes * b) returns the extension given the mimetype * c) returns the mimetype given the extension. + * @param mimetypeService mimetype service * @param mimetypesAndExtensions sequence of mimetypes and extenstions. - * @param transformerProperties to mock the return values * @throws IllegalStateException if there is not an extension for every mimetype */ public static void mockMimetypes(MimetypeService mimetypeService, String... mimetypesAndExtensions) diff --git a/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java b/source/test-java/org/alfresco/repo/exporter/ExporterComponentTest.java index 86e3704347..5873b9d53b 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 contentChildAssocRef - * @return - * @throws FileNotFoundException - * @throws IOException + } + + /** + * @param nodeRef nodeRef + * @return + * @throws FileNotFoundException + * @throws IOException */ private File exportContent(NodeRef nodeRef) throws FileNotFoundException, IOException diff --git a/source/test-java/org/alfresco/repo/model/ml/tools/EmptyTranslationAspectTest.java b/source/test-java/org/alfresco/repo/model/ml/tools/EmptyTranslationAspectTest.java index ae1d846111..2f91e1bc39 100644 --- a/source/test-java/org/alfresco/repo/model/ml/tools/EmptyTranslationAspectTest.java +++ b/source/test-java/org/alfresco/repo/model/ml/tools/EmptyTranslationAspectTest.java @@ -31,13 +31,13 @@ import org.alfresco.service.namespace.QName; import org.alfresco.test_category.OwnJVMTestsCategory; import org.junit.experimental.categories.Category; -/** - * Empty translations aspect test cases - * - * @see org.alfresco.service.cmr.ml.EmptyTranslationAspect - * - * @author Yannick Pignot - */ +/** + * Empty translations aspect test cases + * + * @see org.alfresco.repo.model.ml.EmptyTranslationAspect + * + * @author Yannick Pignot + */ @Category(OwnJVMTestsCategory.class) public class EmptyTranslationAspectTest extends AbstractMultilingualTestCases { diff --git a/source/test-java/org/alfresco/repo/model/ml/tools/MLContainerTypeTest.java b/source/test-java/org/alfresco/repo/model/ml/tools/MLContainerTypeTest.java index ccc62b30e6..d6c7ac63c6 100644 --- a/source/test-java/org/alfresco/repo/model/ml/tools/MLContainerTypeTest.java +++ b/source/test-java/org/alfresco/repo/model/ml/tools/MLContainerTypeTest.java @@ -28,13 +28,13 @@ import org.alfresco.service.namespace.QName; import org.alfresco.test_category.OwnJVMTestsCategory; import org.junit.experimental.categories.Category; -/** - * Multilingual container type test cases - * - * @see org.alfresco.service.cmr.ml.MLContainerType - * - * @author Yannick Pignot - */ +/** + * Multilingual container type test cases + * + * @see org.alfresco.repo.model.ml.MLContainerType + * + * @author Yannick Pignot + */ @Category(OwnJVMTestsCategory.class) public class MLContainerTypeTest extends AbstractMultilingualTestCases { diff --git a/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualContentServiceImplTest.java b/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualContentServiceImplTest.java index 9021025734..e96fed12ea 100644 --- a/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualContentServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualContentServiceImplTest.java @@ -33,13 +33,13 @@ import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.test_category.OwnJVMTestsCategory; import org.alfresco.util.GUID; import org.junit.experimental.categories.Category; -import org.springframework.extensions.surf.util.I18NUtil; - -/** - * @see org.alfresco.repo.ml.MultilingualContentServiceImpl - * - * @author Derek Hulley - * @author Philippe Dubois +import org.springframework.extensions.surf.util.I18NUtil; + +/** + * @see org.alfresco.repo.model.ml.MultilingualContentServiceImpl + * + * @author Derek Hulley + * @author Philippe Dubois */ @Category(OwnJVMTestsCategory.class) public class MultilingualContentServiceImplTest extends AbstractMultilingualTestCases diff --git a/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualDocumentAspectTest.java b/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualDocumentAspectTest.java index d48f8a2210..4f0e6b1622 100644 --- a/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualDocumentAspectTest.java +++ b/source/test-java/org/alfresco/repo/model/ml/tools/MultilingualDocumentAspectTest.java @@ -28,13 +28,13 @@ import org.alfresco.service.namespace.QName; import org.alfresco.test_category.OwnJVMTestsCategory; import org.junit.experimental.categories.Category; -/** - * Multilingual document aspect test cases - * - * @see org.alfresco.service.cmr.ml.MultilingualDocumentAspect - * - * @author Yannick Pignot - */ +/** + * Multilingual document aspect test cases + * + * @see org.alfresco.repo.model.ml.MultilingualDocumentAspect + * + * @author Yannick Pignot + */ @Category(OwnJVMTestsCategory.class) public class MultilingualDocumentAspectTest extends AbstractMultilingualTestCases { diff --git a/source/test-java/org/alfresco/repo/node/BaseNodeServiceTest.java b/source/test-java/org/alfresco/repo/node/BaseNodeServiceTest.java index a6652f59df..32e3ae2095 100644 --- a/source/test-java/org/alfresco/repo/node/BaseNodeServiceTest.java +++ b/source/test-java/org/alfresco/repo/node/BaseNodeServiceTest.java @@ -881,13 +881,13 @@ public abstract class BaseNodeServiceTest extends BaseSpringTest nodeService.createAssociation(sourceNodeRef, targetNodeRef, ASSOC_ASPECT_NORMAL_ASSOC_01); nodeService.createAssociation(sourceNodeRef, targetNodeRef, ASSOC_ASPECT_NORMAL_ASSOC_02); nodeService.removeAspect(sourceNodeRef, ASPECT_WITH_ASSOCIATIONS_EXTRA); - } - - /** - * Test {@link https://issues.alfresco.com/jira/browse/ALFCOM-2299 ALFCOM-2299} - */ - public void testAspectRemovalCascadeDelete() throws Exception - { + } + + /** + * Test ALFCOM-2299 + */ + public void testAspectRemovalCascadeDelete() throws Exception + { // Create a node to add the aspect to NodeRef sourceNodeRef = nodeService.createNode( rootNodeRef, diff --git a/source/test-java/org/alfresco/repo/rule/RuleServiceImplTest.java b/source/test-java/org/alfresco/repo/rule/RuleServiceImplTest.java index 6f3d5505c3..961356ea9f 100644 --- a/source/test-java/org/alfresco/repo/rule/RuleServiceImplTest.java +++ b/source/test-java/org/alfresco/repo/rule/RuleServiceImplTest.java @@ -452,13 +452,12 @@ public class RuleServiceImplTest extends BaseRuleTest } /** - * Helper method to easily create a new node which can be actionable (or not) - * - * @param parent the parent node - * @param isActionable indicates whether the node is actionable or not - */ - private NodeRef createNewNode(NodeRef parent) - { + * Helper method to easily create a new node which can be actionable (or not) + * + * @param parent the parent node + */ + private NodeRef createNewNode(NodeRef parent) + { return this.nodeService.createNode(parent, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}testnode"), 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 120b69555b..e603ab3f7a 100644 --- a/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java +++ b/source/test-java/org/alfresco/repo/security/sync/ChainingUserRegistrySynchronizerTest.java @@ -876,16 +876,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 personName - * the person name - * @param email - * the email - */ - 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))); } @@ -1340,14 +1340,14 @@ public class ChainingUserRegistrySynchronizerTest extends TestCase /** * The Constructor. - * - * @param size - * the collection size - * @param authorities - * the authorities - */ - 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/transfer/NodeCrawlerTest.java b/source/test-java/org/alfresco/repo/transfer/NodeCrawlerTest.java index 72acaf8a9b..a7cfd60014 100644 --- a/source/test-java/org/alfresco/repo/transfer/NodeCrawlerTest.java +++ b/source/test-java/org/alfresco/repo/transfer/NodeCrawlerTest.java @@ -185,14 +185,14 @@ public class NodeCrawlerTest extends BaseAlfrescoSpringTest crawler.setNodeFilters(new ContentClassFilter(ContentModel.TYPE_FOLDER)); crawledNodes = crawler.crawl(node8); assertEquals(6, crawledNodes.size()); - } - - /** - * @param companyHome2 - * @param nodeType - * @return - */ - private NodeRef makeNode(NodeRef parent, QName nodeType) + } + + /** + * @param parent NodeRef + * @param nodeType QName + * @return + */ + private NodeRef makeNode(NodeRef parent, QName nodeType) { String uuid = GUID.generate(); Map props = new HashMap(); diff --git a/source/test-java/org/alfresco/repo/workflow/jbpm/JBPMEngineTest.java b/source/test-java/org/alfresco/repo/workflow/jbpm/JBPMEngineTest.java index eee8cc7f88..5d8d268ae6 100644 --- a/source/test-java/org/alfresco/repo/workflow/jbpm/JBPMEngineTest.java +++ b/source/test-java/org/alfresco/repo/workflow/jbpm/JBPMEngineTest.java @@ -654,7 +654,7 @@ public class JBPMEngineTest extends BaseAlfrescoSpringTest * Filter task list by workflow instance * * @param tasks - * @param processInstanceId + * @param workflowInstanceId * @return */ private List filterTasksByWorkflowInstance(List tasks, String workflowInstanceId) diff --git a/source/test-java/org/alfresco/repo/workflow/jbpm/ReviewAndApproveTest.java b/source/test-java/org/alfresco/repo/workflow/jbpm/ReviewAndApproveTest.java index 4bfc2a460f..98196775f4 100644 --- a/source/test-java/org/alfresco/repo/workflow/jbpm/ReviewAndApproveTest.java +++ b/source/test-java/org/alfresco/repo/workflow/jbpm/ReviewAndApproveTest.java @@ -162,7 +162,7 @@ public class ReviewAndApproveTest extends BaseSpringTest * Filter task list by workflow instance * * @param tasks - * @param processInstanceId + * @param workflowInstanceId * @return */ private List filterTasksByWorkflowInstance(List tasks, String workflowInstanceId) diff --git a/source/test-java/org/alfresco/tools/RenameUserTest.java b/source/test-java/org/alfresco/tools/RenameUserTest.java index 2b333e45ee..8b75909398 100644 --- a/source/test-java/org/alfresco/tools/RenameUserTest.java +++ b/source/test-java/org/alfresco/tools/RenameUserTest.java @@ -28,13 +28,13 @@ import java.util.Iterator; import org.alfresco.tools.RenameUser.User; import org.junit.After; import org.junit.Before; -import org.junit.Test; - -/** - * Unit test for RenameUser. {@link PersonTest} contains integration tests. - * - * @author Alan Davis - */ +import org.junit.Test; + +/** + * Unit test for RenameUser. {@link org.alfresco.repo.security.person.PersonTest} contains integration tests. + * + * @author Alan Davis + */ public class RenameUserTest { private String[] args; diff --git a/source/test-java/org/alfresco/util/test/junitrules/AbstractPersonRule.java b/source/test-java/org/alfresco/util/test/junitrules/AbstractPersonRule.java index da24bb128e..0d1271549a 100644 --- a/source/test-java/org/alfresco/util/test/junitrules/AbstractPersonRule.java +++ b/source/test-java/org/alfresco/util/test/junitrules/AbstractPersonRule.java @@ -43,13 +43,13 @@ public abstract class AbstractPersonRule extends AbstractRule } /** - * Constructs a person rule with a reference to an {@link ApplicationContextInit rule}. This other rule will - * be used to access the application context and from there the necessary services for the creation and deletion of users. - * - * @param appContext a rule which can provide the spring application context. - */ - public AbstractPersonRule(ApplicationContextInit appContextRule) - { + * Constructs a person rule with a reference to an {@link ApplicationContextInit rule}. This other rule will + * be used to access the application context and from there the necessary services for the creation and deletion of users. + * + * @param appContextRule a rule which can provide the spring application context. + */ + public AbstractPersonRule(ApplicationContextInit appContextRule) + { super(appContextRule); } diff --git a/source/test-java/org/alfresco/util/test/junitrules/AlfrescoTenant.java b/source/test-java/org/alfresco/util/test/junitrules/AlfrescoTenant.java index 9a9a79f05b..7a1e8c6419 100644 --- a/source/test-java/org/alfresco/util/test/junitrules/AlfrescoTenant.java +++ b/source/test-java/org/alfresco/util/test/junitrules/AlfrescoTenant.java @@ -84,13 +84,13 @@ public class AlfrescoTenant extends AbstractRule } /** - * Constructs the rule with a spring ApplicationContext. - * - * @param appContext the spring app context (needed to get at Alfresco services). - * @param userName the username for the person to be created. - */ - public AlfrescoTenant(ApplicationContext appContext, String tenantName) - { + * Constructs the rule with a spring ApplicationContext. + * + * @param appContext the spring app context (needed to get at Alfresco services). + * @param tenantName the tenantName for the person to be created. + */ + public AlfrescoTenant(ApplicationContext appContext, String tenantName) + { super(appContext); this.tenantName = tenantName.toLowerCase(); } diff --git a/source/test-java/org/alfresco/util/test/junitrules/TemporaryNodes.java b/source/test-java/org/alfresco/util/test/junitrules/TemporaryNodes.java index 5e84e040bd..aa88a79fb5 100644 --- a/source/test-java/org/alfresco/util/test/junitrules/TemporaryNodes.java +++ b/source/test-java/org/alfresco/util/test/junitrules/TemporaryNodes.java @@ -348,9 +348,9 @@ public class TemporaryNodes extends ExternalResource * list of NodeRefs to be tidied up by the rule. * This method will be run in its own transaction and will be run with the specified user as the fully authenticated user, * thus ensuring the named user is the cm:creator of the new node. - * + * + * @param quickFileName the file name of the quick file - will also be the cm:name of the new node. * @param parentNode the parent node - * @param nodeCmName the file name of the quick file - will also be the cm:name of the new node. * @param nodeCreator the username of the person who will create the node * @return the newly created NodeRef. * @since 4.1.4 diff --git a/source/test-java/org/alfresco/util/test/junitrules/TemporarySites.java b/source/test-java/org/alfresco/util/test/junitrules/TemporarySites.java index 0511f4ac83..4912130e3e 100644 --- a/source/test-java/org/alfresco/util/test/junitrules/TemporarySites.java +++ b/source/test-java/org/alfresco/util/test/junitrules/TemporarySites.java @@ -172,7 +172,7 @@ public class TemporarySites extends AbstractPersonRule * @param siteTitle the title of the new site * @param siteDescription the description of the new site * @param visibility the visibility - * @param node type the node type of the site (must be st:site or subtype) + * @param siteType the site type (must be st:site or subtype) * @param siteCreator the username of the person who will create the site * @return the newly created SiteInfo. */ diff --git a/source/test-java/org/alfresco/util/test/junitrules/TenantPerson.java b/source/test-java/org/alfresco/util/test/junitrules/TenantPerson.java index 02d0303576..3dc2910b2e 100644 --- a/source/test-java/org/alfresco/util/test/junitrules/TenantPerson.java +++ b/source/test-java/org/alfresco/util/test/junitrules/TenantPerson.java @@ -67,7 +67,7 @@ public class TenantPerson extends AlfrescoPerson /** * Constructs the rule with a reference to a {@link ApplicationContextInit rule} which can be used to retrieve the ApplicationContext. * - * @param appContextRule a rule which can be used to retrieve the spring app context. + * @param appContextInit a rule which can be used to retrieve the spring app context. * @param userName the username for the person to be created. * @param tenant the tenant the person should be created under. */