updated javadoc

git-svn-id: http://svn.d4science-ii.research-infrastructures.eu/gcube/trunk/portlets/user/workspace-tree-widget@148851 82a268e6-3cf1-43bd-a215-b396298e98cf

distro/changelog.xml

@@ -1,8 +1,4 @@
 <ReleaseNotes>
-	<Changeset component="org.gcube.portlets-user.workspace-portlet-tree.6-16-2"
-		date="2017-04-12">
-		<Change>Task #8070: file versiong shown in workspace grid column </Change>
-	</Changeset>
 	<Changeset component="org.gcube.portlets-user.workspace-portlet-tree.6-16-1"
 		date="2017-04-11">
 		<Change>Quick fix to set folder as public</Change>

pom.xml

@@ -10,7 +10,7 @@
 
 	<groupId>org.gcube.portlets.user</groupId>
 	<artifactId>workspace-tree-widget</artifactId>
-	<version>6.16.2-SNAPSHOT</version>
+	<version>6.16.1-SNAPSHOT</version>
 	<name>gCube Workspace Tree Widget</name>
 	<description>
 		gCube Workspace Tree Widget is a widget to navigate and interact with gCube Workspace 
@@ -27,6 +27,7 @@
 		<!-- GWT needs at least java 1.6 -->
 		<maven.compiler.source>1.7</maven.compiler.source>
 		<maven.compiler.target>1.8</maven.compiler.target>
+		<!--<additionalparam>-Xdoclint:none</additionalparam>-->
 
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

src/main/java/org/gcube/portlets/user/workspace/client/AppControllerExplorer.java

@@ -171,10 +171,12 @@ import com.google.gwt.user.client.Window;
 import com.google.gwt.user.client.rpc.AsyncCallback;
 import com.google.gwt.user.client.ui.HasWidgets;
 
+
 /**
  * The Class AppControllerExplorer.
  *
  * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
+ * May 15, 2017
  */
 public class AppControllerExplorer implements EventHandler, TreeAppControllerInterface{
 
@@ -228,6 +230,7 @@ public class AppControllerExplorer implements EventHandler, TreeAppControllerInt
 		return rpcWorkspaceService;
 	}
 
+
 	/**
 	 * Bind.
 	 */
@@ -2638,6 +2641,7 @@ public class AppControllerExplorer implements EventHandler, TreeAppControllerInt
 		explorerPanel.getAsycTreePanel().setSearch(isSearch);
 	}
 
+
 	/**
 	 * Do click url.
 	 *

src/main/java/org/gcube/portlets/user/workspace/server/DownloadFolderServlet.java

@@ -21,6 +21,8 @@ import org.gcube.portlets.user.workspace.server.property.PortalUrlGroupGatewayPr
 import org.gcube.portlets.user.workspace.shared.HandlerResultMessage;
 
 /**
+ * The Class DownloadFolderServlet.
+ *
  * @author M. Assante, CNR-ISTI
  */
 @SuppressWarnings("serial")
@@ -38,6 +40,9 @@ public class DownloadFolderServlet extends HttpServlet{
 		logger.trace("Workspace DownloadFolderServlet ready.");
 	}
 
+	/* (non-Javadoc)
+	 * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
+	 */
 	public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
 		boolean urlRedirectOnError = req.getParameter(ConstantsExplorer.REDIRECTONERROR)==null?false:req.getParameter(ConstantsExplorer.REDIRECTONERROR).equals("true");
 
