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 2017/11/17 22:47:55 UTC
commons-io git commit: Javadoc.
Repository: commons-io
Updated Branches:
refs/heads/master 10c8db1b1 -> 2bacf6392
Javadoc.
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/2bacf639
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/2bacf639
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/2bacf639
Branch: refs/heads/master
Commit: 2bacf63927effbe494ea8888191b950037d4606f
Parents: 10c8db1
Author: Gary Gregory <gg...@apache.org>
Authored: Fri Nov 17 15:47:52 2017 -0700
Committer: Gary Gregory <gg...@apache.org>
Committed: Fri Nov 17 15:47:52 2017 -0700
----------------------------------------------------------------------
.../java/org/apache/commons/io/FileSystem.java | 22 +++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/2bacf639/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 9a5f520..d0c4a51 100644
--- a/src/main/java/org/apache/commons/io/FileSystem.java
+++ b/src/main/java/org/apache/commons/io/FileSystem.java
@@ -27,7 +27,7 @@ import java.util.Objects;
* The starting point of any operation is {@link #getCurrent()} which gets you the enum for the file system that matches
* the OS hosting the running JVM.
* </p>
- *
+ *
* @since 2.7
*/
public enum FileSystem {
@@ -102,6 +102,11 @@ public enum FileSystem {
private static final String OS_NAME = getSystemProperty("os.name");
+ /**
+ * Gets the current file system.
+ *
+ * @return the current file system
+ */
public static FileSystem getCurrent() {
if (IS_OS_LINUX) {
return LINUX;
@@ -180,14 +185,29 @@ public enum FileSystem {
this.illegalFileNameChars = Objects.requireNonNull(illegalFileNameChars, "illegalFileNameChars");
}
+ /**
+ * Gets the illegal characters for this file system.
+ *
+ * @return the illegal characters for this file system.
+ */
public char[] getIllegalFileNameChars() {
return this.illegalFileNameChars.clone();
}
+ /**
+ * Gets the maximum length for file names. The file name does not include folders.
+ *
+ * @return the maximum length for file names.
+ */
public int getMaxFileNameLength() {
return maxFileNameLength;
}
+ /**
+ * Gets the maximum length of the path to a file. This can include folders.
+ *
+ * @return the maximum length of the path to a file.
+ */
public int getMaxPathLength() {
return maxPathLength;
}