You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/07/26 22:39:04 UTC
(commons-fileupload) branch 1.x updated: Remove useless comments
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch 1.x
in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
The following commit(s) were added to refs/heads/1.x by this push:
new 628a8af5 Remove useless comments
628a8af5 is described below
commit 628a8af510f847b162dcaa1843f0c39cd8b1fa36
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jul 26 18:38:59 2024 -0400
Remove useless comments
---
.../org/apache/commons/fileupload/DefaultFileItem.java | 2 --
.../commons/fileupload/DefaultFileItemFactory.java | 4 ----
.../org/apache/commons/fileupload/DiskFileUpload.java | 8 --------
.../java/org/apache/commons/fileupload/FileItem.java | 4 ----
.../java/org/apache/commons/fileupload/FileUpload.java | 6 ------
.../org/apache/commons/fileupload/FileUploadBase.java | 12 ------------
.../org/apache/commons/fileupload/MultipartStream.java | 8 --------
.../org/apache/commons/fileupload/disk/DiskFileItem.java | 16 ----------------
.../commons/fileupload/disk/DiskFileItemFactory.java | 10 ----------
.../commons/fileupload/portlet/PortletFileUpload.java | 6 ------
.../fileupload/portlet/PortletRequestContext.java | 8 --------
.../commons/fileupload/servlet/ServletFileUpload.java | 6 ------
.../fileupload/servlet/ServletRequestContext.java | 6 ------
.../org/apache/commons/fileupload/FileUploadTest.java | 2 --
14 files changed, 98 deletions(-)
diff --git a/src/main/java/org/apache/commons/fileupload/DefaultFileItem.java b/src/main/java/org/apache/commons/fileupload/DefaultFileItem.java
index f7e104bb..17dd4c12 100644
--- a/src/main/java/org/apache/commons/fileupload/DefaultFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/DefaultFileItem.java
@@ -39,8 +39,6 @@ import org.apache.commons.fileupload.disk.DiskFileItem;
public class DefaultFileItem
extends DiskFileItem {
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs a new {@code DefaultFileItem} instance.
*
diff --git a/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java b/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
index 2d1f74f1..69feabbb 100644
--- a/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
@@ -42,8 +42,6 @@ import org.apache.commons.fileupload.disk.DiskFileItemFactory;
@Deprecated
public class DefaultFileItemFactory extends DiskFileItemFactory {
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an unconfigured instance of this class. The resulting factory
* may be configured by calling the appropriate setter methods.
@@ -71,8 +69,6 @@ public class DefaultFileItemFactory extends DiskFileItemFactory {
super(sizeThreshold, repository);
}
- // --------------------------------------------------------- Public Methods
-
/**
* Create a new {@link org.apache.commons.fileupload.DefaultFileItem}
* instance from the supplied parameters and the local factory
diff --git a/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java b/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
index 714c325f..c4a08a55 100644
--- a/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
@@ -42,15 +42,11 @@ import javax.servlet.http.HttpServletRequest;
public class DiskFileUpload
extends FileUploadBase {
- // ----------------------------------------------------------- Data members
-
/**
* The factory to use to create new form items.
*/
private DefaultFileItemFactory fileItemFactory;
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an instance of this class which uses the default factory to
* create {@code FileItem} instances.
@@ -78,8 +74,6 @@ public class DiskFileUpload
this.fileItemFactory = fileItemFactory;
}
- // ----------------------------------------------------- Property accessors
-
/**
* Returns the factory class used when creating file items.
*
@@ -167,8 +161,6 @@ public class DiskFileUpload
fileItemFactory.setRepository(new File(repositoryPath));
}
- // --------------------------------------------------------- Public methods
-
/**
* Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>
* compliant {@code multipart/form-data} stream. If files are stored
diff --git a/src/main/java/org/apache/commons/fileupload/FileItem.java b/src/main/java/org/apache/commons/fileupload/FileItem.java
index c2fb4e16..1dd23a65 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItem.java
@@ -46,8 +46,6 @@ import java.io.UnsupportedEncodingException;
*/
public interface FileItem extends FileItemHeadersSupport {
- // ------------------------------- Methods from javax.activation.DataSource
-
/**
* Returns an {@link java.io.InputStream InputStream} that can be
* used to retrieve the contents of the file.
@@ -82,8 +80,6 @@ public interface FileItem extends FileItemHeadersSupport {
*/
String getName();
- // ------------------------------------------------------- FileItem methods
-
/**
* Provides a hint as to whether or not the file contents will be read
* from memory.
diff --git a/src/main/java/org/apache/commons/fileupload/FileUpload.java b/src/main/java/org/apache/commons/fileupload/FileUpload.java
index e26a5a72..48506ec3 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUpload.java
@@ -33,15 +33,11 @@ package org.apache.commons.fileupload;
public class FileUpload
extends FileUploadBase {
- // ----------------------------------------------------------- Data members
-
/**
* The factory to use to create new form items.
*/
private FileItemFactory fileItemFactory;
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an uninitialized instance of this class.
*
@@ -65,8 +61,6 @@ public class FileUpload
this.fileItemFactory = fileItemFactory;
}
- // ----------------------------------------------------- Property accessors
-
/**
* Returns the factory class used when creating file items.
*
diff --git a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
index cd3893ed..7de61e04 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
@@ -56,8 +56,6 @@ import org.apache.commons.io.IOUtils;
*/
public abstract class FileUploadBase {
- // ---------------------------------------------------------- Class methods
-
/**
* <p>Utility method that determines whether the request contains multipart
* content.</p>
@@ -96,8 +94,6 @@ public abstract class FileUploadBase {
return ServletFileUpload.isMultipartContent(req);
}
- // ----------------------------------------------------- Manifest constants
-
/**
* HTTP content type header name.
*/
@@ -155,8 +151,6 @@ public abstract class FileUploadBase {
@Deprecated
public static final int MAX_HEADER_SIZE = 1024;
- // ----------------------------------------------------------- Data members
-
/**
* The maximum size permitted for the complete request, as opposed to
* {@link #fileSizeMax}. A value of -1 indicates no maximum.
@@ -185,8 +179,6 @@ public abstract class FileUploadBase {
*/
private ProgressListener listener;
- // ----------------------------------------------------- Property accessors
-
/**
* Returns the factory class used when creating file items.
*
@@ -293,8 +285,6 @@ public abstract class FileUploadBase {
headerEncoding = encoding;
}
- // --------------------------------------------------------- Public methods
-
/**
* Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>
* compliant {@code multipart/form-data} stream.
@@ -438,8 +428,6 @@ public abstract class FileUploadBase {
return itemsMap;
}
- // ------------------------------------------------------ Protected methods
-
/**
* Retrieves the boundary from the {@code Content-type} header.
*
diff --git a/src/main/java/org/apache/commons/fileupload/MultipartStream.java b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
index 6354cfdd..1b014f2e 100644
--- a/src/main/java/org/apache/commons/fileupload/MultipartStream.java
+++ b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
@@ -151,8 +151,6 @@ public class MultipartStream {
}
- // ----------------------------------------------------- Manifest constants
-
/**
* The Carriage Return ASCII character value.
*/
@@ -202,8 +200,6 @@ public class MultipartStream {
*/
protected static final byte[] BOUNDARY_PREFIX = {CR, LF, DASH, DASH};
- // ----------------------------------------------------------- Data members
-
/**
* The input stream from which data is read.
*/
@@ -264,8 +260,6 @@ public class MultipartStream {
*/
private final ProgressNotifier notifier;
- // ----------------------------------------------------------- Constructors
-
/**
* Creates a new instance.
*
@@ -386,8 +380,6 @@ public class MultipartStream {
this(input, boundary, DEFAULT_BUFSIZE, null);
}
- // --------------------------------------------------------- Public methods
-
/**
* Retrieves the character encoding used when reading the headers of an
* individual part. When not specified, or {@code null}, the platform
diff --git a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
index 02fb010f..c1877ac6 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
@@ -69,8 +69,6 @@ import org.apache.commons.io.output.DeferredFileOutputStream;
public class DiskFileItem
implements FileItem {
- // ----------------------------------------------------- Manifest constants
-
/**
* Default content charset to be used when no explicit charset
* parameter is provided by the sender. Media subtypes of the
@@ -79,8 +77,6 @@ public class DiskFileItem
*/
public static final String DEFAULT_CHARSET = "ISO-8859-1";
- // ----------------------------------------------------------- Data members
-
/**
* UID used in unique file name generation.
*/
@@ -156,8 +152,6 @@ public class DiskFileItem
*/
private String defaultCharset = DEFAULT_CHARSET;
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs a new {@code DiskFileItem} instance.
*
@@ -186,8 +180,6 @@ public class DiskFileItem
this.repository = repository;
}
- // ------------------------------- Methods from javax.activation.DataSource
-
/**
* Returns an {@link java.io.InputStream InputStream} that can be
* used to retrieve the contents of the file.
@@ -251,8 +243,6 @@ public class DiskFileItem
return Streams.checkFileName(fileName);
}
- // ------------------------------------------------------- FileItem methods
-
/**
* Provides a hint as to whether or not the file contents will be read
* from memory.
@@ -505,8 +495,6 @@ public class DiskFileItem
return dfos;
}
- // --------------------------------------------------------- Public methods
-
/**
* Returns the {@link java.io.File} object for the {@code FileItem}'s
* data's temporary location on the disk. Note that for
@@ -530,8 +518,6 @@ public class DiskFileItem
return dfos.getFile();
}
- // ------------------------------------------------------ Protected methods
-
/**
* Removes the file contents from the temporary storage.
*/
@@ -572,8 +558,6 @@ public class DiskFileItem
return tempFile;
}
- // -------------------------------------------------------- Private methods
-
/**
* Returns an identifier that is unique within the class loader used to
* load this class, but does not have random-like appearance.
diff --git a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
index 4cb416b1..ade5f338 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
@@ -69,15 +69,11 @@ import org.apache.commons.io.FileCleaningTracker;
*/
public class DiskFileItemFactory implements FileItemFactory {
- // ----------------------------------------------------- Manifest constants
-
/**
* The default threshold above which uploads will be stored on disk.
*/
public static final int DEFAULT_SIZE_THRESHOLD = 10240;
- // ----------------------------------------------------- Instance Variables
-
/**
* The directory in which uploaded files will be stored, if stored on disk.
*/
@@ -101,8 +97,6 @@ public class DiskFileItemFactory implements FileItemFactory {
*/
private String defaultCharset = DiskFileItem.DEFAULT_CHARSET;
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an unconfigured instance of this class. The resulting factory
* may be configured by calling the appropriate setter methods.
@@ -126,8 +120,6 @@ public class DiskFileItemFactory implements FileItemFactory {
this.repository = repository;
}
- // ------------------------------------------------------------- Properties
-
/**
* Returns the directory used to temporarily store files that are larger
* than the configured size threshold.
@@ -178,8 +170,6 @@ public class DiskFileItemFactory implements FileItemFactory {
this.sizeThreshold = sizeThreshold;
}
- // --------------------------------------------------------- Public Methods
-
/**
* Create a new {@link DiskFileItem}
* instance from the supplied parameters and the local factory
diff --git a/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java b/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
index 7e00f155..dfc05468 100644
--- a/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
@@ -48,8 +48,6 @@ import org.apache.commons.fileupload.FileUploadException;
*/
public class PortletFileUpload extends FileUpload {
- // ---------------------------------------------------------- Class methods
-
/**
* Utility method that determines whether the request contains multipart
* content.
@@ -64,8 +62,6 @@ public class PortletFileUpload extends FileUpload {
new PortletRequestContext(request));
}
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an uninitialized instance of this class. A factory must be
* configured, using {@code setFileItemFactory()}, before attempting
@@ -87,8 +83,6 @@ public class PortletFileUpload extends FileUpload {
super(fileItemFactory);
}
- // --------------------------------------------------------- Public methods
-
/**
* Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>
* compliant {@code multipart/form-data} stream.
diff --git a/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java b/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java
index 20213821..4b3dafd9 100644
--- a/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java
+++ b/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java
@@ -34,16 +34,11 @@ import org.apache.commons.fileupload.UploadContext;
*/
public class PortletRequestContext implements UploadContext {
- // ----------------------------------------------------- Instance Variables
-
/**
* The request for which the context is being provided.
*/
private final ActionRequest request;
-
- // ----------------------------------------------------------- Constructors
-
/**
* Construct a context for this request.
*
@@ -53,9 +48,6 @@ public class PortletRequestContext implements UploadContext {
this.request = request;
}
-
- // --------------------------------------------------------- Public Methods
-
/**
* Retrieve the character encoding for the request.
*
diff --git a/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java b/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
index 648a463a..b1e78fbc 100644
--- a/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
@@ -50,8 +50,6 @@ public class ServletFileUpload extends FileUpload {
*/
private static final String POST_METHOD = "POST";
- // ---------------------------------------------------------- Class methods
-
/**
* Utility method that determines whether the request contains multipart
* content.
@@ -69,8 +67,6 @@ public class ServletFileUpload extends FileUpload {
return FileUploadBase.isMultipartContent(new ServletRequestContext(request));
}
- // ----------------------------------------------------------- Constructors
-
/**
* Constructs an uninitialized instance of this class. A factory must be
* configured, using {@code setFileItemFactory()}, before attempting
@@ -92,8 +88,6 @@ public class ServletFileUpload extends FileUpload {
super(fileItemFactory);
}
- // --------------------------------------------------------- Public methods
-
/**
* Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>
* compliant {@code multipart/form-data} stream.
diff --git a/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java b/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java
index 2f3abc97..6afef2d7 100644
--- a/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java
+++ b/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java
@@ -32,15 +32,11 @@ import org.apache.commons.fileupload.UploadContext;
*/
public class ServletRequestContext implements UploadContext {
- // ----------------------------------------------------- Instance Variables
-
/**
* The request for which the context is being provided.
*/
private final HttpServletRequest request;
- // ----------------------------------------------------------- Constructors
-
/**
* Construct a context for this request.
*
@@ -50,8 +46,6 @@ public class ServletRequestContext implements UploadContext {
this.request = request;
}
- // --------------------------------------------------------- Public Methods
-
/**
* Retrieve the character encoding for the request.
*
diff --git a/src/test/java/org/apache/commons/fileupload/FileUploadTest.java b/src/test/java/org/apache/commons/fileupload/FileUploadTest.java
index 04438021..7e8745e8 100644
--- a/src/test/java/org/apache/commons/fileupload/FileUploadTest.java
+++ b/src/test/java/org/apache/commons/fileupload/FileUploadTest.java
@@ -60,8 +60,6 @@ public class FileUploadTest {
@Parameter
public FileUpload upload;
- // --- Test methods common to all implementations of a FileUpload
-
@Test
public void testFileUpload()
throws IOException, FileUploadException {