Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tatyana Valkevych
2015-07-02 16:13:03 +00:00
parent a2349e101f
commit b15a2e772b
28 changed files with 108 additions and 104 deletions

View File

@@ -64,7 +64,7 @@ public class ConfigAdminConsoleBean
/**
* Sets the command result
*
* @param result
* @param result String
*/
public void setResult(String result)
{

View File

@@ -69,8 +69,6 @@ public class PresenceProxyBean implements Serializable
/**
* Perform request
*
* @throws IOException
*/
public String getUrlResponse(String requestUrl)
{

View File

@@ -148,7 +148,7 @@ public class EditNodeCategoriesDialog extends BaseDialogBean
/**
* Sets the categories Map
*
* @param categories
* @param categories List
*/
public void setCategories(List categories)
{

View File

@@ -211,7 +211,7 @@ public class EditOfflineDialog extends CheckinCheckoutDialog
}
/**
* @param continueCountdown
* @param continueCountdown boolean
*/
public void setContinueCountdown(boolean continueCountdown)
{

View File

@@ -592,7 +592,7 @@ public class GroupsDialog extends BaseDialogBean
/**
* Simple setter
*
* @param groupsSearchCriteria
* @param groupsSearchCriteria String
*/
public void setGroupsSearchCriteria(String groupsSearchCriteria)
{

View File

@@ -46,9 +46,9 @@ public class MultilingualUtils implements Serializable
* Returns true if the current user has enough right to add a content to the space
* where the pivot translation is located in.
*
* @param multlingualDocument
* @param fc
* @return
* @param multlingualDocument Node
* @param fc FacesContext
* @return boolean
*/
public static boolean canAddChildrenToPivotSpace(Node multlingualDocument, FacesContext fc)
{
@@ -66,9 +66,9 @@ public class MultilingualUtils implements Serializable
/**
* Returns true if the current user can delete each translation of the mlContainer of the given node
*
* @param multlingualDocument
* @param fc
* @return
* @param multlingualDocument Node
* @param fc FacesContext
* @return boolean
*/
public static boolean canDeleteEachTranslation(Node multlingualDocument, FacesContext fc)
{
@@ -97,9 +97,9 @@ public class MultilingualUtils implements Serializable
/**
* Returns true if the current user can move each translation of the mlContainer of the given node
*
* @param multlingualDocument
* @param fc
* @return
* @param multlingualDocument Node
* @param fc FacesContext
* @return boolean
*/
public static boolean canMoveEachTranslation(Node multlingualDocument, FacesContext fc)
{
@@ -126,9 +126,9 @@ public class MultilingualUtils implements Serializable
* Returns true if the current user can delete each translation and create
* * a new content in the space
*
* @param multlingualDocument
* @param fc
* @return
* @param multlingualDocument Node
* @param fc FacesContext
* @return boolean
*/
public static boolean canStartNewEditon(Node multlingualDocument, FacesContext fc)
{

View File

@@ -40,7 +40,7 @@ public class SingleEditionBean implements Serializable
private List<MapNode> translations = null;
/**
* @return
* @return String
*/
public String getEditionLabel()
{

View File

@@ -234,7 +234,7 @@ public final class Repository
/**
* Helper to get the display name path for a category node.
*
* @param nodeService
* @param nodeService NodeService
* @param ref the category node ref
* @return display name string for the specified category node.
*/

View File

@@ -83,7 +83,7 @@ public class RepoAdminConsoleBean implements Serializable
/**
* Sets the command result
*
* @param result
* @param result String
*/
public void setResult(String result)
{

View File

@@ -83,7 +83,7 @@ public class TenantAdminConsoleBean implements Serializable
/**
* Sets the command result
*
* @param result
* @param result String
*/
public void setResult(String result)
{

View File

@@ -168,7 +168,7 @@ public class RulesDialog extends BaseDialogBean implements IContextListener, Fil
/**
* Reapply the currently defines rules to the
* @param event
* @param event ActionEvent
*/
public void reapplyRules(ActionEvent event)
{

View File

@@ -626,9 +626,9 @@ public class CreateUserWizard extends BaseWizardBean
/**
* Validate Email field data is acceptable
*
* @param context
* @param component
* @param value
* @param context FacesContext
* @param component UIComponent
* @param value Object
* @throws ValidatorException
*/
public void validateEmail(FacesContext context, UIComponent component, Object value) throws ValidatorException

View File

@@ -210,7 +210,7 @@ public class UsersBeanProperties implements Serializable
}
/**
* @param userRegistrySynchronizer
* @param userRegistrySynchronizer UserRegistrySynchronizer
*/
public void setUserRegistrySynchronizer(UserRegistrySynchronizer userRegistrySynchronizer)
{

View File

@@ -169,7 +169,7 @@ public class UsersDialog extends BaseDialogBean implements IContextListener, Cha
* Called in preparation for actions that need to setup a Person context on
* the Users bean before an action page is called.
*
* @param personId
* @param personId String
*/
public void setupUserAction(String personId)
{

View File

@@ -1,19 +1,19 @@
/*
* Copyright (C) 2005-2011 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* Copyright (C) 2005-2011 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.web.bean.wizard;
@@ -78,8 +78,8 @@ public class NewUserWizard extends AbstractWizardBean
private static final String STEP2_TITLE_ID = "new_user_step2_title";
private static final String STEP2_DESCRIPTION_ID = "new_user_step2_desc";
private static final String FINISH_INSTRUCTION_ID = "new_user_finish_instruction";
private static final String ERROR = "error_person";
private static final String MSG_ERROR_MAIL_NOT_VALID = "email_format_is_not_valid";
private static final String ERROR = "error_person";
private static final String MSG_ERROR_MAIL_NOT_VALID = "email_format_is_not_valid";
/** form variables */
private String firstName = null;
@@ -252,7 +252,7 @@ public class NewUserWizard extends AbstractWizardBean
this.homeSpaceLocation = null; // default to Company root space
this.homeSpaceName = ""; // default to none set below root
NodeRef homeFolderRef = (NodeRef) props.get("homeFolder");
if (homeFolderRef != null && this.getNodeService().exists(homeFolderRef) == true)
if (homeFolderRef != null && this.getNodeService().exists(homeFolderRef) == true)
{
ChildAssociationRef childAssocRef = this.getNodeService().getPrimaryParent(homeFolderRef);
NodeRef parentRef = childAssocRef.getParentRef();
@@ -807,11 +807,11 @@ public class NewUserWizard extends AbstractWizardBean
*/
public void setUserName(String userName)
{
if (userName != null)
{
userName = userName.trim();
}
if (userName != null)
{
userName = userName.trim();
}
this.userName = userName;
}
@@ -916,23 +916,23 @@ public class NewUserWizard extends AbstractWizardBean
}
}
/**
* Validate Email field data is acceptable
*
* @param context
* @param component
* @param value
* @throws ValidatorException
*/
public void validateEmail(FacesContext context, UIComponent component, Object value) throws ValidatorException
{
EmailValidator emailValidator = EmailValidator.getInstance();
if (!emailValidator.isValid((String) value))
{
String err =Application.getMessage(context, MSG_ERROR_MAIL_NOT_VALID);
throw new ValidatorException(new FacesMessage(err));
}
}
/**
* Validate Email field data is acceptable
*
* @param context FacesContext
* @param component UIComponent
* @param value Object
* @throws ValidatorException
*/
public void validateEmail(FacesContext context, UIComponent component, Object value) throws ValidatorException
{
EmailValidator emailValidator = EmailValidator.getInstance();
if (!emailValidator.isValid((String) value))
{
String err =Application.getMessage(context, MSG_ERROR_MAIL_NOT_VALID);
throw new ValidatorException(new FacesMessage(err));
}
}
// ------------------------------------------------------------------------------
// Helper methods

View File

@@ -55,7 +55,7 @@ public class ActionsConfigElement extends ConfigElementAdapter
}
/**
* @param name
* @param name String
*/
public ActionsConfigElement(String name)
{

View File

@@ -520,7 +520,7 @@ public class ClientConfigElement extends ConfigElementAdapter
* Set if the the result set from a search will be of limited size.
* If negative it is unlimited, by convention, this is set to -1.
*
* @param searchMaxResults
* @param searchMaxResults int
*/
/*package*/ void setSearchMaxResults(int searchMaxResults)
{
@@ -543,7 +543,7 @@ public class ClientConfigElement extends ConfigElementAdapter
* will be of limited size. If negative it is unlimited, by default,
* this is set to 500.
*
* @param selectorsSearchMaxResults
* @param selectorsSearchMaxResults int
*/
/*package*/ void setSelectorsSearchMaxResults(int selectorsSearchMaxResults)
{
@@ -566,7 +566,7 @@ public class ClientConfigElement extends ConfigElementAdapter
* will be of limited size. If negative it is unlimited, by default,
* this is set to 500.
*
* @param inviteUsersMaxResults
* @param inviteUsersMaxResults int
*/
/*package*/ void setInviteUsersMaxResults(int inviteUsersMaxResults)
{
@@ -588,7 +588,7 @@ public class ClientConfigElement extends ConfigElementAdapter
* Set if the the number of completed tasks displayed shall be limited.
* If negative it is unlimited, by default, this is set to 100.
*
* @param tasksCompletedMaxResults
* @param tasksCompletedMaxResults int
*/
/*package*/ void setTasksCompletedMaxResults(int tasksCompletedMaxResults)
{
@@ -638,7 +638,7 @@ public class ClientConfigElement extends ConfigElementAdapter
/**
* Sets whether AJAX support is enabled in the client
*
* @param ajaxEnabled
* @param ajaxEnabled boolean
*/
/*package*/ void setNodeSummaryEnabled(boolean ajaxEnabled)
{
@@ -917,7 +917,7 @@ public class ClientConfigElement extends ConfigElementAdapter
}
/**
* @param isBulkFetchEnabled
* @param isBulkFetchEnabled boolean
*/
/*package*/ void setBulkFetchEnabled(boolean isBulkFetchEnabled)
{

View File

@@ -53,7 +53,7 @@ public class DashboardsConfigElement extends ConfigElementAdapter
}
/**
* @param name
* @param name String
*/
public DashboardsConfigElement(String name)
{

View File

@@ -115,7 +115,7 @@ public class DashboardsElementReader implements ConfigElementReader
/**
* Parse a single Layout definition from config.
*
* @param config
* @param config Element
*
* @return LayoutDefinition for the specified config element.
*/
@@ -154,8 +154,8 @@ public class DashboardsElementReader implements ConfigElementReader
/**
* Return a mandatory layout attribute layout. Throw an exception if the value is not found.
*
* @param config
* @param attr
* @param config Element
* @param attr String
*
* @return String value
*/
@@ -172,7 +172,7 @@ public class DashboardsElementReader implements ConfigElementReader
/**
* Parse a single Dashlet definition from config.
*
* @param config
* @param config Element
*
* @return DashletDefinition for the specified config element.
*/
@@ -212,8 +212,8 @@ public class DashboardsElementReader implements ConfigElementReader
/**
* Return a mandatory dashlet attribute layout. Throw an exception if the value is not found.
*
* @param config
* @param attr
* @param config Element
* @param attr String
*
* @return String value
*/

View File

@@ -44,7 +44,6 @@ public class ReportedException extends RuntimeException
* the transaction to rollback.
*
* @param error The error to be thrown
* @throws Throwable
*/
public static void throwIfNecessary(Throwable error)
{

View File

@@ -981,7 +981,7 @@ public final class Utils extends StringUtils
/**
* Parse XML format date YYYY-MM-DDTHH:MM:SS
* @param isoDate
* @param isoDate String
* @return Date or null if failed to parse
*/
public static Date parseXMLDateFormat(String isoDate)
@@ -1184,7 +1184,7 @@ public final class Utils extends StringUtils
* <p/>
* "C-3PO" becomes null.
*
* @param nameFilter
* @param nameFilter String
* @return A Pair<firstName, lastName> if the String is valid, else <tt>null</tt>.
*/
private static Pair<String, String> tokeniseName(String nameFilter)

View File

@@ -464,7 +464,7 @@ public class UISelectList extends UIInput implements NamingContainer
* Set the transient current row index. Setting this value causes all child components to
* have their ID values reset - so that cached clientID values are regenerated when next requested.
*
* @param rowIndex
* @param rowIndex int
*/
public void setRowIndex(int rowIndex)
{

View File

@@ -313,7 +313,7 @@ public class UIRichList extends UIComponentBase implements IDataContainer,Serial
/**
* Sets the current page size used for the list.
*
* @param val
* @param val int
*/
public void setPageSize(int val)
{

View File

@@ -113,8 +113,9 @@ public class ActionLinkRenderer extends BaseRenderer
/**
* Render ActionLink as plain link and image
*
* @param context
* @param link
* @param context FacesContext
* @param out Writer
* @param link UIActionLink
*/
private void renderActionLink(FacesContext context, Writer out, UIActionLink link)
throws IOException
@@ -176,8 +177,9 @@ public class ActionLinkRenderer extends BaseRenderer
/**
* Render ActionLink as plain link and image
*
* @param context
* @param link
* @param context FacesContext
* @param out Writer
* @param link UIActionLink
*/
private void renderActionLinkAnchor(final FacesContext context,
final Writer out,
@@ -272,9 +274,9 @@ public class ActionLinkRenderer extends BaseRenderer
}
/**
* @param link
* @param out
* @param href
* @param link UIActionLink
* @param out Writer
* @param href String
*/
private void renderHrefParams(UIActionLink link, Writer out, String href)
throws IOException
@@ -312,9 +314,11 @@ public class ActionLinkRenderer extends BaseRenderer
/**
* Render ActionLink as menu image and item link
*
* @param context
* @param link
*
* @param context FacesContext
* @param out Writer
* @param link UIActionLink
* @param padding int
*/
private void renderMenuAction(FacesContext context, Writer out, UIActionLink link, int padding)
throws IOException

View File

@@ -281,8 +281,11 @@ public class UIActions extends SelfRenderingComponent
/**
* Build an action group as reusable UIActionLink components.
*
* @param context
* @param actionGroup
* @param context FacesContext
* @param config ActionsConfigElement
* @param actionGroup ActionGroup
* @param contextId String
* @throws IOException
*/
@SuppressWarnings("unchecked")
private void buildActionGroup(

View File

@@ -405,7 +405,7 @@ public class UINavigator extends SelfRenderingComponent
/**
* Sets the active area for the navigator panel
*
* @param activeArea
* @param activeArea String
*/
public void setActiveArea(String activeArea)
{