@@ -84,10 +89,11 @@ public class DownloadFolderServlet extends HttpServlet{
 	}
 
 	/**
-	 * Method to manage HttpServletResponse content length also to big data
+	 * Method to manage HttpServletResponse content length also to big data.
-	 * @param resp
+	 *
-	 * @param length
+	 * @param resp the resp
-	 * @return
+	 * @param length the length
+	 * @return the http servlet response
 	 */
 	protected HttpServletResponse setContentLength(HttpServletResponse resp, long length){
 		try{
@@ -101,6 +107,16 @@ public class DownloadFolderServlet extends HttpServlet{
 		return resp;
 	}
 
+	/**
+	 * Handle error.
+	 *
+	 * @param urlRedirectOnError the url redirect on error
+	 * @param req the req
+	 * @param resp the resp
+	 * @param itemId the item id
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void handleError(boolean urlRedirectOnError, HttpServletRequest req, HttpServletResponse resp, String itemId, String message) throws IOException{
 
 		logger.warn("Handle error occurred: "+message);
@@ -112,6 +128,13 @@ public class DownloadFolderServlet extends HttpServlet{
 
 	}
 
+	/**
+	 * Send error.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendError(HttpServletResponse response, String message) throws IOException
 	{
 		response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
@@ -126,6 +149,14 @@ public class DownloadFolderServlet extends HttpServlet{
 	}
 
 
+	/**
+	 * Send error for status.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @param status the status
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendErrorForStatus(HttpServletResponse response, String message, int status) throws IOException
 	{
 		response.setStatus(status);
@@ -139,6 +170,13 @@ public class DownloadFolderServlet extends HttpServlet{
 		response.flushBuffer();
 	}
 
+	/**
+	 * Send message.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendMessage(HttpServletResponse response, String message) throws IOException
 	{
 		response.setStatus(HttpServletResponse.SC_ACCEPTED);
@@ -147,6 +185,13 @@ public class DownloadFolderServlet extends HttpServlet{
 		response.flushBuffer();
 	}
 
+	/**
+	 * Send message resource available.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendMessageResourceAvailable(HttpServletResponse response, String message) throws IOException
 	{
 		response.setStatus(HttpServletResponse.SC_ACCEPTED);
@@ -155,6 +200,13 @@ public class DownloadFolderServlet extends HttpServlet{
 		response.flushBuffer();
 	}
 
+	/**
+	 * Send warn message.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendWarnMessage(HttpServletResponse response, String message) throws IOException
 	{
 		response.setStatus(HttpServletResponse.SC_ACCEPTED);
@@ -163,6 +215,14 @@ public class DownloadFolderServlet extends HttpServlet{
 		response.flushBuffer();
 	}
 
+	/**
+	 * Url redirect.
+	 *
+	 * @param req the req
+	 * @param response the response
+	 * @param fakePath the fake path
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void urlRedirect(HttpServletRequest req, HttpServletResponse response, String fakePath) throws IOException  {
 
 		String requestUrl = getRequestURL(req) +fakePath;
@@ -172,6 +232,12 @@ public class DownloadFolderServlet extends HttpServlet{
 		return;
 	}
 
+	/**
+	 * Gets the request url.
+	 *
+	 * @param req the req
+	 * @return the request url
+	 */
 	public static String getRequestURL(HttpServletRequest req) {
 
 		String scheme = req.getScheme();             // http

src/main/java/org/gcube/portlets/user/workspace/server/DownloadPublicLinkServlet.java

@@ -23,11 +23,12 @@ import org.gcube.portlets.user.workspace.server.property.PortalUrlGroupGatewayPr
 import org.gcube.portlets.user.workspace.shared.HandlerResultMessage;
 
 
+
 /**
+ * The Class DownloadPublicLinkServlet.
  *
  * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
- * @Jul 1, 2013
+ * May 16, 2017
- *
  */
 public class DownloadPublicLinkServlet extends HttpServlet{
 
@@ -44,6 +45,9 @@ public class DownloadPublicLinkServlet extends HttpServlet{
 		logger.trace("Workspace DownloadPublicLinkServlet ready.");
 	}
 
+	/* (non-Javadoc)
+	 * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
+	 */
 	public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
 
 		String smp = req.getParameter("smp");
@@ -60,6 +64,13 @@ public class DownloadPublicLinkServlet extends HttpServlet{
 	}
 
 
+	/**
+	 * Send error.
+	 *
+	 * @param response the response
+	 * @param message the message
+	 * @throws IOException Signals that an I/O exception has occurred.
+	 */
 	protected void sendError(HttpServletResponse response, String message) throws IOException
 	{
 		response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
@@ -68,6 +79,12 @@ public class DownloadPublicLinkServlet extends HttpServlet{
 		response.flushBuffer();
 	}
 
+	/**
+	 * Gets the request url.
+	 *
+	 * @param req the req
+	 * @return the request url
+	 */
 	public static String getRequestURL(HttpServletRequest req) {
 
 	    String scheme = req.getScheme();             // http
@@ -101,6 +118,11 @@ public class DownloadPublicLinkServlet extends HttpServlet{
 	    return url.toString();
 	}
 
+	/**
+	 * The main method.
+	 *
+	 * @param args the arguments
+	 */
 	public static void main(String[] args) {
 
 		InputStream is = null;

src/main/java/org/gcube/portlets/user/workspace/server/FileNotVersionedException.java

@@ -5,6 +5,7 @@ package org.gcube.portlets.user.workspace.server;
 
 
 /**
+ * The Class FileNotVersionedException.
  *
  * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
  * Feb 20, 2017
@@ -18,10 +19,15 @@ public class FileNotVersionedException extends Exception {
 	private static final long serialVersionUID = -954314398414781437L;
 
 
-	FileNotVersionedException(){}
 	/**
-	 * @param string
+	 * Instantiates a new file not versioned exception.
+	 */
+	FileNotVersionedException(){}
+
+	/**
+	 * Instantiates a new file not versioned exception.
 	 *
+	 * @param string the string
 	 */
 	public FileNotVersionedException(String string) {
 

src/main/java/org/gcube/portlets/user/workspace/server/MetadataFormat.java

@@ -1,31 +1,32 @@
 /**
- * 
+ *
  */
 package org.gcube.portlets.user.workspace.server;
 
 /**
- * @author Federico De Faveri defaveri@isti.cnr.it
+ * The Enum MetadataFormat.
  *
+ * @author Federico De Faveri defaveri@isti.cnr.it
  */
 public enum MetadataFormat {
 	/**
-	 * HTML metadata format. 
+	 * HTML metadata format.
 	 */
 	HTML,
-	
+
 	/**
 	 * XML formatted metadata.
 	 */
 	FORMATTED_XML,
-	
+
 	/**
 	 * raw metadata XML.
 	 */
 	RAW_XML,
-	
+
 	/**
 	 * The XML raw metadata as html.
 	 */
 	RAW_XML_AS_HTML;
-	
+
 }

src/main/java/org/gcube/portlets/user/workspace/server/NoGcubeItemTypeException.java

@@ -1,20 +1,26 @@
 /**
- * 
+ *
  */
 package org.gcube.portlets.user.workspace.server;
 
 /**
- * @author Federico De Faveri defaveri@isti.cnr.it
+ * The Class NoGcubeItemTypeException.
  *
+ * @author Federico De Faveri defaveri@isti.cnr.it
  */
 public class NoGcubeItemTypeException extends Exception{
 
 	private static final long serialVersionUID = 3660227882791095368L;
 
+	/**
+	 * Instantiates a new no gcube item type exception.
+	 *
+	 * @param message the message
+	 */
 	public NoGcubeItemTypeException(String message) {
 		super(message);
 	}
-	
+
-	
+
 
 }