Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id BDBD3200D42 for ; Fri, 17 Nov 2017 23:47:58 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id BC2A3160BFB; Fri, 17 Nov 2017 22:47:58 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 0E068160BE6 for ; Fri, 17 Nov 2017 23:47:57 +0100 (CET) Received: (qmail 28323 invoked by uid 500); 17 Nov 2017 22:47:57 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 28314 invoked by uid 99); 17 Nov 2017 22:47:57 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 17 Nov 2017 22:47:57 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 17DA0F4F66; Fri, 17 Nov 2017 22:47:55 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ggregory@apache.org To: commits@commons.apache.org Message-Id: <84ad0e686ab64675b4885e98e782d9ac@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: commons-io git commit: Javadoc. Date: Fri, 17 Nov 2017 22:47:55 +0000 (UTC) archived-at: Fri, 17 Nov 2017 22:47:58 -0000 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 Authored: Fri Nov 17 15:47:52 2017 -0700 Committer: Gary Gregory 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. *

- * + * * @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; }