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 eef823a6 No need for blank Javadoc lines between Javadoc @ tags
eef823a6 is described below
commit eef823a6455f2d3e9b5c9838c61efbace178efb8
Author: Gary Gregory <[email protected]>
AuthorDate: Thu Nov 28 12:36:30 2024 -0500
No need for blank Javadoc lines between Javadoc @ tags
---
.../apache/commons/fileupload/DefaultFileItemFactory.java | 1 -
.../java/org/apache/commons/fileupload/DiskFileUpload.java | 9 ---------
src/main/java/org/apache/commons/fileupload/FileItem.java | 1 -
.../apache/commons/fileupload/FileItemHeadersSupport.java | 1 -
.../java/org/apache/commons/fileupload/FileUploadBase.java | 13 -------------
.../java/org/apache/commons/fileupload/MultipartStream.java | 8 --------
.../java/org/apache/commons/fileupload/ParameterParser.java | 5 -----
.../java/org/apache/commons/fileupload/RequestContext.java | 1 -
.../org/apache/commons/fileupload/disk/DiskFileItem.java | 3 ---
.../apache/commons/fileupload/disk/DiskFileItemFactory.java | 4 ----
.../commons/fileupload/portlet/PortletFileUpload.java | 4 ----
.../commons/fileupload/portlet/PortletRequestContext.java | 1 -
.../commons/fileupload/servlet/ServletFileUpload.java | 4 ----
.../commons/fileupload/servlet/ServletRequestContext.java | 1 -
.../apache/commons/fileupload/util/mime/Base64Decoder.java | 1 -
.../apache/commons/fileupload/util/mime/MimeUtility.java | 3 ---
.../fileupload/util/mime/QuotedPrintableDecoder.java | 1 -
17 files changed, 61 deletions(-)
diff --git
a/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
b/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
index 69feabbb..0e336156 100644
--- a/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/DefaultFileItemFactory.java
@@ -82,7 +82,6 @@ public class DefaultFileItemFactory extends
DiskFileItemFactory {
* by the browser or other client.
*
* @return The newly created file item.
- *
* @deprecated 1.1 Use {@code DiskFileItemFactory} instead.
*/
@Override
diff --git a/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
b/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
index a2351a69..5f47b6d0 100644
--- a/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/DiskFileUpload.java
@@ -52,7 +52,6 @@ public class DiskFileUpload
* create {@code FileItem} instances.
*
* @see #DiskFileUpload(DefaultFileItemFactory fileItemFactory)
- *
* @deprecated 1.1 Use {@code FileUpload} instead.
*/
@Deprecated
@@ -66,7 +65,6 @@ public class DiskFileUpload
*
* @see #DiskFileUpload()
* @param fileItemFactory The file item factory to use.
- *
* @deprecated 1.1 Use {@code FileUpload} instead.
*/
@Deprecated
@@ -78,7 +76,6 @@ public class DiskFileUpload
* Returns the factory class used when creating file items.
*
* @return The factory class for new file items.
- *
* @deprecated 1.1 Use {@code FileUpload} instead.
*/
@Override
@@ -92,7 +89,6 @@ public class DiskFileUpload
* than the configured size threshold.
*
* @return The path to the temporary file location.
- *
* @see #setRepositoryPath(String)
*
* @deprecated 1.1 Use {@code DiskFileItemFactory} instead.
@@ -107,7 +103,6 @@ public class DiskFileUpload
* disk.
*
* @return The size threshold, in bytes.
- *
* @see #setSizeThreshold(int)
*
* @deprecated 1.1 Use {@code DiskFileItemFactory} instead.
@@ -126,7 +121,6 @@ public class DiskFileUpload
* @param sizeThreshold The max size in bytes to be stored in memory.
* @param sizeMax The maximum allowed upload size, in bytes.
* @param path The location where the files should be stored.
- *
* @return A list of {@code FileItem} instances parsed from the
* request, in the order that they were transmitted.
*
@@ -152,7 +146,6 @@ public class DiskFileUpload
* thereof, or else a {@code ClassCastException} will be thrown.
*
* @param fileItemFactory The factory class for new file items.
- *
* @deprecated 1.1 Use {@code FileUpload} instead.
*/
@Override
@@ -166,7 +159,6 @@ public class DiskFileUpload
* than the configured size threshold.
*
* @param repositoryPath The path to the temporary file location.
- *
* @see #getRepositoryPath()
*
* @deprecated 1.1 Use {@code DiskFileItemFactory} instead.
@@ -180,7 +172,6 @@ public class DiskFileUpload
* Sets the size threshold beyond which files are written directly to disk.
*
* @param sizeThreshold The size threshold, in bytes.
- *
* @see #getSizeThreshold()
*
* @deprecated 1.1 Use {@code DiskFileItemFactory} instead.
diff --git a/src/main/java/org/apache/commons/fileupload/FileItem.java
b/src/main/java/org/apache/commons/fileupload/FileItem.java
index 5520e117..bce12384 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItem.java
@@ -137,7 +137,6 @@ public interface FileItem extends FileItemHeadersSupport {
* contents of the item.
*
* @param encoding The character encoding to use.
- *
* @return The contents of the item, as a string.
*
* @throws UnsupportedEncodingException if the requested character
diff --git
a/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
b/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
index dfba3df7..bf4fdcef 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItemHeadersSupport.java
@@ -21,7 +21,6 @@ package org.apache.commons.fileupload;
* implementations will accept the headers read for the item.
*
* @since 1.2.1
- *
* @see FileItem
* @see FileItemStream
*/
diff --git a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
index c9c824c2..9afe5a6d 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUploadBase.java
@@ -664,7 +664,6 @@ public abstract class FileUploadBase {
*
* @param message The detail message.
* @param cause the original cause
- *
* @since 1.3.1
*/
public InvalidContentTypeException(final String message, final
Throwable cause) {
@@ -893,7 +892,6 @@ public abstract class FileUploadBase {
* content.
*
* @param req The servlet request to be evaluated. Must be non-null.
- *
* @return {@code true} if the request is multipart;
* {@code false} otherwise.
*
@@ -914,7 +912,6 @@ public abstract class FileUploadBase {
* provide its replacement until this method is removed.</p>
*
* @param ctx The request context to be evaluated. Must be non-null.
- *
* @return {@code true} if the request is multipart;
* {@code false} otherwise.
*/
@@ -963,7 +960,6 @@ public abstract class FileUploadBase {
* opposed to a file.
*
* @return A newly created {@code FileItem} instance.
- *
* @deprecated 1.2 This method is no longer used in favor of
* internally created instances of {@link FileItem}.
*/
@@ -1004,7 +1000,6 @@ public abstract class FileUploadBase {
* header.
*
* @param headers A {@code Map} containing the HTTP request headers.
- *
* @return The field name for the current {@code encapsulation}.
*/
protected String getFieldName(final FileItemHeaders headers) {
@@ -1016,7 +1011,6 @@ public abstract class FileUploadBase {
* header.
*
* @param headers A {@code Map} containing the HTTP request headers.
- *
* @return The field name for the current {@code encapsulation}.
* @deprecated 1.2.1 Use {@link #getFieldName(FileItemHeaders)}.
*/
@@ -1068,7 +1062,6 @@ public abstract class FileUploadBase {
* header.
*
* @param headers The HTTP headers object.
- *
* @return The file name for the current {@code encapsulation}.
*/
protected String getFileName(final FileItemHeaders headers) {
@@ -1080,7 +1073,6 @@ public abstract class FileUploadBase {
* header.
*
* @param headers A {@code Map} containing the HTTP request headers.
- *
* @return The file name for the current {@code encapsulation}.
* @deprecated 1.2.1 Use {@link #getFileName(FileItemHeaders)}.
*/
@@ -1136,7 +1128,6 @@ public abstract class FileUploadBase {
*
* @param headers A {@code Map} containing the HTTP request headers.
* @param name The name of the header to return.
- *
* @return The value of specified header, or a comma-separated list if
* there were multiple headers of that name.
* @deprecated 1.2.1 Use {@link FileItemHeaders#getHeader(String)}.
@@ -1164,7 +1155,6 @@ public abstract class FileUploadBase {
* compliant {@code multipart/form-data} stream.
*
* @param ctx The context for the request to be parsed.
- *
* @return An iterator to instances of {@code FileItemStream}
* parsed from the request, in the order that they were
* transmitted.
@@ -1334,7 +1324,6 @@ public abstract class FileUploadBase {
* compliant {@code multipart/form-data} stream.
*
* @param ctx The context for the request to be parsed.
- *
* @return A map of {@code FileItem} instances parsed from the request.
*
* @throws FileUploadException if there are problems reading/parsing
@@ -1367,7 +1356,6 @@ public abstract class FileUploadBase {
* compliant {@code multipart/form-data} stream.
*
* @param req The servlet request to be parsed.
- *
* @return A list of {@code FileItem} instances parsed from the
* request, in the order that they were transmitted.
*
@@ -1387,7 +1375,6 @@ public abstract class FileUploadBase {
* compliant {@code multipart/form-data} stream.
*
* @param ctx The context for the request to be parsed.
- *
* @return A list of {@code FileItem} instances parsed from the
* request, in the order that they were transmitted.
*
diff --git a/src/main/java/org/apache/commons/fileupload/MultipartStream.java
b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
index 7bb15602..64b77ca9 100644
--- a/src/main/java/org/apache/commons/fileupload/MultipartStream.java
+++ b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
@@ -516,7 +516,6 @@ public class MultipartStream {
* @param a The first array to compare.
* @param b The second array to compare.
* @param count How many bytes should be compared.
- *
* @return {@code true} if {@code count} first bytes in arrays
* {@code a} and {@code b} are equal.
*/
@@ -631,7 +630,6 @@ public class MultipartStream {
* @param boundary The token used for dividing the stream into
* {@code encapsulations}.
* @param bufSize The size of the buffer to be used, in bytes.
- *
* @deprecated 1.2.1 Use {@link #MultipartStream(InputStream, byte[], int,
* ProgressNotifier)}.
*/
@@ -656,7 +654,6 @@ public class MultipartStream {
* progress listener, if any.
*
* @throws IllegalArgumentException If the buffer size is too small
- *
* @since 1.3.1
*/
public MultipartStream(final InputStream input,
@@ -743,7 +740,6 @@ public class MultipartStream {
* understand.
*
* @return The amount of data discarded.
- *
* @throws MalformedStreamException if the stream ends unexpectedly.
* @throws IOException if an i/o error occurs.
*/
@@ -757,7 +753,6 @@ public class MultipartStream {
*
* @param value The value to find.
* @param pos The starting position for searching.
- *
* @return The position of byte found, counting from beginning of the
* {@code buffer}, or {@code -1} if not found.
*/
@@ -832,7 +827,6 @@ public class MultipartStream {
* to {@link #discardBodyData()}.
*
* @return the amount of data written.
- *
* @throws MalformedStreamException if the stream ends unexpectedly.
* @throws IOException if an i/o error occurs.
*/
@@ -893,7 +887,6 @@ public class MultipartStream {
* necessary.
*
* @return The next byte from the input stream.
- *
* @throws IOException if there is no more data available.
*/
public byte readByte() throws IOException {
@@ -925,7 +918,6 @@ public class MultipartStream {
* protect against abuse.
*
* @return The {@code header-part} of the current encapsulation.
- *
* @throws FileUploadIOException if the bytes read from the stream
exceeded the size limits.
* @throws MalformedStreamException if the stream ends unexpectedly.
*/
diff --git a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
index b90823b6..91a612ca 100644
--- a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
+++ b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
@@ -133,7 +133,6 @@ public class ParameterParser {
*
* @param ch the character to test for presence in the array of characters
* @param charray the array of characters to test against
- *
* @return {@code true} if the character is present in the array of
* characters, {@code false} otherwise.
*/
@@ -155,7 +154,6 @@ public class ParameterParser {
* @param charArray the array of characters that contains a sequence of
* name/value pairs
* @param separator the name/value pairs separator
- *
* @return a map of name/value pairs
*/
public Map<String, String> parse(final char[] charArray, final char
separator) {
@@ -174,7 +172,6 @@ public class ParameterParser {
* @param offset the initial offset.
* @param length the length.
* @param separator the name/value pairs separator
- *
* @return a map of name/value pairs
*/
public Map<String, String> parse(
@@ -231,7 +228,6 @@ public class ParameterParser {
*
* @param str the string that contains a sequence of name/value pairs
* @param separator the name/value pairs separator
- *
* @return a map of name/value pairs
*/
public Map<String, String> parse(final String str, final char separator) {
@@ -248,7 +244,6 @@ public class ParameterParser {
*
* @param str the string that contains a sequence of name/value pairs
* @param separators the name/value pairs separators
- *
* @return a map of name/value pairs
*/
public Map<String, String> parse(final String str, final char[]
separators) {
diff --git a/src/main/java/org/apache/commons/fileupload/RequestContext.java
b/src/main/java/org/apache/commons/fileupload/RequestContext.java
index 9709e3e6..7a7786f6 100644
--- a/src/main/java/org/apache/commons/fileupload/RequestContext.java
+++ b/src/main/java/org/apache/commons/fileupload/RequestContext.java
@@ -55,7 +55,6 @@ public interface RequestContext {
* Retrieve the input stream for the request.
*
* @return The input stream for the request.
- *
* @throws IOException if a problem occurs.
*/
InputStream getInputStream() throws IOException;
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 7a5aac17..1153745b 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
@@ -293,7 +293,6 @@ public class DiskFileItem
* this file item.
*
* @return The name of the form field.
- *
* @see #setFieldName(String)
*
*/
@@ -441,7 +440,6 @@ public class DiskFileItem
* contents of the file.
*
* @param charset The charset to use.
- *
* @return The contents of the file, as a string.
*
* @throws UnsupportedEncodingException if the requested character
@@ -521,7 +519,6 @@ public class DiskFileItem
* Sets the field name used to reference this file item.
*
* @param fieldName The name of the form field.
- *
* @see #getFieldName()
*
*/
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 b1663b92..ddee9ade 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
@@ -172,7 +172,6 @@ public class DiskFileItemFactory implements FileItemFactory
{
* than the configured size threshold.
*
* @return The directory in which temporary files will be located.
- *
* @see #setRepository(java.io.File)
*
*/
@@ -185,7 +184,6 @@ public class DiskFileItemFactory implements FileItemFactory
{
* disk. The default value is 10240 bytes.
*
* @return The size threshold, in bytes.
- *
* @see #setSizeThreshold(int)
*/
public int getSizeThreshold() {
@@ -218,7 +216,6 @@ public class DiskFileItemFactory implements FileItemFactory
{
* than the configured size threshold.
*
* @param repository The directory in which temporary files will be
located.
- *
* @see #getRepository()
*
*/
@@ -230,7 +227,6 @@ public class DiskFileItemFactory implements FileItemFactory
{
* Sets the size threshold beyond which files are written directly to disk.
*
* @param sizeThreshold The size threshold, in bytes.
- *
* @see #getSizeThreshold()
*
*/
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 f360aed2..9791ea76 100644
--- a/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
@@ -53,7 +53,6 @@ public class PortletFileUpload extends FileUpload {
* content.
*
* @param request The portlet request to be evaluated. Must be non-null.
- *
* @return {@code true} if the request is multipart;
* {@code false} otherwise.
*/
@@ -88,7 +87,6 @@ public class PortletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The portlet request to be parsed.
- *
* @return An iterator to instances of {@code FileItemStream}
* parsed from the request, in the order that they were
* transmitted.
@@ -109,7 +107,6 @@ public class PortletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The portlet request to be parsed.
- *
* @return A map of {@code FileItem} instances parsed from the request.
*
* @throws FileUploadException if there are problems reading/parsing
@@ -127,7 +124,6 @@ public class PortletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The portlet request to be parsed.
- *
* @return A list of {@code FileItem} instances parsed from the
* request, in the order that they were transmitted.
*
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 abd2ce32..9d6c9c05 100644
---
a/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java
+++
b/src/main/java/org/apache/commons/fileupload/portlet/PortletRequestContext.java
@@ -101,7 +101,6 @@ public class PortletRequestContext implements UploadContext
{
* Retrieve the input stream for the request.
*
* @return The input stream for the request.
- *
* @throws IOException if a problem occurs.
*/
@Override
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 37d9bfdb..b20abdf4 100644
--- a/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
@@ -55,7 +55,6 @@ public class ServletFileUpload extends FileUpload {
* content.
*
* @param request The servlet request to be evaluated. Must be non-null.
- *
* @return {@code true} if the request is multipart;
* {@code false} otherwise.
*/
@@ -93,7 +92,6 @@ public class ServletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The servlet request to be parsed.
- *
* @return An iterator to instances of {@code FileItemStream}
* parsed from the request, in the order that they were
* transmitted.
@@ -114,7 +112,6 @@ public class ServletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The servlet request to be parsed.
- *
* @return A map of {@code FileItem} instances parsed from the request.
*
* @throws FileUploadException if there are problems reading/parsing
@@ -132,7 +129,6 @@ public class ServletFileUpload extends FileUpload {
* compliant {@code multipart/form-data} stream.
*
* @param request The servlet request to be parsed.
- *
* @return A list of {@code FileItem} instances parsed from the
* request, in the order that they were transmitted.
*
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 4b0224ac..7ac5aabe 100644
---
a/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java
+++
b/src/main/java/org/apache/commons/fileupload/servlet/ServletRequestContext.java
@@ -99,7 +99,6 @@ public class ServletRequestContext implements UploadContext {
* Retrieve the input stream for the request.
*
* @return The input stream for the request.
- *
* @throws IOException if a problem occurs.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/Base64Decoder.java
b/src/main/java/org/apache/commons/fileupload/util/mime/Base64Decoder.java
index ba14670f..51c56a8a 100644
--- a/src/main/java/org/apache/commons/fileupload/util/mime/Base64Decoder.java
+++ b/src/main/java/org/apache/commons/fileupload/util/mime/Base64Decoder.java
@@ -92,7 +92,6 @@ final class Base64Decoder {
*
* @param data the buffer containing the Base64-encoded data
* @param out the output stream to hold the decoded bytes
- *
* @return the number of bytes produced.
* @throws IOException thrown when the padding is incorrect or the input
is truncated.
*/
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
b/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
index 6166ba4b..78b457d4 100644
--- a/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
+++ b/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
@@ -85,7 +85,6 @@ public final class MimeUtility {
* base64 encoding.
*
* @param text The text to decode.
- *
* @return The decoded text string.
* @throws UnsupportedEncodingException if the detected encoding in the
input text is not supported.
*/
@@ -184,7 +183,6 @@ public final class MimeUtility {
* encoded-word = "=?" charset "?" encoding "?" encoded-text "?="
*
* @param word The possibly encoded word value.
- *
* @return The decoded word.
* @throws ParseException in case of a parse error of the RFC 2047
* @throws UnsupportedEncodingException Thrown when Invalid RFC 2047
encoding was found
@@ -253,7 +251,6 @@ public final class MimeUtility {
* equivalent.
*
* @param charset The MIME standard name.
- *
* @return The Java equivalent for this name.
*/
private static String javaCharset(final String charset) {
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
index 97a3c4b5..68381b48 100644
---
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
+++
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
@@ -35,7 +35,6 @@ final class QuotedPrintableDecoder {
*
* @param data The array of byte data to decode.
* @param out The output stream used to return the decoded data.
- *
* @return the number of bytes produced.
* @throws IOException if an IO error occurs
*/
