diff --git a/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java b/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java index 27b069fc98..712dcedf37 100644 --- a/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java +++ b/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java @@ -5,8 +5,8 @@ public interface TenantAuthentication /** * Authenticate user against tenant * - * @param username - * @param tenant + * @param username String + * @param tenant String * @return true => authenticated, false => not authenticated */ boolean authenticateTenant(String username, String tenant); diff --git a/source/java/org/alfresco/repo/web/scripts/BufferedResponse.java b/source/java/org/alfresco/repo/web/scripts/BufferedResponse.java index 52f10b454b..263b53bcfb 100644 --- a/source/java/org/alfresco/repo/web/scripts/BufferedResponse.java +++ b/source/java/org/alfresco/repo/web/scripts/BufferedResponse.java @@ -31,8 +31,8 @@ public class BufferedResponse implements WrappingWebScriptResponse /** * Construct * - * @param res - * @param bufferSize + * @param res WebScriptResponse + * @param bufferSize int */ public BufferedResponse(WebScriptResponse res, int bufferSize) { diff --git a/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java b/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java index c0e88d0835..b23628584c 100644 --- a/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java +++ b/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java @@ -115,7 +115,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl /** *

Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link org.springframework.extensions.webscripts.Container}.

- * @param extensibilityModuleHandler + * @param extensibilityModuleHandler WebScriptExtensibilityModuleHandler */ public void setExtensibilityModuleHandler(WebScriptExtensibilityModuleHandler extensibilityModuleHandler) { diff --git a/source/java/org/alfresco/repo/web/scripts/RepoStore.java b/source/java/org/alfresco/repo/web/scripts/RepoStore.java index d491babb33..42bf9ecd4c 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepoStore.java +++ b/source/java/org/alfresco/repo/web/scripts/RepoStore.java @@ -153,7 +153,7 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Sets whether the repo store must exist * - * @param mustExist + * @param mustExist boolean */ public void setMustExist(boolean mustExist) { @@ -293,7 +293,7 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Gets the display path for the specified node * - * @param nodeRef + * @param nodeRef NodeRef * @return display path */ protected String getPath(NodeRef nodeRef) @@ -305,7 +305,7 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Gets the node ref for the specified path within this repo store * - * @param documentPath + * @param documentPath String * @return node ref */ protected NodeRef findNodeRef(String documentPath) @@ -520,8 +520,8 @@ public class RepoStore extends AbstractStore implements TenantDeployer * to pass the document 'pattern' though the Lucene escaper, preserving the wildcard parts. Also, because you can't * search for whitespace in a QNAME, we have to replace whitespace with the ? wildcard * - * @param pattern - * @return + * @param pattern String + * @return String */ private static String lucenifyNamePattern(String pattern) { @@ -888,7 +888,7 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Construct * - * @param ref + * @param ref NodeRef */ private RepoTemplateSource(NodeRef ref) { @@ -1021,8 +1021,8 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Construct * - * @param path - * @param nodeRef + * @param path String + * @param nodeRef NodeRef */ public RepoScriptContent(String path, NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/web/scripts/RepositoryContainer.java b/source/java/org/alfresco/repo/web/scripts/RepositoryContainer.java index d5f160db54..742fd664af 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepositoryContainer.java +++ b/source/java/org/alfresco/repo/web/scripts/RepositoryContainer.java @@ -132,7 +132,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer } /** - * @param repository + * @param repository Repository */ public void setRepository(Repository repository) { @@ -140,7 +140,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer } /** - * @param imageResolver + * @param imageResolver RepositoryImageResolver */ public void setRepositoryImageResolver(RepositoryImageResolver imageResolver) { @@ -148,7 +148,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer } /** - * @param transactionService + * @param transactionService TransactionService */ public void setTransactionService(TransactionService transactionService) { @@ -164,7 +164,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer } /** - * @param descriptorService + * @param descriptorService DescriptorService */ public void setDescriptorService(DescriptorService descriptorService) { @@ -172,7 +172,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer } /** - * @param authorityService + * @param authorityService AuthorityService */ public void setAuthorityService(AuthorityService authorityService) { @@ -259,7 +259,7 @@ public class RepositoryContainer extends AbstractRuntimeContainer /** * Add Repository specific parameters * - * @param params + * @param params Map */ private void addRepoParameters(Map params) { @@ -443,8 +443,9 @@ public class RepositoryContainer extends AbstractRuntimeContainer /** * Execute script within required level of transaction * - * @param scriptReq - * @param scriptRes + * @param script WebScript + * @param scriptReq WebScriptRequest + * @param scriptRes WebScriptResponse * @throws IOException */ protected void transactionedExecute(final WebScript script, final WebScriptRequest scriptReq, final WebScriptResponse scriptRes) @@ -627,8 +628,9 @@ public class RepositoryContainer extends AbstractRuntimeContainer /** * Execute script within required level of transaction as required effective user. * - * @param scriptReq - * @param scriptRes + * @param script WebScript + * @param scriptReq WebScriptRequest + * @param scriptRes WebScriptResponse * @throws IOException */ private void transactionedExecuteAs(final WebScript script, final WebScriptRequest scriptReq, diff --git a/source/java/org/alfresco/repo/web/scripts/RepositoryScriptProcessor.java b/source/java/org/alfresco/repo/web/scripts/RepositoryScriptProcessor.java index 0dccb3b949..37f8cf5bae 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepositoryScriptProcessor.java +++ b/source/java/org/alfresco/repo/web/scripts/RepositoryScriptProcessor.java @@ -55,7 +55,7 @@ public class RepositoryScriptProcessor implements ScriptProcessor /** - * @param scriptService + * @param scriptService ScriptService */ public void setScriptService(ScriptService scriptService) { @@ -63,7 +63,7 @@ public class RepositoryScriptProcessor implements ScriptProcessor } /** - * @param searchPath + * @param searchPath SearchPath */ public void setSearchPath(SearchPath searchPath) { diff --git a/source/java/org/alfresco/repo/web/scripts/RepositoryServerModel.java b/source/java/org/alfresco/repo/web/scripts/RepositoryServerModel.java index 8971d8d777..d057fb6119 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepositoryServerModel.java +++ b/source/java/org/alfresco/repo/web/scripts/RepositoryServerModel.java @@ -35,7 +35,8 @@ public class RepositoryServerModel implements ServerModel /** * Construct * - * @param serverDescriptor + * @param currentDescriptor Descriptor + * @param serverDescriptor Descriptor */ /*package*/ RepositoryServerModel(Descriptor currentDescriptor, Descriptor serverDescriptor) { diff --git a/source/java/org/alfresco/repo/web/scripts/RepositoryTemplateProcessor.java b/source/java/org/alfresco/repo/web/scripts/RepositoryTemplateProcessor.java index 6df631a393..3e0475f2af 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepositoryTemplateProcessor.java +++ b/source/java/org/alfresco/repo/web/scripts/RepositoryTemplateProcessor.java @@ -96,7 +96,7 @@ public class RepositoryTemplateProcessor extends FreeMarkerProcessor } /** - * @param searchPath + * @param searchPath SearchPath */ public void setSearchPath(SearchPath searchPath) { diff --git a/source/java/org/alfresco/repo/web/scripts/TenantWebScriptServletRequest.java b/source/java/org/alfresco/repo/web/scripts/TenantWebScriptServletRequest.java index d01473c8ad..52205526c2 100644 --- a/source/java/org/alfresco/repo/web/scripts/TenantWebScriptServletRequest.java +++ b/source/java/org/alfresco/repo/web/scripts/TenantWebScriptServletRequest.java @@ -46,13 +46,14 @@ public class TenantWebScriptServletRequest extends WebScriptServletRequest tenant = realPathInfo.substring(1, idx == -1 ? realPathInfo.length() : idx); pathInfo = realPathInfo.substring(tenant.length() + 1); } - + /** * Construction * - * @param container request generator - * @param req - * @param serviceMatch + * @param container Runtime + * @param req HttpServletRequest + * @param serviceMatch Match + * @param serverProperties ServerProperties */ public TenantWebScriptServletRequest(Runtime container, HttpServletRequest req, Match serviceMatch, ServerProperties serverProperties) { diff --git a/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java b/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java index 9b95ed1539..1dc9141f2f 100644 --- a/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java @@ -167,7 +167,7 @@ public abstract class AbstractArchivedNodeWebScript extends DeclarativeWebScript * @param storeRef mandatory store ref * @param paging mandatory paging * @param filter optional filter - * @return + * @return PagingResults */ protected PagingResults getArchivedNodesFrom(StoreRef storeRef, ScriptPagingDetails paging, String filter) { diff --git a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java b/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java index f44ca1b1ea..c5217d77c6 100644 --- a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java @@ -50,7 +50,7 @@ public class ArchivedNodesGet extends AbstractArchivedNodeWebScript /** * This method is used to inject {@link org.alfresco.repo.web.scripts.archive.ArchivedNodesFilter node filters} on this GET call. * - * @param nodeFilters + * @param nodeFilters List */ public void setArchivedNodeFilters(List nodeFilters) { diff --git a/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java b/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java index 28a5067ed7..540e8cb1f1 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java @@ -865,8 +865,8 @@ public class ADMRemoteStore extends BaseRemoteStore *

* Disassmbles the path to correct match either user, site or generic folder path. * - * @param path - * @param create + * @param path String + * @param create boolean * * @return NodeRef to the "surf-config" folder, or null if it does not exist yet. */ diff --git a/source/java/org/alfresco/repo/web/scripts/bean/AbstractLoginBean.java b/source/java/org/alfresco/repo/web/scripts/bean/AbstractLoginBean.java index 99578e462a..13f2026757 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/AbstractLoginBean.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/AbstractLoginBean.java @@ -47,7 +47,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest; protected EventPublisher eventPublisher; /** - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { @@ -55,7 +55,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest; } /** - * @param eventPublisher + * @param eventPublisher EventPublisher */ public void setEventPublisher(EventPublisher eventPublisher) { diff --git a/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java b/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java index 8e06852b58..88c0e3dd28 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java @@ -365,8 +365,7 @@ public abstract class BaseRemoteStore extends AbstractWebScript * * @param store the store id * @param path document path - * @return - * + * * @throws IOException if an error occurs retrieving the document */ protected abstract void getDocument(WebScriptResponse res, String store, String path) @@ -409,7 +408,6 @@ public abstract class BaseRemoteStore extends AbstractWebScript * @param path document path * @param content content of the document to write * - * @throws IOException if the create fails */ protected abstract void createDocument(WebScriptResponse res, String store, String path, InputStream content); @@ -420,7 +418,6 @@ public abstract class BaseRemoteStore extends AbstractWebScript * @param store the store id * @param content content of the document to write * - * @throws IOException if the create fails */ protected abstract void createDocuments(WebScriptResponse res, String store, InputStream content); @@ -431,7 +428,6 @@ public abstract class BaseRemoteStore extends AbstractWebScript * @param path document path * @param content content to update the document with * - * @throws IOException if the update fails */ protected abstract void updateDocument(WebScriptResponse res, String store, String path, InputStream content); @@ -441,7 +437,6 @@ public abstract class BaseRemoteStore extends AbstractWebScript * @param store the store id * @param path document path * - * @throws IOException if the delete fails */ protected abstract void deleteDocument(WebScriptResponse res, String store, String path); diff --git a/source/java/org/alfresco/repo/web/scripts/bean/LoginTicket.java b/source/java/org/alfresco/repo/web/scripts/bean/LoginTicket.java index 42994f130d..03fb7bdc09 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/LoginTicket.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/LoginTicket.java @@ -43,7 +43,7 @@ public class LoginTicket extends DeclarativeWebScript private TicketComponent ticketComponent; /** - * @param ticketComponent + * @param ticketComponent TicketComponent */ public void setTicketComponent(TicketComponent ticketComponent) { diff --git a/source/java/org/alfresco/repo/web/scripts/bean/LoginTicketDelete.java b/source/java/org/alfresco/repo/web/scripts/bean/LoginTicketDelete.java index f2efc85951..6523707544 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/LoginTicketDelete.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/LoginTicketDelete.java @@ -45,7 +45,7 @@ public class LoginTicketDelete extends DeclarativeWebScript private TicketComponent ticketComponent; /** - * @param ticketComponent + * @param ticketComponent TicketComponent */ public void setTicketComponent(TicketComponent ticketComponent) { @@ -53,7 +53,7 @@ public class LoginTicketDelete extends DeclarativeWebScript } /** - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { diff --git a/source/java/org/alfresco/repo/web/scripts/bean/SearchEngines.java b/source/java/org/alfresco/repo/web/scripts/bean/SearchEngines.java index c4f4b2b648..cc022824a1 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/SearchEngines.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/SearchEngines.java @@ -55,7 +55,7 @@ public class SearchEngines extends DeclarativeWebScript protected SearchProxy searchProxy; /** - * @param configService + * @param configService ConfigService */ public void setConfigService(ConfigService configService) { @@ -63,7 +63,7 @@ public class SearchEngines extends DeclarativeWebScript } /** - * @param searchProxy + * @param searchProxy SearchProxy */ public void setSearchProxy(SearchProxy searchProxy) { diff --git a/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java b/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java index c78637c160..229ed1449c 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java @@ -77,7 +77,7 @@ public class SearchProxy extends AbstractWebScript implements InitializingBean protected String proxyPath; /** - * @param formatRegistry + * @param formatRegistry FormatRegistry */ public void setFormatRegistry(FormatRegistry formatRegistry) { @@ -85,7 +85,7 @@ public class SearchProxy extends AbstractWebScript implements InitializingBean } /** - * @param configService + * @param configService ConfigService */ public void setConfigService(ConfigService configService) { @@ -192,10 +192,10 @@ public class SearchProxy extends AbstractWebScript implements InitializingBean /** * Construct * - * @param rootPath - * @param engine - * @param engineUrl - * @param response + * @param rootPath String + * @param engine String + * @param engineUrl String + * @param response HttpServletResponse * @param headers request headers * @throws MalformedURLException */ diff --git a/source/java/org/alfresco/repo/web/scripts/blogs/posts/BlogPostsPost.java b/source/java/org/alfresco/repo/web/scripts/blogs/posts/BlogPostsPost.java index 87f326ffba..0b99dd9be5 100644 --- a/source/java/org/alfresco/repo/web/scripts/blogs/posts/BlogPostsPost.java +++ b/source/java/org/alfresco/repo/web/scripts/blogs/posts/BlogPostsPost.java @@ -151,7 +151,7 @@ public class BlogPostsPost extends AbstractBlogWebScript /** * Taken from JS - * @param node + * @param node NodeRef */ private void ensureTagScope(NodeRef node) { diff --git a/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java b/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java index 3b3cbdf33d..3598fe6b4d 100644 --- a/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java +++ b/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java @@ -102,7 +102,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Sets the proxy configuration * - * @param proxyConfig + * @param proxyConfig ProxyConfig */ /*package*/ void setProxy(ProxyConfig proxyConfig) { @@ -168,8 +168,8 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Construct * - * @param label - * @param labelId + * @param label String + * @param labelId String */ public EngineConfig(String label, String labelId) { @@ -184,9 +184,9 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Construct * - * @param label - * @param labelId - * @param proxy + * @param label String + * @param labelId String + * @param proxy String */ public EngineConfig(String label, String labelId, String proxy) { @@ -254,7 +254,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Construct * - * @param url + * @param url String */ public ProxyConfig(String url) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java b/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java index 2b84ce61ea..bbbd314bb0 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java +++ b/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java @@ -60,7 +60,7 @@ public class ContentGet extends StreamContent implements ServletContextAware private ContentService contentService; /** - * @param + * @param servletContext ServletContext */ public void setServletContext(ServletContext servletContext) { @@ -68,7 +68,7 @@ public class ContentGet extends StreamContent implements ServletContextAware } /** - * @param dictionaryService + * @param dictionaryService DictionaryService */ public void setDictionaryService(DictionaryService dictionaryService) { @@ -76,7 +76,7 @@ public class ContentGet extends StreamContent implements ServletContextAware } /** - * @param namespaceService + * @param namespaceService NamespaceService */ public void setNamespaceService(NamespaceService namespaceService) { @@ -84,7 +84,7 @@ public class ContentGet extends StreamContent implements ServletContextAware } /** - * @param contentService + * @param contentService ContentService */ public void setContentService(ContentService contentService) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java b/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java index 4c8a7d5a22..c17ba60002 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java +++ b/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java @@ -78,7 +78,7 @@ public class ContentStreamer implements ResourceLoaderAware protected EventPublisher eventPublisher; protected SiteService siteService; /** - * @param mimetypeService + * @param mimetypeService MimetypeService */ public void setMimetypeService(MimetypeService mimetypeService) { @@ -86,7 +86,7 @@ public class ContentStreamer implements ResourceLoaderAware } /** - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -116,7 +116,7 @@ public class ContentStreamer implements ResourceLoaderAware } /** - * @param contentService + * @param contentService ContentService */ public void setContentService(ContentService contentService) @@ -433,10 +433,10 @@ public class ContentStreamer implements ResourceLoaderAware /** * Set attachment header * - * @param req - * @param res - * @param attach - * @param attachFileName + * @param req WebScriptRequest + * @param res WebScriptResponse + * @param attach boolean + * @param attachFileName String */ public void setAttachment(WebScriptRequest req, WebScriptResponse res, boolean attach, String attachFileName) { @@ -478,9 +478,10 @@ public class ContentStreamer implements ResourceLoaderAware /** * Set the cache settings on the response * - * @param res - * @param modified - * @param eTag + * @param res WebScriptResponse + * @param modified Date + * @param eTag String + * @param model Map */ protected void setResponseCache(WebScriptResponse res, Date modified, String eTag, Map model) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java b/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java index 3874270fd4..567ae6ea48 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java @@ -138,7 +138,7 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon * Sets the map of content transformer worker bean names to * message formatting labels * - * @param knownWorkerBeanLabels + * @param knownWorkerBeanLabels Map */ public void setKnownWorkerBeanLabels(Map knownWorkerBeanLabels) { @@ -252,8 +252,8 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon /** * Gets the display label for complex transformers - * - * @param cct + * + * @param cct ComplexContentTransformer * @return the transformer display label */ protected String getComplexTransformerLabel(ComplexContentTransformer cct) @@ -268,7 +268,7 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon /** * Gets the display label for proxy content transformers * - * @param pct + * @param pct ProxyContentTransformer * @return the transformer display label */ protected String getProxyTransformerLabel(ProxyContentTransformer pct) @@ -290,7 +290,7 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon *

* In the future ContentTransformerWorker may be made bean name aware. * - * @param ctw + * @param ctw ContentTransformerWorker * @return the bean name */ protected String getWorkerBeanName(ContentTransformerWorker ctw) diff --git a/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java b/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java index 45860131af..14416c8fb6 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java +++ b/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java @@ -66,14 +66,14 @@ public class StreamContent extends AbstractWebScript protected Repository repository; /** - * @param mimetypeService + * @param mimetypeService MimetypeService */ public void setMimetypeService(MimetypeService mimetypeService) { this.mimetypeService = mimetypeService; } /** - * @param permissionService + * @param permissionService PermissionService */ public void setPermissionService(PermissionService permissionService) { @@ -81,7 +81,7 @@ public class StreamContent extends AbstractWebScript } /** - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -89,7 +89,7 @@ public class StreamContent extends AbstractWebScript } /** - * @param delegate + * @param delegate ContentStreamer */ public void setDelegate(ContentStreamer delegate) { @@ -97,7 +97,7 @@ public class StreamContent extends AbstractWebScript } /** - * @param repository + * @param repository Repository */ public void setRepository(Repository repository) { @@ -199,9 +199,9 @@ public class StreamContent extends AbstractWebScript /** * Set attachment header * - * @param res - * @param attach - * @param attachFileName + * @param res WebScriptResponse + * @param attach boolean + * @param attachFileName String */ protected void setAttachment(WebScriptResponse res, boolean attach, String attachFileName) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationGet.java index 551dd5d352..435807c539 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationGet.java @@ -36,7 +36,7 @@ public abstract class AbstractAssociationGet extends DictionaryWebServiceBase private static final String MODEL_PROP_KEY_ASSOCIATION_DETAILS = "assocdefs"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java index 53c1dde31e..1de25ec9ab 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java @@ -42,7 +42,7 @@ public abstract class AbstractAssociationsGet extends DictionaryWebServiceBase private static final String REQ_URL_TEMPL_VAR_ASSOCIATION_FILTER = "af"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassGet.java index 7ee0273875..7ceab24d9e 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassGet.java @@ -42,7 +42,7 @@ public abstract class AbstractClassGet extends DictionaryWebServiceBase private static final String MODEL_PROP_KEY_ASSOCIATION_DETAILS = "assocdefs"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java index 5186ae8f76..cf8b23b0a6 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java @@ -55,7 +55,7 @@ public abstract class AbstractClassesGet extends DictionaryWebServiceBase private static final String REQ_URL_TEMPL_VAR_NAME = "n"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertiesGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertiesGet.java index fdfc02a09f..9eed485f8a 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertiesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertiesGet.java @@ -51,7 +51,7 @@ public abstract class AbstractPropertiesGet extends DictionaryWebServiceBase private static final String REQ_PARM_ALLOWED_TYPE = "type"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertyGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertyGet.java index d8232c6ff7..57c0ea51b5 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertyGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractPropertyGet.java @@ -37,7 +37,7 @@ public abstract class AbstractPropertyGet extends DictionaryWebServiceBase private static final String MODEL_PROP_KEY_PROPERTY_DETAILS = "propertydefs"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractSubClassesGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractSubClassesGet.java index 1e7b2c9ba3..0ab3313fb4 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractSubClassesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractSubClassesGet.java @@ -52,7 +52,7 @@ public abstract class AbstractSubClassesGet extends DictionaryWebServiceBase private static final String REQ_URL_TEMPL_VAR_NAME = "n"; /** - * @Override method from DeclarativeWebScript + * Override method from DeclarativeWebScript */ protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/ClassGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/ClassGet.java index 54f4dec630..f999138228 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/ClassGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/ClassGet.java @@ -33,7 +33,7 @@ public class ClassGet extends AbstractClassGet private static final String DICTIONARY_CLASS_NAME = "className"; /** - * @Override method from AbstractClassGet + * Override method from AbstractClassGet */ @Override protected QName getClassQname(WebScriptRequest req) diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java b/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java index 70842cfdcc..4f7441f23b 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java @@ -122,7 +122,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript /** - * @param qname + * @param qname QName * @return the namespaceuri from a qname */ public String getNamespaceURIfromQname(QName qname) @@ -313,8 +313,8 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript } /** - * @param classname - * @returns the shortname from the classname of the format cm_person + * @param classname String + * @return the shortname from the classname of the format cm_person * here person represents the shortname */ public String getShortName(String classname) diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/prefixed/ClassGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/prefixed/ClassGet.java index 91db3df1d5..c61955d6c2 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/prefixed/ClassGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/prefixed/ClassGet.java @@ -36,7 +36,7 @@ public class ClassGet extends AbstractClassGet private static final String DICTIONARY_SHORT_CLASS_NAME = "shortClassName"; /** - * @Override method from AbstractClassGet + * Override method from AbstractClassGet */ @Override protected QName getClassQname(WebScriptRequest req) diff --git a/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java b/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java index 38ce49d27e..711b93fd73 100644 --- a/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java +++ b/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java @@ -80,7 +80,7 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Sets the searchService. * - * @param searchService + * @param searchService SearchService */ public void setSearchService(SearchService searchService) { @@ -90,11 +90,11 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Overrides AbstractDiscussionWebScript to allow a null site * - * @param req - * @param status - * @param cache + * @param req WebScriptRequest + * @param status Status + * @param cache Cache * - * @return + * @return Map */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) @@ -125,15 +125,15 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript } /** - * @param site + * @param site SiteInfo * @param nodeRef Not required. It is only included because it is overriding the parent class. * @param topic Not required. It is only included because it is overriding the parent class. * @param post Not required. It is only included because it is overriding the parent class. - * @param req + * @param req WebScriptRequest * @param status Not required. It is only included because it is overriding the parent class. * @param cache Not required. It is only included because it is overriding the parent class. * - * @return + * @return Map */ @Override protected Map executeImpl(SiteInfo site, NodeRef nodeRef, TopicInfo topic, @@ -189,9 +189,9 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript * Do the actual search * * @param searchQuery Pair with query string in first and query language in second - * @param sortAscending - * @param paging - * @return + * @param sortAscending boolean + * @param paging PagingRequest + * @return PagingResults */ protected PagingResults doSearch(Pair searchQuery, boolean sortAscending, PagingRequest paging) { @@ -240,9 +240,9 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Build the search query from the passed in parameters and SEARCH_QUERY constant * - * @param site - * @param author - * @param daysAgo + * @param site SiteInfo + * @param author String + * @param daysAgo int * @return Pair with the query string in first and query language in second */ protected Pair getSearchQuery(SiteInfo site, String author, int daysAgo) @@ -267,8 +267,8 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Get the date x days ago in the format 'yyyy-MM-dd' * - * @param daysAgo - * @return + * @param daysAgo int + * @return String */ protected String getDateXDaysAgo(int daysAgo) { @@ -282,8 +282,8 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Builds up a listing Paging request, based on the arguments specified in the URL * - * @param req - * @return + * @param req WebScriptRequest + * @return PagingRequest */ @Override protected PagingRequest buildPagingRequest(WebScriptRequest req) @@ -308,9 +308,9 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript /** * Wrap up search results as {@link TopicInfo} instances * - * @param finalResults - * @param paging - * @return + * @param finalResults ResultSet + * @param paging PagingRequest + * @return PagingResults */ protected PagingResults wrap(final ResultSet finalResults, PagingRequest paging) { diff --git a/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java b/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java index e7cee633c6..e4f1788d7f 100644 --- a/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java +++ b/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java @@ -28,7 +28,7 @@ import org.alfresco.service.namespace.QName; /** * This interface defines a simple POJO/DTO for use in the FTL model and rendering in the JSON API. - * @param a type to ensure that the comparator is implemented in a typesafe way. + * @param a type to ensure that the comparator is implemented in a typesafe way. * @since 5.0 */ public abstract class FacetablePropertyFTL implements Comparable diff --git a/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java b/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java index b86929a129..faabace3af 100644 --- a/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java +++ b/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java @@ -51,7 +51,7 @@ public class JSR168PortletAuthenticatorFactory implements PortletAuthenticatorFa private TransactionService txnService; /** - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setUnprotAuthenticationService(AuthenticationService authenticationService) { @@ -59,7 +59,7 @@ public class JSR168PortletAuthenticatorFactory implements PortletAuthenticatorFa } /** - * @param transactionService + * @param transactionService TransactionService */ public void setTransactionService(TransactionService transactionService) { @@ -88,8 +88,8 @@ public class JSR168PortletAuthenticatorFactory implements PortletAuthenticatorFa /** * Construct * - * @param req - * @param res + * @param req RenderRequest + * @param res RenderResponse */ public JSR168PortletAuthenticator(RenderRequest req, RenderResponse res) { diff --git a/source/java/org/alfresco/repo/web/scripts/rendition/patch/PatchThumbnailsAsRenditionsGet.java b/source/java/org/alfresco/repo/web/scripts/rendition/patch/PatchThumbnailsAsRenditionsGet.java index 590c8e5335..2adbb23991 100644 --- a/source/java/org/alfresco/repo/web/scripts/rendition/patch/PatchThumbnailsAsRenditionsGet.java +++ b/source/java/org/alfresco/repo/web/scripts/rendition/patch/PatchThumbnailsAsRenditionsGet.java @@ -58,7 +58,7 @@ public class PatchThumbnailsAsRenditionsGet extends DeclarativeWebScript /** * Sets the nodeService. * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -68,7 +68,7 @@ public class PatchThumbnailsAsRenditionsGet extends DeclarativeWebScript /** * Sets the renditionService. * - * @param renditionService + * @param renditionService RenditionService */ public void setRenditionService(RenditionService renditionService) { @@ -78,7 +78,7 @@ public class PatchThumbnailsAsRenditionsGet extends DeclarativeWebScript /** * Sets the searchService. * - * @param searchService + * @param searchService SearchService */ public void setSearchService(SearchService searchService) { diff --git a/source/java/org/alfresco/repo/web/scripts/replication/ReplicationServiceStatusGet.java b/source/java/org/alfresco/repo/web/scripts/replication/ReplicationServiceStatusGet.java index 98893568bf..c3acf0248c 100644 --- a/source/java/org/alfresco/repo/web/scripts/replication/ReplicationServiceStatusGet.java +++ b/source/java/org/alfresco/repo/web/scripts/replication/ReplicationServiceStatusGet.java @@ -40,7 +40,7 @@ public class ReplicationServiceStatusGet extends DeclarativeWebScript /** * Used to inject the {@link ReplicationService}. * - * @param replicationService + * @param replicationService ReplicationService */ public void setReplicationService(ReplicationService replicationService) { diff --git a/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java b/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java index 3f881f4876..01d78bd1d1 100644 --- a/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java +++ b/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java @@ -55,7 +55,7 @@ public class BasicHttpAuthenticatorFactory implements ServletAuthenticatorFactor /** - * @param authenticationService + * @param authenticationService AuthenticationService */ public void setAuthenticationService(AuthenticationService authenticationService) { @@ -113,9 +113,9 @@ public class BasicHttpAuthenticatorFactory implements ServletAuthenticatorFactor /** * Construct * - * @param req - * @param res - * @param listener + * @param req WebScriptServletRequest + * @param res WebScriptServletResponse + * @param listener AuthenticationListener */ public BasicHttpAuthenticator(WebScriptServletRequest req, WebScriptServletResponse res, AuthenticationListener listener) { diff --git a/source/java/org/alfresco/repo/web/scripts/solr/NodeContentGet.java b/source/java/org/alfresco/repo/web/scripts/solr/NodeContentGet.java index 6b76a0e642..fe7ec3a03e 100644 --- a/source/java/org/alfresco/repo/web/scripts/solr/NodeContentGet.java +++ b/source/java/org/alfresco/repo/web/scripts/solr/NodeContentGet.java @@ -89,7 +89,7 @@ public class NodeContentGet extends StreamContent /** * Setter of the transformer debug. - * @param transformerDebug + * @param transformerDebug TransformerDebug */ public void setTransformerDebug(TransformerDebug transformerDebug) { @@ -97,7 +97,10 @@ public class NodeContentGet extends StreamContent } /** - * @in + * + * @param req WebScriptRequest + * @param res WebScriptResponse + * @throws IOException */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException { diff --git a/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java b/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java index 1af34fbd4c..87ef81af2f 100644 --- a/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java +++ b/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java @@ -130,7 +130,7 @@ public class StatsGet extends DeclarativeWebScript /** * Finds a facet based on its key - * @param facetKey + * @param facetKey String * @return QName facet */ private QName findFacet(String facetKey) diff --git a/source/java/org/alfresco/repo/web/scripts/transfer/TransferWebScript.java b/source/java/org/alfresco/repo/web/scripts/transfer/TransferWebScript.java index 09aa2ce97a..2c81706f6f 100644 --- a/source/java/org/alfresco/repo/web/scripts/transfer/TransferWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/transfer/TransferWebScript.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 . */ @@ -75,9 +75,9 @@ public class TransferWebScript extends AbstractWebScript } /** - * @param command - * @param req - * @param res + * @param command String + * @param req WebScriptRequest + * @param res WebScriptResponse */ private void processCommand(String command, WebScriptRequest req, WebScriptResponse res) { diff --git a/source/java/org/alfresco/repo/web/scripts/workflow/AbstractWorkflowWebscript.java b/source/java/org/alfresco/repo/web/scripts/workflow/AbstractWorkflowWebscript.java index 514130d04f..a838da6a8d 100644 --- a/source/java/org/alfresco/repo/web/scripts/workflow/AbstractWorkflowWebscript.java +++ b/source/java/org/alfresco/repo/web/scripts/workflow/AbstractWorkflowWebscript.java @@ -257,7 +257,7 @@ public abstract class AbstractWorkflowWebscript extends DeclarativeWebScript /** * Get capacity instaead of size of list * MNT-9074 My Tasks fails to render if tasks quantity is excessive - * @param list + * @param list List * @return capacity of list * @throws Exception */ diff --git a/source/java/org/alfresco/repo/web/scripts/workflow/TaskInstancesGet.java b/source/java/org/alfresco/repo/web/scripts/workflow/TaskInstancesGet.java index b034c56e26..7c702da390 100644 --- a/source/java/org/alfresco/repo/web/scripts/workflow/TaskInstancesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/workflow/TaskInstancesGet.java @@ -240,8 +240,8 @@ public class TaskInstancesGet extends AbstractWorkflowWebscript /** * Gets the specified {@link WorkflowTaskState}, null if not requested * - * @param req - * @return + * @param req WebScriptRequest + * @return WorkflowTaskState */ private WorkflowTaskState getState(WebScriptRequest req) { @@ -264,8 +264,8 @@ public class TaskInstancesGet extends AbstractWorkflowWebscript /** * Returns the specified authority. If no authority is specified then returns the current Fully Authenticated user. - * @param req - * @return + * @param req WebScriptRequest + * @return String */ private String getAuthority(WebScriptRequest req) { diff --git a/source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilder.java b/source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilder.java index cafe658e74..7dcd446e73 100644 --- a/source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilder.java +++ b/source/java/org/alfresco/repo/web/scripts/workflow/WorkflowModelBuilder.java @@ -177,7 +177,7 @@ public class WorkflowModelBuilder * Returns a simple representation of a {@link WorkflowTask}. * @param task The task to be represented. * @param propertyFilters Specify which properties to include. - * @return + * @return Map */ public Map buildSimple(WorkflowTask task, Collection propertyFilters) { @@ -219,7 +219,7 @@ public class WorkflowModelBuilder /** * Returns a detailed representation of a {@link WorkflowTask}. * @param workflowTask The task to be represented. - * @return + * @return Map */ public Map buildDetailed(WorkflowTask workflowTask) { @@ -234,7 +234,7 @@ public class WorkflowModelBuilder /** * Returns a simple representation of a {@link WorkflowInstance}. * @param workflowInstance The workflow instance to be represented. - * @return + * @return Map */ public Map buildSimple(WorkflowInstance workflowInstance) { @@ -303,7 +303,7 @@ public class WorkflowModelBuilder * Returns a detailed representation of a {@link WorkflowInstance}. * @param workflowInstance The workflow instance to be represented. * @param includeTasks should we include task in model? - * @return + * @return Map */ public Map buildDetailed(WorkflowInstance workflowInstance, boolean includeTasks) { @@ -350,7 +350,7 @@ public class WorkflowModelBuilder * Returns a simple representation of a {@link WorkflowDefinition}. * * @param workflowDefinition the WorkflowDefinition object to be represented. - * @return + * @return Map */ public Map buildSimple(WorkflowDefinition workflowDefinition) { @@ -370,7 +370,7 @@ public class WorkflowModelBuilder * Returns a detailed representation of a {@link WorkflowDefinition}. * * @param workflowDefinition the WorkflowDefinition object to be represented. - * @return + * @return Map */ public Map buildDetailed(WorkflowDefinition workflowDefinition) { @@ -608,8 +608,8 @@ public class WorkflowModelBuilder } /** - * @param properties - * @return + * @param properties Map + * @return List */ private List getHiddenTransitions(Map properties) { diff --git a/source/java/org/alfresco/repo/web/util/HttpRangeProcessor.java b/source/java/org/alfresco/repo/web/util/HttpRangeProcessor.java index 837a790ed0..75fb4c4120 100644 --- a/source/java/org/alfresco/repo/web/util/HttpRangeProcessor.java +++ b/source/java/org/alfresco/repo/web/util/HttpRangeProcessor.java @@ -58,7 +58,7 @@ public class HttpRangeProcessor /** * Constructor. * - * @param contentService + * @param contentService ContentService */ public HttpRangeProcessor(ContentService contentService) { @@ -444,7 +444,6 @@ public class HttpRangeProcessor * @param os ServletOutputStream * @param offset Assumed InputStream position - to calculate skip bytes from * - * @return current InputStream position - so the stream can be reused if required */ private void streamRangeBytes(final Range r, final InputStream is, final OutputStream os, long offset) throws IOException diff --git a/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java b/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java index 901ef23596..7b2e07e1f7 100644 --- a/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java +++ b/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java @@ -53,8 +53,8 @@ public class ActivityPosterImpl implements WebDAVActivityPoster /** * Constructor * - * @param appTool - * @param poster + * @param appTool String + * @param poster ActivityPoster */ public ActivityPosterImpl(String appTool, ActivityPoster poster) { diff --git a/source/java/org/alfresco/repo/webdav/ExceptionHandler.java b/source/java/org/alfresco/repo/webdav/ExceptionHandler.java index 5a4d238a80..3ad5c3dcc5 100644 --- a/source/java/org/alfresco/repo/webdav/ExceptionHandler.java +++ b/source/java/org/alfresco/repo/webdav/ExceptionHandler.java @@ -43,9 +43,9 @@ public class ExceptionHandler /** * Create an ExceptionHandler. * - * @param e - * @param request - * @param response + * @param e Throwable + * @param request HttpServletRequest + * @param response HttpServletResponse */ public ExceptionHandler(Throwable e, HttpServletRequest request, HttpServletResponse response) { diff --git a/source/java/org/alfresco/repo/webdav/LockInfoImpl.java b/source/java/org/alfresco/repo/webdav/LockInfoImpl.java index 45282afe92..fbcac35a23 100644 --- a/source/java/org/alfresco/repo/webdav/LockInfoImpl.java +++ b/source/java/org/alfresco/repo/webdav/LockInfoImpl.java @@ -1,19 +1,19 @@ /* * Copyright (C) 2005-2015 Alfresco Software Limited. - * - * This file is part of Alfresco - * - * Alfresco is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Alfresco is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License + * + * This file is part of Alfresco + * + * Alfresco is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Alfresco is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License * along with Alfresco. If not, see . */ package org.alfresco.repo.webdav; @@ -31,7 +31,7 @@ import org.codehaus.jackson.map.ObjectMapper; * Class to represent a WebDAV lock info. Instances of this class are accessible * my multiple threads as they are kept in the {@link LockStore}. Clients of this * class are expected to synchronise externally using the provided - * ReentrantReadWriteLock (use {@link #getRWLock()}). + * ReentrantReadWriteLock. * * @author Ivan Rybnikov * @@ -125,7 +125,7 @@ public class LockInfoImpl implements Serializable, LockInfo /** * Setter for lock scope. * - * @param scope + * @param scope String */ @Override public void setScope(String scope) @@ -180,7 +180,7 @@ public class LockInfoImpl implements Serializable, LockInfo /** * Setter for sharedLockTokens list. * - * @param sharedLockTokens + * @param sharedLockTokens Set */ @Override public void setSharedLockTokens(Set sharedLockTokens) @@ -394,7 +394,7 @@ public class LockInfoImpl implements Serializable, LockInfo * Sets the expiry date/time to lockTimeout seconds into the future. Provide * a lockTimeout of WebDAV.TIMEOUT_INFINITY for never expires. * - * @param lockTimeoutSecs + * @param lockTimeoutSecs int */ @Override @JsonIgnore @@ -417,7 +417,7 @@ public class LockInfoImpl implements Serializable, LockInfo * Sets the expiry date/time to lockTimeout minutes into the future. Provide * a lockTimeout of WebDAV.TIMEOUT_INFINITY for never expires. * - * @param lockTimeoutMins + * @param lockTimeoutMins int */ @Override @JsonIgnore diff --git a/source/java/org/alfresco/repo/webdav/MkcolMethod.java b/source/java/org/alfresco/repo/webdav/MkcolMethod.java index cdbafe34ee..2bad7161c8 100644 --- a/source/java/org/alfresco/repo/webdav/MkcolMethod.java +++ b/source/java/org/alfresco/repo/webdav/MkcolMethod.java @@ -47,7 +47,7 @@ public class MkcolMethod extends WebDAVMethod implements ActivityPostProducer /** * Parse the request headers * - * @Exception WebDAVServerException + * @throws WebDAVServerException */ protected void parseRequestHeaders() throws WebDAVServerException { diff --git a/source/java/org/alfresco/repo/webdav/PropFindMethod.java b/source/java/org/alfresco/repo/webdav/PropFindMethod.java index ea8794a0e6..b03b65fd07 100644 --- a/source/java/org/alfresco/repo/webdav/PropFindMethod.java +++ b/source/java/org/alfresco/repo/webdav/PropFindMethod.java @@ -956,7 +956,7 @@ public class PropFindMethod extends WebDAVMethod /** * Loads all dead properties persisted on the node * - * @param nodeRef + * @param nodeRef NodeRef * @return the map of all dead properties */ @SuppressWarnings("unchecked") @@ -1022,8 +1022,7 @@ public class PropFindMethod extends WebDAVMethod /** * Output the lockentry element of the specified type * @param xml XMLWriter - * @param lockType lock type. Can be WebDAV.XML_NS_EXCLUSIVE or WebDAV.XML_NS_SHARED - * @param lockType lock type containing namespace + * @param lockType lock type containing namespace. Can be WebDAV.XML_NS_EXCLUSIVE or WebDAV.XML_NS_SHARED * @throws SAXException * @throws IOException */ diff --git a/source/java/org/alfresco/repo/webdav/PropPatchMethod.java b/source/java/org/alfresco/repo/webdav/PropPatchMethod.java index 9e646b6208..da33fb6f94 100644 --- a/source/java/org/alfresco/repo/webdav/PropPatchMethod.java +++ b/source/java/org/alfresco/repo/webdav/PropPatchMethod.java @@ -419,8 +419,8 @@ public class PropPatchMethod extends PropFindMethod /** * Constructor * - * @param action - * @param property + * @param action int + * @param property WebDAVProperty */ public PropertyAction(int action, WebDAVProperty property) { diff --git a/source/java/org/alfresco/repo/webdav/WebDAV.java b/source/java/org/alfresco/repo/webdav/WebDAV.java index fd786cd33c..18583a2de1 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAV.java +++ b/source/java/org/alfresco/repo/webdav/WebDAV.java @@ -483,7 +483,7 @@ public class WebDAV /** * Returns string representation of the depth * - * @param depth + * @param depth int * @return String */ public static final String getDepthName(int depth) diff --git a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java b/source/java/org/alfresco/repo/webdav/WebDAVHelper.java index caccda05ea..2a943e979d 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVHelper.java @@ -338,7 +338,7 @@ public class WebDAVHelper /** - * @param poster + * @param poster ActivityPoster */ public void setPoster(ActivityPoster poster) { @@ -780,7 +780,7 @@ public class WebDAVHelper * ALF-5333: Microsoft clients use ISO-8859-1 to decode WebDAV responses * so this method should only be used for Microsoft user agents. * - * @param string + * @param string String * @return The encoded string for Microsoft clients * @throws UnsupportedEncodingException */ @@ -1092,11 +1092,11 @@ public class WebDAVHelper /** * Notifies listeners that a read has taken place - * @param realNodeInfo - * @param mimetype - * @param size - * @param contentEncoding - * @param range + * @param realNodeInfo FileInfo + * @param mimetype String + * @param size Long + * @param contentEncoding String + * @param range String */ protected void publishReadEvent(final FileInfo realNodeInfo, final String mimetype, final Long size, final String contentEncoding, final String range) { diff --git a/source/java/org/alfresco/repo/webdav/WebDAVLockService.java b/source/java/org/alfresco/repo/webdav/WebDAVLockService.java index 98092dd624..c523dd6448 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVLockService.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVLockService.java @@ -78,7 +78,7 @@ public interface WebDAVLockService /** * Caches current session in a thread local variable. * - * @param session + * @param session HttpSession */ void setCurrentSession(HttpSession session); } \ No newline at end of file diff --git a/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java b/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java index 7414b3ba6a..c35a1f08e2 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java @@ -66,7 +66,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Set the LockService * - * @param lockService + * @param lockService LockService */ public void setLockService(LockService lockService) { @@ -76,7 +76,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Set the NodeService * - * @param nodeService + * @param nodeService NodeService */ public void setNodeService(NodeService nodeService) { @@ -86,7 +86,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Set the TransactionService * - * @param transactionService + * @param transactionService TransactionService */ public void setTransactionService(TransactionService transactionService) { @@ -96,7 +96,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Set the CheckOutCheckInService * - * @param checkOutCheckInService + * @param checkOutCheckInService CheckOutCheckInService */ public void setCheckOutCheckInService(CheckOutCheckInService checkOutCheckInService) { @@ -438,7 +438,6 @@ public class WebDAVLockServiceImpl implements WebDAVLockService * @param userName String * @param createExclusive boolean * @param timeoutSecs int - * @exception WebDAVServerException */ private LockInfo createLock(NodeRef nodeRef, String userName, boolean createExclusive, int timeoutSecs) { diff --git a/source/java/org/alfresco/repo/webdav/WebDAVMethod.java b/source/java/org/alfresco/repo/webdav/WebDAVMethod.java index faf0b9e4f2..9caaebe429 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVMethod.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVMethod.java @@ -332,7 +332,7 @@ public abstract class WebDAVMethod /** * Executes the method, wrapping the call to {@link #executeImpl()} in an appropriate transaction * and handling the error conditions. - * @throws IOException + * @throws WebDAVServerException */ public void execute() throws WebDAVServerException { @@ -879,8 +879,8 @@ public abstract class WebDAVMethod * Generates the lock discovery XML response * * @param xml XMLWriter - * @param lockNode NodeRef - * @param lockInfo + * @param lockNodeInfo FileInfo + * @param lockInfo LockInfo */ protected void generateLockDiscoveryXML(XMLWriter xml, FileInfo lockNodeInfo, LockInfo lockInfo) throws Exception { @@ -900,7 +900,7 @@ public abstract class WebDAVMethod * Generates the lock discovery XML response * * @param xml XMLWriter - * @param lockNode NodeRef + * @param lockNodeInfo FileInfo * @param emptyNamespace boolean True if namespace should be empty. Used to avoid bugs in WebDAV clients. * @param scope String lock scope * @param depth String lock depth @@ -1049,8 +1049,8 @@ public abstract class WebDAVMethod /** * Checks if write operation can be performed on node. * - * @param fileInfo - * @return + * @param fileInfo FileInfo + * @return LockInfo * @throws WebDAVServerException if node has shared or exclusive lock * or If header preconditions failed */ @@ -1206,7 +1206,7 @@ public abstract class WebDAVMethod /** * Returns node Lock token in consideration of WebDav lock depth. * - * @param fileInfo node + * @param nodeInfo FileInfo * @return String Lock token */ protected LockInfo getNodeLockInfo(final FileInfo nodeInfo) @@ -1315,7 +1315,7 @@ public abstract class WebDAVMethod * Checks if a node is directly locked. A direct lock is one associated with the node itself * rather than associated with some ancestor. * - * @param nodeInfo + * @param nodeInfo FileInfo * @return The LockInfo if the node is locked, or null otherwise. */ private LockInfo getNodeLockInfoDirect(FileInfo nodeInfo) @@ -1337,7 +1337,7 @@ public abstract class WebDAVMethod /** * Checks whether a parent node has a lock that is valid for all its descendants. * - * @param parent + * @param parent NodeRef * @return The LockInfo if the node is locked, or null otherwise. */ private LockInfo getNodeLockInfoIndirect(NodeRef parent) @@ -1411,7 +1411,7 @@ public abstract class WebDAVMethod /** * Flushes all XML written so far to the response * - * @param xml XMLWriter that should be flushed + * @param writer XMLWriter that should be flushed */ protected final void flushXML(XMLWriter writer) throws IOException { @@ -1606,7 +1606,7 @@ public abstract class WebDAVMethod /** * Get the site ID (short-name) that the current request relates to. The site ID - * will be {@link DEFAULT_SITE_ID} if not specifically set. + * will be {@code DEFAULT_SITE_ID} if not specifically set. * * @return The site ID */ diff --git a/source/java/org/alfresco/repo/webdav/WebDAVProperty.java b/source/java/org/alfresco/repo/webdav/WebDAVProperty.java index c91c824c03..113d48d9d8 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVProperty.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVProperty.java @@ -35,10 +35,10 @@ public class WebDAVProperty /** * Constructs a WebDAVProperty * - * @param strName - * @param strNamespaceUri - * @param strNamespaceName - * @param strValue + * @param strName String + * @param strNamespaceUri String + * @param strNamespaceName String + * @param strValue String */ public WebDAVProperty(String strName, String strNamespaceUri, String strNamespaceName, String strValue) { @@ -49,9 +49,9 @@ public class WebDAVProperty /** * Constructs a WebDAVProperty * - * @param strName - * @param strNamespaceUri - * @param strNamespaceName + * @param strName String + * @param strNamespaceUri String + * @param strNamespaceName String */ public WebDAVProperty(String strName, String strNamespaceUri, String strNamespaceName) { @@ -64,7 +64,7 @@ public class WebDAVProperty /** * Constructs a WebDAVProperty with the default namespace details * - * @param strName + * @param strName String */ public WebDAVProperty(String strName) { diff --git a/source/java/org/alfresco/repo/webdav/WebDAVServlet.java b/source/java/org/alfresco/repo/webdav/WebDAVServlet.java index 64d3da1a3f..655f8eb658 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVServlet.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVServlet.java @@ -313,14 +313,14 @@ public class WebDAVServlet extends HttpServlet /** - * @param storeValue - * @param rootPath - * @param context - * @param nodeService - * @param searchService - * @param namespaceService - * @param tenantService - * @param m_transactionService + * @param storeValue String + * @param rootPath String + * @param context WebApplicationContext + * @param nodeService NodeService + * @param searchService SearchService + * @param namespaceService NamespaceService + * @param tenantService TenantService + * @param m_transactionService TransactionService */ private void initializeRootNode(String storeValue, String rootPath, WebApplicationContext context, NodeService nodeService, SearchService searchService, NamespaceService namespaceService, TenantService tenantService, TransactionService m_transactionService) @@ -470,7 +470,7 @@ public class WebDAVServlet extends HttpServlet /** * See {@link #getUrlPathPrefix()} * - * @param urlPathPrefix + * @param urlPathPrefix String */ public void setUrlPathPrefix(String urlPathPrefix) { diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java index e6b35323c2..78ecf29a27 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java @@ -148,7 +148,7 @@ public abstract class BaseAuthenticationFilter /** * Sets the authentication listener. * - * @param + * @param authenticationListener AuthenticationListener */ public void setAuthenticationListener(AuthenticationListener authenticationListener) { diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java index e0b515d1d5..1d8e99c653 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java @@ -629,12 +629,12 @@ public abstract class BaseKerberosAuthenticationFilter extends BaseSSOAuthentica logonStartAgain(context, req, resp); } - /** * The logon to start again - * + * + * @param context ServletContext + * @param req HttpServletRequest * @param resp HttpServletResponse - * @param httpSess HttpSession * @throws IOException */ public void logonStartAgain(ServletContext context, HttpServletRequest req, HttpServletResponse resp) throws IOException diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java index 93220e8f7b..dbfca35061 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java @@ -671,10 +671,10 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Validate the MD4 hash against local password * - * @param type3Msg - * @param ntlmDetails - * @param authenticated - * @param md4hash + * @param type3Msg Type3NTLMMessage + * @param ntlmDetails NTLMLogonDetails + * @param authenticated boolean + * @param md4hash String * * @return true if password hash is valid, false otherwise */ @@ -978,7 +978,7 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Get the stored MD4 hashed password for the user, or null if the user does not exist * - * @param userName + * @param userName String * * @return MD4 hash or null */ diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java index 56481810ac..51935cc52c 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java @@ -108,7 +108,7 @@ public abstract class BaseSSOAuthenticationFilter extends BaseAuthenticationFilt /** * Activates or deactivates the fallback authentication support for this filter * - * @param delegate + * @param delegate AuthenticationDriver */ public final void setFallback(AuthenticationDriver delegate) { @@ -339,7 +339,7 @@ public abstract class BaseSSOAuthenticationFilter extends BaseAuthenticationFilt * Redirect to the login page * * @param req HttpServletRequest - * @param req HttpServletResponse + * @param res HttpServletResponse * @exception IOException */ protected void redirectToLoginPage(HttpServletRequest req, HttpServletResponse res) @@ -587,7 +587,7 @@ public abstract class BaseSSOAuthenticationFilter extends BaseAuthenticationFilt * @param context ServletContext * @param req HttpServletRequest * @param resp HttpServletResponse - * @return + * @return boolean * @throws IOException * @throws ServletException */ diff --git a/source/java/org/alfresco/rest/api/Favourites.java b/source/java/org/alfresco/rest/api/Favourites.java index 978044ee43..f7c8e17d1c 100644 --- a/source/java/org/alfresco/rest/api/Favourites.java +++ b/source/java/org/alfresco/rest/api/Favourites.java @@ -32,7 +32,7 @@ public interface Favourites * Get a paged list of favourites for user personId * * @param personId the personId for which the favourite is to be removed - * @param parameters + * @param parameters Parameters * @return paged favourites */ CollectionWithPagingInfo getFavourites(String personId, final Parameters parameters); diff --git a/source/java/org/alfresco/rest/api/Nodes.java b/source/java/org/alfresco/rest/api/Nodes.java index 8a96de61c1..e402f53b58 100644 --- a/source/java/org/alfresco/rest/api/Nodes.java +++ b/source/java/org/alfresco/rest/api/Nodes.java @@ -36,22 +36,22 @@ public interface Nodes /** * Get the node representation for the given node. - * @param nodeId - * @return + * @param nodeId String + * @return Node */ Node getNode(String nodeId); /** * Get the document representation for the given node. - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return Document */ Document getDocument(NodeRef nodeRef); /** * Get the folder representation for the given node. - * @param nodeRef - * @return + * @param nodeRef NodeRef + * @return Folder */ Folder getFolder(NodeRef nodeRef); } diff --git a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java b/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java index e229ae771d..fd8e1511ea 100644 --- a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java +++ b/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java @@ -69,7 +69,7 @@ public class PublicApiAuthenticatorFactory extends RemoteUserAuthenticatorFactor /** * Set the headers passed to the gateway for authentication. * - * @param outboundHeaders + * @param outboundHeaders Set */ public void setOutboundHeaders(Set outboundHeaders) { @@ -147,8 +147,8 @@ public class PublicApiAuthenticatorFactory extends RemoteUserAuthenticatorFactor /** * Construct * - * @param req - * @param res + * @param req WebScriptServletRequest + * @param res WebScriptServletResponse * @param proxyListener ProxyListener */ public PublicApiAuthenticator(WebScriptServletRequest req, WebScriptServletResponse res, ProxyListener proxyListener) diff --git a/source/java/org/alfresco/rest/api/PublicApiTenantAuthentication.java b/source/java/org/alfresco/rest/api/PublicApiTenantAuthentication.java index 3ab1fac90a..29b5a4369c 100644 --- a/source/java/org/alfresco/rest/api/PublicApiTenantAuthentication.java +++ b/source/java/org/alfresco/rest/api/PublicApiTenantAuthentication.java @@ -24,7 +24,7 @@ public class PublicApiTenantAuthentication implements TenantAuthentication /** * Determine whether tenant exists and enabled * - * @param tenant + * @param tenant String * @return true => it exists, no it doesn't */ public boolean tenantExists(final String tenant) @@ -46,8 +46,8 @@ public class PublicApiTenantAuthentication implements TenantAuthentication /** * Authenticate user against network/tenant. * - * @param username - * @param networkId + * @param username String + * @param networkId String * @return true => authenticated, false => not authenticated */ public boolean authenticateTenant(String username, String networkId) diff --git a/source/java/org/alfresco/rest/api/SiteMembershipRequests.java b/source/java/org/alfresco/rest/api/SiteMembershipRequests.java index 8778c028a3..65dc4f0fbe 100644 --- a/source/java/org/alfresco/rest/api/SiteMembershipRequests.java +++ b/source/java/org/alfresco/rest/api/SiteMembershipRequests.java @@ -16,7 +16,7 @@ public interface SiteMembershipRequests * Create a site membership request for the user 'inviteeId' * @param inviteeId the site inviteee id * @param siteInvite the site invite - * @return + * @return SiteMembershipRequest */ SiteMembershipRequest createSiteMembershipRequest(String inviteeId, final SiteMembershipRequest siteInvite); diff --git a/source/java/org/alfresco/rest/api/Sites.java b/source/java/org/alfresco/rest/api/Sites.java index 8197909862..783c49ec1f 100644 --- a/source/java/org/alfresco/rest/api/Sites.java +++ b/source/java/org/alfresco/rest/api/Sites.java @@ -40,9 +40,9 @@ public interface Sites /** * people//sites/ * - * @param personId - * @param siteShortName - * @return + * @param personId String + * @param siteShortName String + * @return MemberOfSite */ MemberOfSite getMemberOfSite(String personId, String siteShortName); SiteMember getSiteMember(String personId, String siteShortName); diff --git a/source/java/org/alfresco/rest/api/impl/SitesImpl.java b/source/java/org/alfresco/rest/api/impl/SitesImpl.java index fd680bb6d5..3ae2c3e2a2 100644 --- a/source/java/org/alfresco/rest/api/impl/SitesImpl.java +++ b/source/java/org/alfresco/rest/api/impl/SitesImpl.java @@ -233,9 +233,9 @@ public class SitesImpl implements Sites /** * people//sites/ * - * @param siteId - * @param personId - * @return + * @param siteId String + * @param personId String + * @return MemberOfSite */ public MemberOfSite getMemberOfSite(String personId, String siteId) { diff --git a/source/java/org/alfresco/rest/api/model/Network.java b/source/java/org/alfresco/rest/api/model/Network.java index c486a1e55f..a626058e76 100644 --- a/source/java/org/alfresco/rest/api/model/Network.java +++ b/source/java/org/alfresco/rest/api/model/Network.java @@ -48,7 +48,7 @@ public interface Network /** * Gets the subscription level. - * @return one of the values of {@link AccountType.SubscriptionLevel}. + * @return String */ public String getSubscriptionLevel(); diff --git a/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java b/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java index 9ba8950a03..720742eb5c 100644 --- a/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java +++ b/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java @@ -60,7 +60,7 @@ public class PersonSitesRelation implements RelationshipResourceAction.Read, Enti /** * Returns a paged list of all sites in the current tenant. * - * @see org.alfresco.rest.framework.resource.actions.interfaces.CollectionResourceAction.Get#get() */ @Override @WebApiDescription(title="A paged list of visible sites in the network.", description="A site is visible if it is public or if the person is a member") diff --git a/source/java/org/alfresco/rest/api/sites/SiteMembersRelation.java b/source/java/org/alfresco/rest/api/sites/SiteMembersRelation.java index 53d833fc57..09058c4ad6 100644 --- a/source/java/org/alfresco/rest/api/sites/SiteMembersRelation.java +++ b/source/java/org/alfresco/rest/api/sites/SiteMembersRelation.java @@ -62,7 +62,7 @@ RelationshipResourceAction.Create, RelationshipResourceAction.Update * * Returns a paged list of all the members of the site 'siteId'. * - * @throws If siteId does not exist, NotFoundException (status 404). + * If siteId does not exist, throws NotFoundException (status 404). * * (non-Javadoc) * @see org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Read#readAll(org.alfresco.rest.framework.resource.parameters.Parameters) @@ -80,8 +80,8 @@ RelationshipResourceAction.Create, RelationshipResourceAction.Update * * Adds personId as a member of site siteId. * - * @throws If personId does not exist, NotFoundException (status 404). - * @throws If siteMember. does not exist, NotFoundException (status 404). + * If personId does not exist throws NotFoundException (status 404). + * If siteMember. does not exist throws NotFoundException (status 404). * * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(String, java.util.List, org.alfresco.rest.framework.resource.parameters.Parameters) */ diff --git a/source/java/org/alfresco/rest/framework/Api.java b/source/java/org/alfresco/rest/framework/Api.java index 98410da838..d80890825c 100644 --- a/source/java/org/alfresco/rest/framework/Api.java +++ b/source/java/org/alfresco/rest/framework/Api.java @@ -28,9 +28,9 @@ public class Api implements Comparable /** * Constructor used to create an api - * @param name - * @param scope - * @param version + * @param name String + * @param scope SCOPE + * @param version int */ private Api(String name, SCOPE scope, int version) { diff --git a/source/java/org/alfresco/rest/framework/core/ResourceDictionaryBuilder.java b/source/java/org/alfresco/rest/framework/core/ResourceDictionaryBuilder.java index 49258ae4af..337c569827 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceDictionaryBuilder.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceDictionaryBuilder.java @@ -63,9 +63,9 @@ public class ResourceDictionaryBuilder /** * Finds a resources map, if it doesn't exist then it will create it. - * @param allResources + * @param allResources Map> * @param api Key - * @return Map + * @return Map */ private static Map findResources(Map> allResources, Api api) { @@ -80,8 +80,8 @@ public class ResourceDictionaryBuilder /** * Sort through the resources grouping them by api name/scope, then version. - * @param resources - * @return + * @param resources Collection + * @return Map */ private static Map>> parseResources(Collection resources) { diff --git a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java b/source/java/org/alfresco/rest/framework/core/ResourceInspector.java index c424873326..64c7ce0d41 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceInspector.java @@ -73,8 +73,8 @@ public class ResourceInspector /** * Inspects the entity resource and returns meta data about it * - * @param annot - * @param resource + * @param annot EntityResource + * @param resource Class */ private static List inspectEntity(EntityResource annot, Class resource) { @@ -112,7 +112,10 @@ public class ResourceInspector /** * Inspects the entity resource and returns meta data about any addresssed/binary properties - * @param api + * @param api Api + * @param resource Class + * @param entityPath String + * @param metainfo List */ public static void inspectAddressedProperties(Api api, Class resource, final String entityPath, List metainfo) { @@ -172,8 +175,8 @@ public class ResourceInspector /** * Inspects the relationship resource and returns meta data about it * - * @param annot - * @param resource + * @param annot RelationshipResource + * @param resource Class */ private static List inspectRelationship(RelationshipResource annot, Class resource) { @@ -225,9 +228,9 @@ public class ResourceInspector /** * Inspects the method and returns meta data about its operations - * @param resource - * @param aMethod - * @param httpMethod + * @param resource Class + * @param aMethod Method + * @param httpMethod HttpMethod * @return ResourceOperation */ public static ResourceOperation inspectOperation(Class resource, Method aMethod, HttpMethod httpMethod) @@ -253,7 +256,7 @@ public class ResourceInspector * Inspects the Method to find any @WebApiParameters and @WebApiParam * @param resource the class * @param aMethod the method - * @param httpMethod + * @param httpMethod HttpMethod * @return a List of parameters */ private static List inspectParameters(Class resource, Method aMethod, HttpMethod httpMethod) @@ -354,7 +357,7 @@ public class ResourceInspector /** * Indicates the number of params of the Kind specified - * @param params + * @param params List * @param kind kind of parameter eg. URL_PATH * @return int count */ @@ -371,8 +374,10 @@ public class ResourceInspector /** - * @param paramAnot - * @return + * @param paramAnot Annotation + * @param resource Class + * @param aMethod Method + * @return ResourceParameter */ private static ResourceParameter findResourceParameter(Annotation paramAnot, Class resource, Method aMethod) { @@ -407,8 +412,8 @@ public class ResourceInspector /** * Returns the method for the interface - * @param resourceInterfaceWithOneMethod - * @param resource + * @param resourceInterfaceWithOneMethod Class + * @param resource Class * @return null or a Method */ public static Method findMethod(Class resourceInterfaceWithOneMethod, Class resource) @@ -425,7 +430,7 @@ public class ResourceInspector /** * Finds the name of the entity using its annotation. - * @param annotAttribs + * @param annotAttribs Map * @return the entity name/path */ protected static String findEntityNameByAnnotationAttributes(Map annotAttribs) @@ -437,7 +442,7 @@ public class ResourceInspector /** * Finds the name of the entity using its annotation. - * @param entityAnnot + * @param entityAnnot EntityResource * @return the entity name/path */ protected static String findEntityName(EntityResource entityAnnot) @@ -475,7 +480,7 @@ public class ResourceInspector /** * For a given class, looks for @EmbeddedEntityResource annotations, using the annotation produce * a Map of the property name key and the entity key - * @param anyClass + * @param anyClass Class * @return A map of property key name and a value of the entity path name */ public static Map> findEmbeddedResources(Class anyClass) @@ -504,7 +509,7 @@ public class ResourceInspector * Inspects the resource to determine what api it belongs to. * It does this by looking for the WebApi package annotation. * - * @param resource + * @param resource Class * @return Api */ public static Api inspectApi(Class resource) @@ -526,7 +531,7 @@ public class ResourceInspector /** * Inspects the annotated resource to understand its capabilities * - * @param resource + * @param resource Class */ @SuppressWarnings("rawtypes") public static List inspect(Class resource) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java b/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java index b19caa8360..0db276d327 100755 --- a/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java @@ -74,8 +74,8 @@ public class ResourceInspectorUtil /** * Invokes a method and returns the result - * @param annotatedMethod - * @param obj + * @param annotatedMethod Method + * @param obj Object * @return result of method call */ public static Object invokeMethod(Method annotatedMethod, Object obj) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java b/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java index 22d6a17030..ba8fd8b89d 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java @@ -41,7 +41,7 @@ public class ResourceMetadata /** * Indicates if this resource can support the specified HTTPMethod - * @param supportedMethod + * @param supportedMethod HttpMethod * @return true if can support it */ public boolean supports(HttpMethod supportedMethod) @@ -55,7 +55,7 @@ public class ResourceMetadata /** * Indicates if this resource can support the specified HTTPMethod - * @param supportedMethod + * @param supportedMethod HttpMethod * @return true if can support it */ @SuppressWarnings("rawtypes") @@ -78,7 +78,7 @@ public class ResourceMetadata /** * Indicates if this resource action is no longer supported. - * @param resourceAction + * @param resourceAction Class * @return true if it is no longer supported */ public boolean isDeleted(Class resourceAction) @@ -170,7 +170,7 @@ public class ResourceMetadata /** * Gets the parameters for the specified http method. * Matches the first operation. - * @param httpMethod + * @param httpMethod HttpMethod * @return If not found returns an empty list */ public List getParameters(HttpMethod httpMethod) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceOperation.java b/source/java/org/alfresco/rest/framework/core/ResourceOperation.java index 96ee34ca80..7e606ed87d 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceOperation.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceOperation.java @@ -17,10 +17,10 @@ public class ResourceOperation private final List parameters; /** - * @param httpMethod - * @param title - * @param description - * @param parameters + * @param httpMethod HttpMethod + * @param title String + * @param description String + * @param parameters List */ public ResourceOperation(HttpMethod httpMethod, String title, String description, List parameters) { diff --git a/source/java/org/alfresco/rest/framework/core/ResourceWithMetadata.java b/source/java/org/alfresco/rest/framework/core/ResourceWithMetadata.java index fa2b360236..9041defdfc 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceWithMetadata.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceWithMetadata.java @@ -24,7 +24,7 @@ public class ResourceWithMetadata /** * Returns the REST resource object - * @return + * @return Object */ @JsonIgnore public Object getResource() @@ -34,7 +34,7 @@ public class ResourceWithMetadata /** * Returns the meta data for this resource - * @return + * @return ResourceMetadata */ public ResourceMetadata getMetaData() { diff --git a/source/java/org/alfresco/rest/framework/core/exceptions/DeletedResourceException.java b/source/java/org/alfresco/rest/framework/core/exceptions/DeletedResourceException.java index 7f53b181fb..1d6a1655a8 100644 --- a/source/java/org/alfresco/rest/framework/core/exceptions/DeletedResourceException.java +++ b/source/java/org/alfresco/rest/framework/core/exceptions/DeletedResourceException.java @@ -13,7 +13,7 @@ public class DeletedResourceException extends UnsupportedResourceOperationExcept /** * Creates the exception with the default message and the name of the resource - * @param resourceName + * @param resourceName String */ public DeletedResourceException(String resourceName) { diff --git a/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java b/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java index fbe63f9699..29cd3c5d37 100644 --- a/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java +++ b/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java @@ -12,7 +12,7 @@ public class EntityNotFoundException extends NotFoundException /** * The entity id param will be shown in the default error message. - * @param entityId + * @param entityId String */ public EntityNotFoundException(String entityId) { diff --git a/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java b/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java index 00605b84ff..a98966b18e 100644 --- a/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java +++ b/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java @@ -12,8 +12,8 @@ public class RelationshipResourceNotFoundException extends NotFoundException /** * The entity id param will be shown in the default error message. - * @param entityId - * @param relationshipId + * @param entityId String + * @param relationshipId String */ public RelationshipResourceNotFoundException(String entityId, String relationshipId) { diff --git a/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java b/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java index 5caec70766..d16f7fd352 100644 --- a/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java +++ b/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java @@ -79,7 +79,7 @@ public class ExecutionResult /** * Returns the Map of related objects * - * @return + * @return Map */ public Map getRelated() { @@ -89,7 +89,7 @@ public class ExecutionResult /** * Returns the Map of embedded objects * - * @return + * @return Map */ public Map getEmbedded() { diff --git a/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java b/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java index fede0913e5..c921cc65f9 100644 --- a/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java +++ b/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java @@ -49,7 +49,7 @@ public class JacksonHelper implements InitializingBean /** * Sets the Jackson Module to be used. * - * @param module + * @param module Module */ public void setModule(Module module) { @@ -74,7 +74,7 @@ public class JacksonHelper implements InitializingBean /** * A callback so a JsonGenerator can be used inline but exception are handled here - * @param outStream + * @param outStream OutputStream * @param writer The writer interface * @throws IOException */ @@ -97,9 +97,9 @@ public class JacksonHelper implements InitializingBean /** * Constructs the object based on the content. - * @param content - * @param requiredType - * @return + * @param content Reader + * @param requiredType Class + * @return T * @throws IOException */ public T construct(Reader content, Class requiredType) throws IOException, JsonMappingException, JsonParseException @@ -117,8 +117,8 @@ public class JacksonHelper implements InitializingBean /** * Constructs the object based on the content as a List, the JSON can be an array or just a single value without the [] symbols - * @param content - * @param requiredType + * @param content Reader + * @param requiredType Class * @return A collection of the specified type * @throws IOException */ diff --git a/source/java/org/alfresco/rest/framework/resource/actions/ActionExecutor.java b/source/java/org/alfresco/rest/framework/resource/actions/ActionExecutor.java index 0c0a8ca832..40c610923e 100644 --- a/source/java/org/alfresco/rest/framework/resource/actions/ActionExecutor.java +++ b/source/java/org/alfresco/rest/framework/resource/actions/ActionExecutor.java @@ -15,9 +15,9 @@ public interface ActionExecutor extends HttpMethodSupport /** * Invokes the resource with the Params calling the callback onSuccess - * @param resource - * @param params - * @param executionCallback + * @param resource ResourceWithMetadata + * @param params Params + * @param executionCallback ExecutionCallback */ @SuppressWarnings("rawtypes") public void execute(ResourceWithMetadata resource, Params params, ExecutionCallback executionCallback); diff --git a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java index 2322541337..eabc35fbcc 100644 --- a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java +++ b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java @@ -35,7 +35,7 @@ public interface EntityResourceAction * * Paging information is provided. * @param params - will never be null and will have the PAGING default values - * @return + * @return CollectionWithPagingInfo */ public CollectionWithPagingInfo readAll (Parameters params); } diff --git a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java index 93ac341b9d..61630a73a4 100644 --- a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java +++ b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java @@ -26,7 +26,7 @@ public interface RelationshipResourceAction * Paging information is provided. * @param entityResourceId Entity resource context for this relationship * @param params - will never be null and will have the PAGING default values - * @return + * @return CollectionWithPagingInfo */ public CollectionWithPagingInfo readAll (String entityResourceId, Parameters params); } diff --git a/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java b/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java index 50fd877207..e41e0381f5 100755 --- a/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java +++ b/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java @@ -25,8 +25,8 @@ public class BinaryProperty implements ContentInfo, Serializable /** * Sets the content length to zero, Locale to null, no stream and no caching - * @param mimeType - * @param encoding + * @param mimeType String + * @param encoding String */ public BinaryProperty(String mimeType, String encoding) { @@ -52,10 +52,10 @@ public class BinaryProperty implements ContentInfo, Serializable /** * Sets no stream and no caching - * @param mimeType - * @param encoding - * @param length - * @param locale + * @param mimeType String + * @param encoding String + * @param length long + * @param locale Locale */ public BinaryProperty(String mimeType, String encoding, long length, Locale locale) { diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java b/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java index 1727dfcbe4..059a129aa0 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java +++ b/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java @@ -29,7 +29,6 @@ public class CollectionWithPagingInfo * @param paging - Paging request info * @param hasMoreItems - Are there more items after this Collection? * @param totalItems - The total number of items available. - * @return CollectionWithPagingInfo */ protected CollectionWithPagingInfo(Collection collection, Paging paging, boolean hasMoreItems, Integer totalItems) { diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java b/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java index 2161fe0ac0..f83e547cb0 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java +++ b/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java @@ -19,7 +19,7 @@ public interface Parameters /** * Gets a single request parameter passed in by the user. * Currently doesn't support multiple values. - * @param parameterName + * @param parameterName String * @return String The Parameter value */ public String getParameter(String parameterName); @@ -29,7 +29,7 @@ public interface Parameters * Attempts to convert the parameter to the specified type. * If unable to convert the parameter to the specified type then throws an InvalidArgumentException. * Currently doesn't support multiple values. - * @param parameterName + * @param parameterName String * @param clazz - type to use for conversion. * @return The Parameter value * @throws InvalidArgumentException diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java b/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java index ea25ba1d2f..f5321169c9 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java +++ b/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java @@ -33,8 +33,8 @@ public abstract class QueryHelper /** * Called any time a BETWEEN clause is encountered. * @param propertyName Name of the property - * @param firstValue - * @param secondValue + * @param firstValue String + * @param secondValue String * @param negated returns true if "NOT BETWEEN" was used */ void between(String propertyName, String firstValue, String secondValue, boolean negated); @@ -56,7 +56,7 @@ public abstract class QueryHelper /** * Called any time a MATCHES clause is encountered. * @param property Name of the property - * @param propertyValue + * @param propertyValue String * @param negated returns true if "NOT MATCHES" was used */ void matches(String property, String propertyValue, boolean negated); @@ -115,8 +115,9 @@ public abstract class QueryHelper /** * Processes a tree type and calls the corresponding callback method. - * @param tree - * @param callback + * @param tree Tree + * @param callback WalkerCallback + * @param negated boolean */ protected static void callbackTree(Tree tree, WalkerCallback callback, boolean negated) { @@ -226,7 +227,7 @@ public abstract class QueryHelper /** * Gets the children as a List - * @param tree + * @param tree Tree * @return either emptyList or the children. */ public static List getChildren(Tree tree) @@ -245,12 +246,13 @@ public abstract class QueryHelper return Collections.emptyList(); } - /** - * Strips off any leading or trailing single quotes. - * @param toBeStripped - * @return the String that has been stripped - */ private static final String SINGLE_QUOTE = "'"; + + /** + * Strips off any leading or trailing single quotes. + * @param toBeStripped String + * @return the String that has been stripped + */ public static String stripQuotes(String toBeStripped) { if (StringUtils.isNotEmpty(toBeStripped) && toBeStripped.startsWith(SINGLE_QUOTE) && toBeStripped.endsWith(SINGLE_QUOTE)) diff --git a/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java b/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java index b761591e55..c66d2dc9c7 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java +++ b/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java @@ -152,7 +152,7 @@ public abstract class AbstractResourceWebScript extends ApiWebScript implements /** * The response status must be set before the response is written by Jackson (which will by default close and commit the response). * In a r/w txn, web script buffered responses ensure that it doesn't really matter but for r/o txns this is important. - * @param res + * @param res WebScriptResponse */ protected void setSuccessResponseStatus(final WebScriptResponse res) { @@ -164,7 +164,7 @@ public abstract class AbstractResourceWebScript extends ApiWebScript implements * Finds the action executor to execute actions on. * @param httpMethod - the http method * @param params Params - * @param resource + * @param resource ResourceWithMetadata * @param contentType Request content type * @return ActionExecutor the action executor */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptDelete.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptDelete.java index 1be17c2013..9272f1c5c9 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptDelete.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptDelete.java @@ -73,7 +73,7 @@ public class ResourceWebScriptDelete extends AbstractResourceWebScript implement /** * Executes the action on the resource - * @param resource + * @param resource ResourceWithMetadata * @param params parameters to use * @return anObject the result of the execute */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java index 92c7f1dac8..a97e38039b 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java @@ -79,7 +79,7 @@ public class ResourceWebScriptGet extends AbstractResourceWebScript implements P /** * Executes the action on the resource - * @param resource + * @param resource ResourceWithMetadata * @param params parameters to use * @return anObject the result of the execute */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java index 08e0d22d92..6675a1c2a6 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java @@ -86,7 +86,7 @@ public class ResourceWebScriptHelper * filter param is set then a default BeanFilter is returned that will never * filter properties (ie. Returns all bean properties). * - * @param filterParams + * @param filterParams String * @return BeanPropertyFilter - if no parameter then returns a new * ReturnAllBeanProperties class */ @@ -114,7 +114,7 @@ public class ResourceWebScriptHelper * filter param is set then a default BeanFilter is returned that will never * filter properties (ie. Returns all bean properties). * - * @param filterParams + * @param filterParams String * @return BeanPropertiesFilter - if no parameter then returns a new * ReturnAllBeanProperties class */ @@ -149,7 +149,7 @@ public class ResourceWebScriptHelper /** * Takes the "select" parameter and turns it into a List property names - * @param selectParam + * @param selectParam String * @return List bean property names potentially using JSON Pointer syntax */ @SuppressWarnings("unchecked") @@ -188,7 +188,7 @@ public class ResourceWebScriptHelper /** * Takes the "where" parameter and turns it into a Java Object that can be used for querying - * @param whereParam + * @param whereParam String * @return Query a parsed version of the where clause, represented in Java */ public static Query getWhereClause(String whereParam) throws InvalidQueryException @@ -312,8 +312,8 @@ public class ResourceWebScriptHelper * invoke it. If it fails it just swallows the exceptions and doesn't throw * them further. * - * @param theObj - * @param uniqueId + * @param theObj Object + * @param uniqueId String */ public static void setUniqueId(Object theObj, String uniqueId) { @@ -393,7 +393,7 @@ public class ResourceWebScriptHelper /** * Looks at the object passed in and recursively expands any @EmbeddedEntityResource annotations or related relationship. - * @EmbeddedEntityResource is expanded by calling the ReadById method for this entity. + * {@link org.alfresco.rest.framework.resource.EmbeddedEntityResource EmbeddedEntityResource} is expanded by calling the ReadById method for this entity. * * Either returns a ExecutionResult object or a CollectionWithPagingInfo containing a collection of ExecutionResult objects. * @@ -456,17 +456,19 @@ public class ResourceWebScriptHelper /** * Loops through the embedded Resources and executes them. The results are added to list of embedded results used by * the ExecutionResult object. - * - * @param relatedResources - * @param execRes - * @param uniqueEntityId + * + * @param api Api + * @param params Params + * @param objectToWrap Object + * @param embeddded Map> + * @return Map */ private Map executeEmbeddedResources(Api api, Params params, Object objectToWrap, Map> embeddded) { final Map results = new HashMap(embeddded.size()); for (Entry> embeddedEntry : embeddded.entrySet()) { - ResourceWithMetadata res = locator.locateEntityResource(api,embeddedEntry.getValue().getFirst(), HttpMethod.GET); + ResourceWithMetadata res = locator.locateEntityResource(api, embeddedEntry.getValue().getFirst(), HttpMethod.GET); if (res != null) { Object id = ResourceInspectorUtil.invokeMethod(embeddedEntry.getValue().getSecond(), objectToWrap); @@ -495,10 +497,12 @@ public class ResourceWebScriptHelper /** * Loops through the related Resources and executed them. The results are added to list of embedded results used by * the ExecutionResult object. - * - * @param relatedResources - * @param execRes - * @param uniqueEntityId + * + * @param api Api + * @param filters Map + * @param relatedResources Map + * @param uniqueEntityId String + * @return Map */ private Map executeRelatedResources(final Api api, Map filters, Map relatedResources, @@ -519,9 +523,13 @@ public class ResourceWebScriptHelper /** * Executes a single related Resource. The results are added to list of embedded results used by * the ExecutionResult object. - * - * @param relatedResources - * @param uniqueEntityId + * + * @param api Api + * @param filters Map + * @param uniqueEntityId String + * @param resourceKey String + * @param resource ResourceWithMetadata + * @return Object */ private Object executeRelatedResource(final Api api, final Map filters, final String uniqueEntityId, final String resourceKey, final ResourceWithMetadata resource) @@ -573,7 +581,7 @@ public class ResourceWebScriptHelper * and returns them for use. * * @param req - the WebScriptRequest object - * @return Map the request parameters + * @return the request parameters */ public static Map getRequestParameters(WebScriptRequest req) { diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java index fe77963489..28bfd190b6 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java @@ -78,8 +78,8 @@ public class ResourceWebScriptPost extends AbstractResourceWebScript implements /** * If the @WebApiParam has been used and set allowMultiple to false then this will get a single entry. It * should error if an array is passed in. - * @param resourceMeta - * @param req + * @param resourceMeta ResourceMetadata + * @param req WebScriptRequest * @return Either an object */ private Object extractObjFromJson(ResourceMetadata resourceMeta, WebScriptRequest req) @@ -118,7 +118,7 @@ public class ResourceWebScriptPost extends AbstractResourceWebScript implements /** * Executes the action on the resource - * @param resource + * @param resource ResourceWithMetadata * @param params parameters to use * @return anObject the result of the execute */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPut.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPut.java index b79dfbfce6..e418a4cd1d 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPut.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPut.java @@ -87,9 +87,8 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P /** * Returns the basic content info from the request. - * @param req + * @param req WebScriptRequest * @return BasicContentInfo - * @throws IOException */ private BasicContentInfo getContentInfo(WebScriptRequest req) { @@ -111,9 +110,8 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P /** * Returns the input stream for the request - * @param req - * @return - * @throws IOException + * @param req WebScriptRequest + * @return InputStream */ private InputStream getStream(WebScriptRequest req) { @@ -134,7 +132,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P /** * Executes the action on the resource - * @param resource + * @param resource ResourceWithMetadata * @param params parameters to use * @return anObject the result of the execute */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java b/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java index f7616edf4d..ed3c6b1c85 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java +++ b/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java @@ -96,8 +96,8 @@ public class WebScriptOptionsMetaData extends ApiWebScript implements ResourceMe /** * Processes the resulting resource and returns the data to be displayed - * @param resource - * @param apiResources + * @param resource ResourceWithMetadata + * @param apiResources Map * @return Either a ExecutionResult or a CollectionWithPagingInfo */ public static Object processResult(ResourceWithMetadata resource, Map apiResources) diff --git a/source/java/org/alfresco/rest/workflow/api/impl/WorkflowRestImpl.java b/source/java/org/alfresco/rest/workflow/api/impl/WorkflowRestImpl.java index 6599457398..8697b98d0c 100644 --- a/source/java/org/alfresco/rest/workflow/api/impl/WorkflowRestImpl.java +++ b/source/java/org/alfresco/rest/workflow/api/impl/WorkflowRestImpl.java @@ -364,7 +364,7 @@ public class WorkflowRestImpl /** * @param type the type to get the elements for - * @param paging + * @param paging Paging * @return collection with all valid form-model elements for the given type. */ public CollectionWithPagingInfo getFormModelElements(TypeDefinition type, Paging paging) diff --git a/source/test-java/org/alfresco/RemoteApi02TestSuite.java b/source/test-java/org/alfresco/RemoteApi02TestSuite.java index 02bc374831..3b80b08741 100644 --- a/source/test-java/org/alfresco/RemoteApi02TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi02TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi02TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/RemoteApi03TestSuite.java b/source/test-java/org/alfresco/RemoteApi03TestSuite.java index c44ad50a11..6e575cab50 100644 --- a/source/test-java/org/alfresco/RemoteApi03TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi03TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi03TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/RemoteApi04TestSuite.java b/source/test-java/org/alfresco/RemoteApi04TestSuite.java index fa9eeb98a6..ca6aa4c3d5 100644 --- a/source/test-java/org/alfresco/RemoteApi04TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi04TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi04TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/RemoteApi05TestSuite.java b/source/test-java/org/alfresco/RemoteApi05TestSuite.java index 46ec3ccaed..e6cadd1d27 100644 --- a/source/test-java/org/alfresco/RemoteApi05TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi05TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi05TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/RemoteApi06TestSuite.java b/source/test-java/org/alfresco/RemoteApi06TestSuite.java index 4e0a28947b..89e927ec90 100644 --- a/source/test-java/org/alfresco/RemoteApi06TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi06TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi06TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/RemoteApi07TestSuite.java b/source/test-java/org/alfresco/RemoteApi07TestSuite.java index c2bac26e73..bfe3b19879 100644 --- a/source/test-java/org/alfresco/RemoteApi07TestSuite.java +++ b/source/test-java/org/alfresco/RemoteApi07TestSuite.java @@ -24,7 +24,7 @@ import junit.framework.TestSuite; /** * See {@link RemoteApi01TestSuite} * - * @Author Alan Davis + * @author Alan Davis */ public class RemoteApi07TestSuite extends TestSuite { diff --git a/source/test-java/org/alfresco/repo/web/scripts/invitation/InvitationWebScriptTest.java b/source/test-java/org/alfresco/repo/web/scripts/invitation/InvitationWebScriptTest.java index 91d54ef50d..f2f04a2044 100644 --- a/source/test-java/org/alfresco/repo/web/scripts/invitation/InvitationWebScriptTest.java +++ b/source/test-java/org/alfresco/repo/web/scripts/invitation/InvitationWebScriptTest.java @@ -52,7 +52,7 @@ import org.springframework.extensions.webscripts.TestWebScriptServer.Response; /** * Unit test of Invitation REST API. * - * @See SiteServiceTest.java which tests invitations to Web sites. + * @see org.alfresco.repo.web.scripts.site.SiteServiceTest which tests invitations to Web sites. * * @author Mark Rogers */ diff --git a/source/test-java/org/alfresco/rest/api/tests/TestFavourites.java b/source/test-java/org/alfresco/rest/api/tests/TestFavourites.java index cc02ae5816..21d76657e5 100644 --- a/source/test-java/org/alfresco/rest/api/tests/TestFavourites.java +++ b/source/test-java/org/alfresco/rest/api/tests/TestFavourites.java @@ -178,9 +178,9 @@ public class TestFavourites extends EnterpriseTestApi /** * Returns a new list. * - * @param favourites - * @param types - * @return + * @param favourites List + * @param types Set + * @return ArrayList */ private ArrayList filter(List favourites, final Set types) { diff --git a/source/test-java/org/alfresco/rest/api/tests/TestRemovePermissions.java b/source/test-java/org/alfresco/rest/api/tests/TestRemovePermissions.java index a532c44b7b..f17cf06ef9 100644 --- a/source/test-java/org/alfresco/rest/api/tests/TestRemovePermissions.java +++ b/source/test-java/org/alfresco/rest/api/tests/TestRemovePermissions.java @@ -179,7 +179,6 @@ public class TestRemovePermissions extends EnterpriseTestApi * cmisws?wsdl is not available using jetty in automated test suite should * be runned using an external alfresco server * - * @throws Exception */ // @Test public void testRemoveAllPermissions_WEBSERVICE_10() @@ -357,9 +356,9 @@ public class TestRemovePermissions extends EnterpriseTestApi /** * - * @param session - * @param name - * @return + * @param session Session + * @param name String + * @return Folder */ private Folder createFolder(Session session, String name) { @@ -376,8 +375,8 @@ public class TestRemovePermissions extends EnterpriseTestApi /** * - * @param session - * @return + * @param session Session + * @return List */ private List create2TestACLs(Session session) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java index a42e84a93d..38e1a7753f 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java @@ -272,8 +272,8 @@ public class AuthenticatedHttp extends AbstractHttp /** * Adds the JSON as request-body the the method and sets the correct * content-type. - * @param method - * @param object + * @param method EntityEnclosingMethod + * @param object JSONObject */ private void populateRequestBody(EntityEnclosingMethod method, JSONObject object) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java index 144178fafc..d4df1290dd 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java @@ -27,13 +27,13 @@ public interface AuthenticationDetailsProvider { /** - * @param userName + * @param userName String * @return the password for the given user. Returns null, if user doesn't exist. */ String getPasswordForUser(String userName); /** - * @param userName + * @param userName String * @return the password for the given user. Returns null, if no ticket has been stored for * this user or if the user doesn't exist. */ @@ -41,8 +41,8 @@ public interface AuthenticationDetailsProvider /** * Update the value of the ticket for the given user. - * @param userName - * @param ticket + * @param userName String + * @param ticket String * @throws IllegalArgumentException when the user does not exist. */ void updateTicketForUser(String userName, String ticket) throws IllegalArgumentException; diff --git a/source/test-java/org/alfresco/rest/api/tests/client/PublicApiClient.java b/source/test-java/org/alfresco/rest/api/tests/client/PublicApiClient.java index d4afcae631..3e43a70e83 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/PublicApiClient.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/PublicApiClient.java @@ -240,7 +240,7 @@ public class PublicApiClient /** * Get CMIS repositories (Enterprise AtomPub CMIS binding) * - * @return + * @return List */ public List getCMISRepositories() { @@ -276,10 +276,10 @@ public class PublicApiClient /** * Create a CMIS session using Enterprise AtomPub binding. * - * @param repositoryId - * @param username - * @param password - * @return + * @param repositoryId String + * @param username String + * @param password String + * @return CmisSession */ public CmisSession createCMISSession(String repositoryId, String username, String password) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/data/CMISNode.java b/source/test-java/org/alfresco/rest/api/tests/client/data/CMISNode.java index 9459d1311c..fb0d84c8dd 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/data/CMISNode.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/data/CMISNode.java @@ -27,7 +27,7 @@ public class CMISNode implements Serializable, ExpectedComparison /** * For POSTs - * @param guid + * @param guid String */ public CMISNode(String guid) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/data/Document.java b/source/test-java/org/alfresco/rest/api/tests/client/data/Document.java index 5d92acec44..114d4294ae 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/data/Document.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/data/Document.java @@ -31,7 +31,7 @@ public class Document extends Node implements ExpectedComparison, JSONAble /** * For POSTs - * @param guid + * @param guid String */ public Document(String guid) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/data/Folder.java b/source/test-java/org/alfresco/rest/api/tests/client/data/Folder.java index dea6307eb3..ba73f13875 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/data/Folder.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/data/Folder.java @@ -24,7 +24,7 @@ public class Folder extends Node implements ExpectedComparison, JSONAble /** * For POSTs - * @param guid + * @param guid String */ public Folder(String guid) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/data/Node.java b/source/test-java/org/alfresco/rest/api/tests/client/data/Node.java index 976f9c8394..a7d4f72206 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/data/Node.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/data/Node.java @@ -34,7 +34,7 @@ public class Node implements Serializable, ExpectedComparison /** * For POSTs * - * @param guid + * @param guid String */ public Node(String guid) { diff --git a/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java b/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java index 607fd84d9a..1cc2db5363 100644 --- a/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java +++ b/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java @@ -470,10 +470,10 @@ public class WhereTests { /** * Used by BetweenClauseTest, validates the clause - * @param theQuery - * @param propName - * @param firstValue - * @param secondValue + * @param theQuery Query + * @param propName String + * @param firstValue String + * @param secondValue String */ private void betweenChecks(Query theQuery, final String propName, final String firstValue, final String secondValue) { assertNotNull(theQuery); @@ -497,9 +497,9 @@ public class WhereTests { /** * Used by the matchesClauseTest - * @param theQuery - * @param propName - * @param propVal + * @param theQuery Query + * @param propName String + * @param propVal String */ private void matchesChecks(Query theQuery, final String propName, final String propVal) { assertNotNull(theQuery); @@ -520,9 +520,9 @@ public class WhereTests { /** * Use by the inClauseTest - * @param theQuery - * @param propName - * @param values + * @param theQuery Query + * @param propName String + * @param values String... */ private void inChecks(Query theQuery, final String propName, final String... values) { assertNotNull(theQuery);