This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
commit 78ffb0a545058aa896db7cb6487032cc76290726 Author: Gary Gregory <[email protected]> AuthorDate: Sun Apr 2 12:03:38 2023 -0400 Remove noisy inline comments --- .../java/org/apache/commons/fileupload2/FileItem.java | 4 ---- .../java/org/apache/commons/fileupload2/FileUpload.java | 6 ------ .../org/apache/commons/fileupload2/FileUploadBase.java | 6 ------ .../org/apache/commons/fileupload2/MultipartStream.java | 6 ------ .../apache/commons/fileupload2/disk/DiskFileItem.java | 16 ---------------- .../commons/fileupload2/disk/DiskFileItemFactory.java | 10 ---------- .../commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java | 6 ------ .../fileupload2/jaksrvlt/JakSrvltRequestContext.java | 6 ------ .../commons/fileupload2/portlet/PortletFileUpload.java | 6 ------ .../commons/fileupload2/servlet/ServletFileUpload.java | 2 -- .../fileupload2/servlet/ServletRequestContext.java | 6 ------ .../org/apache/commons/fileupload2/FileUploadTest.java | 2 -- 12 files changed, 76 deletions(-) diff --git a/src/main/java/org/apache/commons/fileupload2/FileItem.java b/src/main/java/org/apache/commons/fileupload2/FileItem.java index 49df5c6..a44369e 100644 --- a/src/main/java/org/apache/commons/fileupload2/FileItem.java +++ b/src/main/java/org/apache/commons/fileupload2/FileItem.java @@ -47,8 +47,6 @@ import java.io.UnsupportedEncodingException; */ public interface FileItem extends FileItemHeadersSupport { - // ------------------------------- Methods from javax.activation.DataSource - /** * Deletes the underlying storage for a file item, including deleting any * associated temporary disk file. Although this storage will be deleted @@ -76,8 +74,6 @@ public interface FileItem extends FileItemHeadersSupport { */ String getContentType(); - // ------------------------------------------------------- FileItem methods - /** * Returns the name of the field in the multipart form corresponding to * this file item. diff --git a/src/main/java/org/apache/commons/fileupload2/FileUpload.java b/src/main/java/org/apache/commons/fileupload2/FileUpload.java index aee39f9..1c8bf28 100644 --- a/src/main/java/org/apache/commons/fileupload2/FileUpload.java +++ b/src/main/java/org/apache/commons/fileupload2/FileUpload.java @@ -33,15 +33,11 @@ package org.apache.commons.fileupload2; 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/fileupload2/FileUploadBase.java b/src/main/java/org/apache/commons/fileupload2/FileUploadBase.java index 58cb26f..3257ea0 100644 --- a/src/main/java/org/apache/commons/fileupload2/FileUploadBase.java +++ b/src/main/java/org/apache/commons/fileupload2/FileUploadBase.java @@ -48,15 +48,11 @@ import org.apache.commons.fileupload2.util.Streams; */ public abstract class FileUploadBase { - // ---------------------------------------------------------- Class methods - /** * HTTP content type header name. */ public static final String CONTENT_TYPE = "Content-type"; - // ----------------------------------------------------- Manifest constants - /** * HTTP content disposition header name. */ @@ -114,8 +110,6 @@ public abstract class FileUploadBase { return contentType.toLowerCase(Locale.ENGLISH).startsWith(MULTIPART); } - // ----------------------------------------------------------- Data members - /** * The maximum size permitted for the complete request, as opposed to * {@link #fileSizeMax}. A value of -1 indicates no maximum. diff --git a/src/main/java/org/apache/commons/fileupload2/MultipartStream.java b/src/main/java/org/apache/commons/fileupload2/MultipartStream.java index fbb2f60..67769e7 100644 --- a/src/main/java/org/apache/commons/fileupload2/MultipartStream.java +++ b/src/main/java/org/apache/commons/fileupload2/MultipartStream.java @@ -476,8 +476,6 @@ public class MultipartStream { */ protected static final byte[] HEADER_SEPARATOR = { CR, LF, CR, LF }; - // ----------------------------------------------------------- Data members - /** * A byte sequence that that follows a delimiter that will be followed by an encapsulation ({@code CRLF}). */ @@ -546,8 +544,6 @@ public class MultipartStream { */ private final byte[] buffer; - // ----------------------------------------------------------- Constructors - /** * The index of first valid character in the buffer. <br> * 0 <= head < bufSize @@ -572,8 +568,6 @@ public class MultipartStream { - // --------------------------------------------------------- Public methods - /** * <p> * Constructs a {@code MultipartStream} with a custom size buffer. diff --git a/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java b/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java index 90af239..a8b6c46 100644 --- a/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java +++ b/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java @@ -71,8 +71,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 @@ -81,8 +79,6 @@ public class DiskFileItem */ public static final String DEFAULT_CHARSET = "ISO-8859-1"; - // ----------------------------------------------------------- Data members - /** * UID used in unique file name generation. */ @@ -171,16 +167,12 @@ public class DiskFileItem */ private FileItemHeaders headers; - // ----------------------------------------------------------- Constructors - /** * Default content charset to be used when no explicit charset * parameter is provided by the sender. */ private String defaultCharset = DEFAULT_CHARSET; - // ------------------------------- Methods from javax.activation.DataSource - /** * Constructs a new {@code DiskFileItem} instance. * @@ -269,8 +261,6 @@ public class DiskFileItem return params.get("charset"); } - // ------------------------------------------------------- FileItem methods - /** * Returns the content type passed by the agent or {@code null} if * not defined. @@ -476,8 +466,6 @@ public class DiskFileItem return tempFile; } - // --------------------------------------------------------- Public methods - /** * Determines whether or not a {@code FileItem} instance represents * a simple form field. @@ -493,8 +481,6 @@ public class DiskFileItem return isFormField; } - // ------------------------------------------------------ Protected methods - /** * Provides a hint as to whether or not the file contents will be read * from memory. @@ -510,8 +496,6 @@ public class DiskFileItem return dfos.isInMemory(); } - // -------------------------------------------------------- Private methods - /** * Sets the default charset for use when no explicit charset * parameter is provided by the sender. diff --git a/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java b/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java index 2943f37..1397e94 100644 --- a/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java +++ b/src/main/java/org/apache/commons/fileupload2/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 - /** * Create a new {@link org.apache.commons.fileupload2.disk.DiskFileItem} * instance from the supplied parameters and the local factory @@ -188,8 +180,6 @@ public class DiskFileItemFactory implements FileItemFactory { return repository; } - // --------------------------------------------------------- Public Methods - /** * Returns the size threshold beyond which files are written directly to * disk. The default value is 10240 bytes. diff --git a/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java b/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java index 088918d..1912373 100644 --- a/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java +++ b/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java @@ -50,8 +50,6 @@ public class JakSrvltFileUpload 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 JakSrvltFileUpload extends FileUpload { return FileUploadBase.isMultipartContent(new JakSrvltRequestContext(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 JakSrvltFileUpload 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/fileupload2/jaksrvlt/JakSrvltRequestContext.java b/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java index cb40ab7..9855c42 100644 --- a/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java +++ b/src/main/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java @@ -34,15 +34,11 @@ import jakarta.servlet.http.HttpServletRequest; */ public class JakSrvltRequestContext implements UploadContext { - // ----------------------------------------------------- Instance Variables - /** * The request for which the context is being provided. */ private final HttpServletRequest request; - // ----------------------------------------------------------- Constructors - /** * Construct a context for this request. * @@ -52,8 +48,6 @@ public class JakSrvltRequestContext implements UploadContext { this.request = request; } - // --------------------------------------------------------- Public Methods - /** * Retrieve the content length of the request. * diff --git a/src/main/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java b/src/main/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java index c356334..f0f6df4 100644 --- a/src/main/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java +++ b/src/main/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java @@ -48,8 +48,6 @@ import org.apache.commons.fileupload2.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/fileupload2/servlet/ServletFileUpload.java b/src/main/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java index c7fdf57..4e3f061 100644 --- a/src/main/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java +++ b/src/main/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java @@ -88,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/fileupload2/servlet/ServletRequestContext.java b/src/main/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java index 6066294..a4706c1 100644 --- a/src/main/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java +++ b/src/main/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java @@ -34,15 +34,11 @@ import org.apache.commons.fileupload2.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. * @@ -52,8 +48,6 @@ public class ServletRequestContext implements UploadContext { this.request = request; } - // --------------------------------------------------------- Public Methods - /** * Retrieve the content length of the request. * diff --git a/src/test/java/org/apache/commons/fileupload2/FileUploadTest.java b/src/test/java/org/apache/commons/fileupload2/FileUploadTest.java index 461e065..3c1310e 100644 --- a/src/test/java/org/apache/commons/fileupload2/FileUploadTest.java +++ b/src/test/java/org/apache/commons/fileupload2/FileUploadTest.java @@ -49,8 +49,6 @@ public class FileUploadTest { return Util.fileUploadImplementations().stream(); } - // --- Test methods common to all implementations of a FileUpload - private void assertHeaders(final String[] pHeaderNames, final String[] pHeaderValues, final FileItem pItem, final int pIndex) { for (int i = 0; i < pHeaderNames.length; i++) {
