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-io.git
The following commit(s) were added to refs/heads/master by this push:
new f1d9aa9 Javadoc.
f1d9aa9 is described below
commit f1d9aa944ea42bba4718330c74e0a7f4867d62a4
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Thu Sep 16 19:04:13 2021 -0400
Javadoc.
---
src/main/java/org/apache/commons/io/FileUtils.java | 6 +---
.../java/org/apache/commons/io/file/PathUtils.java | 33 ++++++++++------------
.../commons/io/file/attribute/FileTimes.java | 2 +-
.../commons/io/filefilter/AgeFileFilter.java | 2 +-
.../org/apache/commons/io/monitor/FileEntry.java | 6 ++--
5 files changed, 20 insertions(+), 29 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index 7a86942..79e211f 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1139,7 +1139,6 @@ public class FileUtils {
* Gets the current directory.
*
* @return the current directory.
- *
* @since 2.12.0
*/
public static File current() {
@@ -1697,7 +1696,6 @@ public class FileUtils {
* @return true if the {@code File} exists and has been modified after the
given {@code FileTime}.
* @throws IOException if an I/O error occurs.
* @throws NullPointerException if the file or local date is {@code null}.
- *
* @since 2.12.0
*/
public static boolean isFileNewer(final File file, final FileTime
fileTime) throws IOException {
@@ -1708,11 +1706,10 @@ public class FileUtils {
/**
* Tests if the specified {@code File} is newer than the specified {@code
Instant}.
*
- * @param file the {@code File} of which the modification date must be
compared.
+ * @param file the {@code File} of which the modification date must be
compared.
* @param instant the date reference.
* @return true if the {@code File} exists and has been modified after the
given {@code Instant}.
* @throws NullPointerException if the file or instant is {@code null}.
- *
* @since 2.8.0
*/
public static boolean isFileNewer(final File file, final Instant instant) {
@@ -1887,7 +1884,6 @@ public class FileUtils {
* @return true if the {@code File} exists and has been modified before
the given {@code FileTime}.
* @throws IOException if an I/O error occurs.
* @throws NullPointerException if the file or local date is {@code null}.
- *
* @since 2.12.0
*/
public static boolean isFileOlder(final File file, final FileTime
fileTime) throws IOException {
diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java
b/src/main/java/org/apache/commons/io/file/PathUtils.java
index 3f3274a..ac42725 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -224,7 +224,7 @@ public final class PathUtils {
/**
* Compares the specified {@code Path}'s last modified time to the given
file time.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param fileTime the time reference.
* @param options options indicating how to handle symbolic links.
* @return See {@link FileTime#compareTo(FileTime)}
@@ -312,9 +312,9 @@ public final class PathUtils {
/**
* Counts aspects of a directory including sub-directories.
*
- * @param directory directory to delete.
+ * @param directory directory to count.
* @return The visitor used to count the given directory.
- * @throws IOException if an I/O error is thrown by a visitor method.
+ * @throws IOException if an I/O error occurs.
* @since 2.12.0
*/
public static PathCounters countDirectoryAsBigInteger(final Path
directory) throws IOException {
@@ -734,7 +734,7 @@ public final class PathUtils {
}
/**
- * Returns a {@link Path} representing the system temporary directory.
+ * Gets a {@link Path} representing the system temporary directory.
*
* @return the system temporary directory.
*
@@ -804,7 +804,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is newer than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param czdt the time reference.
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified after the
given time reference.
@@ -820,7 +820,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is newer than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param fileTime the time reference.
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified after the
given time reference.
@@ -838,7 +838,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is newer than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param instant the time reference.
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified after the
given time reference.
@@ -853,7 +853,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is newer than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param timeMillis the time reference measured in milliseconds since the
epoch (00:00:00 GMT, January 1, 1970)
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified after the
given time reference.
@@ -868,7 +868,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is newer than the reference {@code
Path}.
*
- * @param file the {@code File} of which the modification date must
be compared.
+ * @param file the {@code File} to test.
* @param reference the {@code File} of which the modification date is
used.
* @return true if the {@code File} exists and has been modified more
* recently than the reference {@code File}.
@@ -882,7 +882,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is older than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared.
+ * @param file the {@code Path} to test.
* @param fileTime the time reference.
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified before
the given time reference.
@@ -900,7 +900,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is older than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared.
+ * @param file the {@code Path} to test.
* @param instant the time reference.
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified after the
given time reference.
@@ -915,7 +915,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is older than the specified time
reference.
*
- * @param file the {@code Path} of which the modification date must be
compared
+ * @param file the {@code Path} to test.
* @param timeMillis the time reference measured in milliseconds since the
epoch (00:00:00 GMT, January 1, 1970)
* @param options options indicating how to handle symbolic links.
* @return true if the {@code Path} exists and has been modified before
the given time reference.
@@ -930,7 +930,7 @@ public final class PathUtils {
/**
* Tests if the specified {@code Path} is older than the reference {@code
Path}.
*
- * @param file the {@code File} of which the modification date must be
compared.
+ * @param file the {@code File} to test.
* @param reference the {@code File} of which the modification date is
used.
* @return true if the {@code File} exists and has been modified before
than the reference {@code File}.
* @throws IOException if an I/O error occurs.
@@ -975,7 +975,6 @@ public final class PathUtils {
*
* @param path the Path.
* @param append Whether or not to append.
- *
* @return a new OutputStream.
* @throws IOException if an I/O error occurs.
* @see Files#newOutputStream(Path, OpenOption...)
@@ -1210,7 +1209,6 @@ public final class PathUtils {
* @throws NullPointerException if the file is {@code null}.
* @throws IllegalArgumentException if the file does not exist.
* @throws IOException if an I/O error occurs.
- *
* @since 2.12.0
*/
public static long sizeOf(final Path path) throws IOException {
@@ -1228,7 +1226,6 @@ public final class PathUtils {
* @throws NullPointerException if the file is {@code null}.
* @throws IllegalArgumentException if the file does not exist.
* @throws IOException if an I/O error occurs.
- *
* @since 2.12.0
*/
public static BigInteger sizeOfAsBigInteger(final Path path) throws
IOException {
@@ -1237,7 +1234,7 @@ public final class PathUtils {
}
/**
- * Counts the size of a directory recursively (sum of the length of all
files).
+ * Counts the size of a directory recursively (sum of the size of all
files).
* <p>
* Note that overflow is not detected, and the return value may be
negative if overflow occurs. See
* {@link #sizeOfDirectoryAsBigInteger(Path)} for an alternative method
that does not overflow.
@@ -1255,7 +1252,7 @@ public final class PathUtils {
}
/**
- * Counts the size of a directory recursively (sum of the length of all
files).
+ * Counts the size of a directory recursively (sum of the size of all
files).
*
* @param directory directory to inspect, must not be {@code null}.
* @return size of directory in bytes, 0 if directory is security
restricted.
diff --git a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java
b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java
index ffc4c22..ed7a141 100644
--- a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java
+++ b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java
@@ -28,7 +28,7 @@ import java.time.Instant;
public class FileTimes {
/**
- * Constant for the {@code 1970-01-01T00:00:00Z} epoch time stamp
attribute.
+ * Constant for the {@code 1970-01-01T00:00:00Z} epoch as a time stamp
attribute.
*
* @see Instant#EPOCH
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
b/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
index 77c00d3..1ff289e 100644
--- a/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
@@ -126,7 +126,7 @@ public class AgeFileFilter extends AbstractFileFilter
implements Serializable {
}
/**
- * Constructs a new age file filter for files equal to or older than a
certain cutoff
+ * Constructs a new age file filter for files equal to or older than a
certain cutoff.
*
* @param cutoffInstant The cutoff time threshold measured in milliseconds
since the epoch (00:00:00 GMT, January 1,
* 1970).
diff --git a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
index a08f03a..b38f6a2 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
@@ -214,8 +214,7 @@ public class FileEntry implements Serializable {
}
/**
- * Gets the last modified time from the last time it
- * was checked.
+ * Gets the last modified time from the last time it was checked.
*
* @return the last modified time.
* @since 2.12.0
@@ -235,8 +234,7 @@ public class FileEntry implements Serializable {
}
/**
- * Sets the last modified time from the last time it
- * was checked.
+ * Sets the last modified time from the last time it was checked.
*
* @param lastModified The last modified time.
* @since 2.12.0
