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 2019/05/30 19:19:53 UTC

[commons-fileupload] branch master updated: Javadoc: Use "file name" instead of "filename".

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


The following commit(s) were added to refs/heads/master by this push:
     new 928984e  Javadoc: Use "file name" instead of "filename".
928984e is described below

commit 928984efdb0c0f60f33597492d6e879012f9a736
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu May 30 15:19:48 2019 -0400

    Javadoc: Use "file name" instead of "filename".
---
 src/main/java/org/apache/commons/fileupload2/DefaultFileItem.java | 2 +-
 src/main/java/org/apache/commons/fileupload2/FileItem.java        | 4 ++--
 src/main/java/org/apache/commons/fileupload2/FileItemStream.java  | 4 ++--
 .../java/org/apache/commons/fileupload2/disk/DiskFileItem.java    | 8 ++++----
 src/main/java/org/apache/commons/fileupload2/package-info.java    | 4 ++--
 5 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/commons/fileupload2/DefaultFileItem.java b/src/main/java/org/apache/commons/fileupload2/DefaultFileItem.java
index e537b03..d874735 100644
--- a/src/main/java/org/apache/commons/fileupload2/DefaultFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload2/DefaultFileItem.java
@@ -49,7 +49,7 @@ public class DefaultFileItem
      *                      <code>null</code> if not specified.
      * @param isFormField   Whether or not this item is a plain form field, as
      *                      opposed to a file upload.
-     * @param fileName      The original filename in the user's file system, or
+     * @param fileName      The original file name in the user's file system, or
      *                      <code>null</code> if not specified.
      * @param sizeThreshold The threshold, in bytes, below which items will be
      *                      retained in memory and above which they will be
diff --git a/src/main/java/org/apache/commons/fileupload2/FileItem.java b/src/main/java/org/apache/commons/fileupload2/FileItem.java
index fdbd5af..4d49029 100644
--- a/src/main/java/org/apache/commons/fileupload2/FileItem.java
+++ b/src/main/java/org/apache/commons/fileupload2/FileItem.java
@@ -69,12 +69,12 @@ public interface FileItem extends FileItemHeadersSupport {
     String getContentType();
 
     /**
-     * Returns the original filename in the client's file system, as provided by
+     * Returns the original file name in the client's file system, as provided by
      * the browser (or other client software). In most cases, this will be the
      * base file name, without path information. However, some clients, such as
      * the Opera browser, do include path information.
      *
-     * @return The original filename in the client's file system.
+     * @return The original file name in the client's file system.
      * @throws InvalidFileNameException The file name contains a NUL character,
      *   which might be an indicator of a security attack. If you intend to
      *   use the file name anyways, catch the exception and use
diff --git a/src/main/java/org/apache/commons/fileupload2/FileItemStream.java b/src/main/java/org/apache/commons/fileupload2/FileItemStream.java
index c8100b6..d4e01fa 100644
--- a/src/main/java/org/apache/commons/fileupload2/FileItemStream.java
+++ b/src/main/java/org/apache/commons/fileupload2/FileItemStream.java
@@ -73,12 +73,12 @@ public interface FileItemStream extends FileItemHeadersSupport {
     String getContentType();
 
     /**
-     * Returns the original filename in the client's file system, as provided by
+     * Returns the original file name in the client's file system, as provided by
      * the browser (or other client software). In most cases, this will be the
      * base file name, without path information. However, some clients, such as
      * the Opera browser, do include path information.
      *
-     * @return The original filename in the client's file system.
+     * @return The original file name in the client's file system.
      */
     String getName();
 
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 b6d85b2..7bc224a 100644
--- a/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
@@ -111,7 +111,7 @@ public class DiskFileItem
     private boolean isFormField;
 
     /**
-     * The original filename in the user's file system.
+     * The original file name in the user's file system.
      */
     private final String fileName;
 
@@ -168,7 +168,7 @@ public class DiskFileItem
      *                      <code>null</code> if not specified.
      * @param isFormField   Whether or not this item is a plain form field, as
      *                      opposed to a file upload.
-     * @param fileName      The original filename in the user's file system, or
+     * @param fileName      The original file name in the user's file system, or
      *                      <code>null</code> if not specified.
      * @param sizeThreshold The threshold, in bytes, below which items will be
      *                      retained in memory and above which they will be
@@ -240,9 +240,9 @@ public class DiskFileItem
     }
 
     /**
-     * Returns the original filename in the client's file system.
+     * Returns the original file name in the client's file system.
      *
-     * @return The original filename in the client's file system.
+     * @return The original file name in the client's file system.
      * @throws org.apache.commons.fileupload2.InvalidFileNameException The file name contains a NUL character,
      *   which might be an indicator of a security attack. If you intend to
      *   use the file name anyways, catch the exception and use
diff --git a/src/main/java/org/apache/commons/fileupload2/package-info.java b/src/main/java/org/apache/commons/fileupload2/package-info.java
index 02c340a..f1b85ca 100644
--- a/src/main/java/org/apache/commons/fileupload2/package-info.java
+++ b/src/main/java/org/apache/commons/fileupload2/package-info.java
@@ -57,9 +57,9 @@
  *   Iterator i = fileItems.iterator();
  *   String comment = ((FileItem)i.next()).getString();
  *   FileItem fi = (FileItem)i.next();
- *   // filename on the client
+ *   // file name on the client
  *   String fileName = fi.getName();
- *   // save comment and filename to database
+ *   // save comment and file name to database
  *   ...
  *   // write the file
  *   fi.write(new File("/www/uploads/", fileName));