commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject [1/2] commons-io git commit: Add missing Javadocs.
Date Sat, 18 Nov 2017 20:32:22 GMT
Repository: commons-io
Updated Branches:
  refs/heads/master 4f50c3750 -> 30280a9ba


Add missing Javadocs.

Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/38b0ff19
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/38b0ff19
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/38b0ff19

Branch: refs/heads/master
Commit: 38b0ff19101496d89345213866e0940eb682a8bf
Parents: 4f50c37
Author: Gary Gregory <ggregory@apache.org>
Authored: Sat Nov 18 13:31:30 2017 -0700
Committer: Gary Gregory <ggregory@apache.org>
Committed: Sat Nov 18 13:31:30 2017 -0700

----------------------------------------------------------------------
 .../java/org/apache/commons/io/FileSystem.java  | 24 ++++++++++++++++++++
 1 file changed, 24 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-io/blob/38b0ff19/src/main/java/org/apache/commons/io/FileSystem.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/io/FileSystem.java b/src/main/java/org/apache/commons/io/FileSystem.java
index a2d4409..38b2e58 100644
--- a/src/main/java/org/apache/commons/io/FileSystem.java
+++ b/src/main/java/org/apache/commons/io/FileSystem.java
@@ -182,6 +182,18 @@ public enum FileSystem {
     private final int maxPathLength;
     private final String[] reservedFileNames;
 
+    /**
+     * Constructs a new instance.
+     * 
+     * @param maxFileLength
+     *            the maximum length for file names. The file name does not include folders.
+     * @param maxPathLength
+     *            the maximum length of the path to a file. This can include folders.
+     * @param illegalFileNameChars
+     *            illegal characters for this file system.
+     * @param reservedFileNames
+     *            the reserved file names.
+     */
     private FileSystem(final int maxFileLength, final int maxPathLength, final char[] illegalFileNameChars,
             final String[] reservedFileNames) {
         this.maxFileNameLength = maxFileLength;
@@ -218,6 +230,13 @@ public enum FileSystem {
         return maxPathLength;
     }
 
+    /**
+     * Returns {@code true} if the given character is illegal in a file name, {@code false}
otherwise.
+     * 
+     * @param c
+     *            the character to test
+     * @return {@code true} if the given character is illegal in a file name, {@code false}
otherwise.
+     */
     private boolean isIllegalFileNameChar(final char c) {
         return Arrays.binarySearch(illegalFileNameChars, c) >= 0;
     }
@@ -289,6 +308,11 @@ public enum FileSystem {
         return true;
     }
 
+    /**
+     * Gets the reserved file names.
+     * 
+     * @return the reserved file names.
+     */
     public String[] getReservedFileNames() {
         return reservedFileNames;
     }


Mime
View raw message