From 0466a417450ebea8310a56741cdc57e4ae724002 Mon Sep 17 00:00:00 2001 From: Francesco Mangiacrapa Date: Mon, 3 Jul 2017 15:25:05 +0000 Subject: [PATCH] java doc has been partially updated to Java 8 git-svn-id: http://svn.research-infrastructures.eu/public/d4science/gcube/trunk/portlets/user/workspace-explorer-app@150704 82a268e6-3cf1-43bd-a215-b396298e98cf --- pom.xml | 3 +- .../WorkspaceExplorerAppController.java | 3 +- .../client/WorkspaceExplorerAppMainPanel.java | 17 +++---- .../rpc/WorkspaceExplorerAppService.java | 50 ++++++++++++------- .../rpc/WorkspaceExplorerAppServiceAsync.java | 30 +++++------ .../WorkspaceExplorerAppServiceImpl.java | 7 +-- 6 files changed, 63 insertions(+), 47 deletions(-) diff --git a/pom.xml b/pom.xml index cbf61f2..c50acfc 100644 --- a/pom.xml +++ b/pom.xml @@ -27,10 +27,11 @@ distro 1.7 - 1.7 + 1.8 ${project.build.directory}/${project.build.finalName} 1.4.1 2.1.1 + -Xdoclint:none diff --git a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppController.java b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppController.java index fe1f00a..c0340e0 100644 --- a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppController.java +++ b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppController.java @@ -21,11 +21,12 @@ import com.google.gwt.user.client.rpc.AsyncCallback; import com.google.gwt.user.client.ui.Image; import com.google.gwt.user.client.ui.RootPanel; + /** * The Class WorkspaceExplorerAppController. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * @Oct 8, 2014 + * Jul 3, 2017 */ public class WorkspaceExplorerAppController { diff --git a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppMainPanel.java b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppMainPanel.java index e459341..656184b 100644 --- a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppMainPanel.java +++ b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/WorkspaceExplorerAppMainPanel.java @@ -29,22 +29,24 @@ import com.google.gwt.user.client.ui.Image; import com.google.gwt.user.client.ui.Widget; + /** * The Class WorkspaceExplorerAppMainPanel. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * Mar 2, 2016 + * Jul 3, 2017 */ public class WorkspaceExplorerAppMainPanel extends Composite { private static WorkspaceExplorerAppMainPanelUiBinder uiBinder = GWT.create(WorkspaceExplorerAppMainPanelUiBinder.class); + /** * The Interface WorkspaceExplorerAppMainPanelUiBinder. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * Mar 8, 2016 + * Jul 3, 2017 */ interface WorkspaceExplorerAppMainPanelUiBinder extends UiBinder { @@ -73,16 +75,9 @@ public class WorkspaceExplorerAppMainPanel extends Composite { private HandlerManager handlerManager; + /** - * Because this class has a default constructor, it can - * be used as a binder template. In other words, it can be used in other - * *.ui.xml files as follows: - * - * Hello! - * - * Note that depending on the widget that is used, it may be necessary to - * implement HasHTML instead of HasText. + * Instantiates a new workspace explorer app main panel. * * @param handlerManager the handler manager * @param displayFields the display fields diff --git a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppService.java b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppService.java index d57e6ed..01f77fc 100644 --- a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppService.java +++ b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppService.java @@ -11,15 +11,17 @@ import org.gcube.portlets.user.workspaceexplorerapp.shared.WorkspaceNavigatorSer import com.google.gwt.user.client.rpc.RemoteService; import com.google.gwt.user.client.rpc.RemoteServiceRelativePath; + /** - * The client side stub for the RPC service. + * The Interface WorkspaceExplorerAppService. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * Jul 10, 2015 + * Jul 3, 2017 */ @RemoteServiceRelativePath("WorkspaceExplorerAppService") public interface WorkspaceExplorerAppService extends RemoteService { + /** * Gets the breadcrumbs by item identifier. * @@ -40,6 +42,16 @@ public interface WorkspaceExplorerAppService extends RemoteService { */ boolean checkName(String name) throws WorkspaceNavigatorServiceException; + /** + * Gets the folder. + * + * @param folder the folder + * @param showableTypes the showable types + * @param purgeEmpyFolders the purge empy folders + * @param filterCriteria the filter criteria + * @return the folder + * @throws WorkspaceNavigatorServiceException the workspace navigator service exception + */ Item getFolder( Item folder, List showableTypes, boolean purgeEmpyFolders, FilterCriteria filterCriteria) throws WorkspaceNavigatorServiceException; @@ -117,33 +129,37 @@ public interface WorkspaceExplorerAppService extends RemoteService { String getReadableSizeByItemId(String id) throws Exception; /** - * @param itemIdentifier - * @param parentLimit - * @param includeItemAsParent - * @return - * @throws Exception + * Gets the breadcrumbs by item identifier to parent limit. + * + * @param itemIdentifier the item identifier + * @param parentLimit the parent limit + * @param includeItemAsParent the include item as parent + * @return the breadcrumbs by item identifier to parent limit + * @throws Exception the exception */ List getBreadcrumbsByItemIdentifierToParentLimit( String itemIdentifier, String parentLimit, boolean includeItemAsParent) throws Exception; /** - * @param nameFolder - * @param description - * @param parentId - * @param showableTypes - * @param filterCriteria - * @return - * @throws Exception + * Creates the folder. + * + * @param nameFolder the name folder + * @param description the description + * @param parentId the parent id + * @return the item + * @throws Exception the exception */ Item createFolder( String nameFolder, String description, String parentId) throws Exception; /** - * @param itemId - * @return - * @throws Exception + * Gets the public link for item id. + * + * @param itemId the item id + * @return the public link for item id + * @throws Exception the exception */ String getPublicLinkForItemId(String itemId) throws Exception; diff --git a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppServiceAsync.java b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppServiceAsync.java index bd3008f..04c7681 100644 --- a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppServiceAsync.java +++ b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/client/rpc/WorkspaceExplorerAppServiceAsync.java @@ -13,41 +13,39 @@ import org.gcube.portlets.user.workspaceexplorerapp.shared.ItemType; import com.google.gwt.user.client.rpc.AsyncCallback; + /** - * The Interface WorkspaceExplorerServiceAsync. + * The Interface WorkspaceExplorerAppServiceAsync. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * Jun 24, 2015 + * Jul 3, 2017 */ public interface WorkspaceExplorerAppServiceAsync { + /** * Gets the root. * - * @param showableTypes - * the showable types - * @param purgeEmpyFolders - * the purge empy folders - * @param filterCriteria - * the filter criteria - * @param callback - * the callback + * @param showableTypes the showable types + * @param purgeEmpyFolders the purge empy folders + * @param filterCriteria the filter criteria + * @param callback the callback * @return the root */ public void getRoot(List showableTypes, boolean purgeEmpyFolders, FilterCriteria filterCriteria, AsyncCallback callback); + /** * Check name. * - * @param name - * the name - * @param callback - * the callback + * @param name the name + * @param callback the callback */ public void checkName(String name, AsyncCallback callback); + /** * Gets the folder. * @@ -63,6 +61,7 @@ public interface WorkspaceExplorerAppServiceAsync { AsyncCallback callback); + /** * Gets the breadcrumbs by item identifier. * @@ -74,6 +73,7 @@ public interface WorkspaceExplorerAppServiceAsync { public void getBreadcrumbsByItemIdentifier(String itemIdentifier, boolean includeItemAsParent, AsyncCallback> asyncCallback); + /** * Gets the my special folder. * @@ -85,6 +85,7 @@ public interface WorkspaceExplorerAppServiceAsync { */ public void getMySpecialFolder(List showableTypes, boolean purgeEmpyFolders, FilterCriteria filterCriteria, AsyncCallback asyncCallback); + /** * Gets the item by category. * @@ -94,6 +95,7 @@ public interface WorkspaceExplorerAppServiceAsync { */ public void getItemByCategory(ItemCategory category, AsyncCallback asyncCallback); + /** * Gets the size by item id. * diff --git a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/server/WorkspaceExplorerAppServiceImpl.java b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/server/WorkspaceExplorerAppServiceImpl.java index 24ad893..610dfa3 100644 --- a/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/server/WorkspaceExplorerAppServiceImpl.java +++ b/src/main/java/org/gcube/portlets/user/workspaceexplorerapp/server/WorkspaceExplorerAppServiceImpl.java @@ -28,11 +28,12 @@ import org.slf4j.LoggerFactory; import com.google.gwt.user.server.rpc.RemoteServiceServlet; + /** - * The server side implementation of the RPC service. + * The Class WorkspaceExplorerAppServiceImpl. * * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it - * Jun 25, 2015 + * Jul 3, 2017 */ @SuppressWarnings("serial") public class WorkspaceExplorerAppServiceImpl extends RemoteServiceServlet implements WorkspaceExplorerAppService { @@ -715,7 +716,7 @@ public class WorkspaceExplorerAppServiceImpl extends RemoteServiceServlet implem * * @param encodedFolderId the encrypted folder id * @return the valid id from encrypted - * @throws Exception + * @throws Exception the exception */ @Override public String getFolderIdFromEncrypted(String encodedFolderId) throws Exception{