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
This commit is contained in:
Francesco Mangiacrapa 2017-07-03 15:25:05 +00:00
parent da90e66998
commit 0466a41745
6 changed files with 63 additions and 47 deletions

View File

@ -27,10 +27,11 @@
<distroDirectory>distro</distroDirectory>
<!-- GWT needs at least java 1.6 -->
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
<maven.compiler.target>1.8</maven.compiler.target>
<webappDirectory>${project.build.directory}/${project.build.finalName}</webappDirectory>
<gwt-material.version>1.4.1</gwt-material.version>
<maven-war-plugin.version>2.1.1</maven-war-plugin.version>
<additionalparam>-Xdoclint:none</additionalparam>
<!-- <gwtp.version>1.4.1</gwtp.version> -->
<!-- <gin.version>2.1.2</gin.version> -->

View File

@ -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 {

View File

@ -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<Widget, WorkspaceExplorerAppMainPanel> {
@ -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:
* <ui:UiBinder xmlns:ui="urn:ui:com.google.gwt.uibinder"
* xmlns:g="urn:import:**user's package**">
* <g:**UserClassName**>Hello!</g:**UserClassName>
* </ui:UiBinder>
* 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

View File

@ -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<ItemType> 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<Item> 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;

View File

@ -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<ItemType> showableTypes, boolean purgeEmpyFolders,
FilterCriteria filterCriteria, AsyncCallback<Item> 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<Boolean> callback);
/**
* Gets the folder.
*
@ -63,6 +61,7 @@ public interface WorkspaceExplorerAppServiceAsync {
AsyncCallback<Item> callback);
/**
* Gets the breadcrumbs by item identifier.
*
@ -74,6 +73,7 @@ public interface WorkspaceExplorerAppServiceAsync {
public void getBreadcrumbsByItemIdentifier(String itemIdentifier,
boolean includeItemAsParent, AsyncCallback<List<Item>> asyncCallback);
/**
* Gets the my special folder.
*
@ -85,6 +85,7 @@ public interface WorkspaceExplorerAppServiceAsync {
*/
public void getMySpecialFolder(List<ItemType> showableTypes, boolean purgeEmpyFolders, FilterCriteria filterCriteria, AsyncCallback<Item> asyncCallback);
/**
* Gets the item by category.
*
@ -94,6 +95,7 @@ public interface WorkspaceExplorerAppServiceAsync {
*/
public void getItemByCategory(ItemCategory category, AsyncCallback<Item> asyncCallback);
/**
* Gets the size by item id.
*

View File

@ -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{