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 2021/10/31 02:44:57 UTC
[commons-io] branch master updated (51f4de0 -> 5648a9d)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git.
from 51f4de0 Use lambdas, in-line single use local variable, remove some whitespace.
new 6b7f261 Remove useless comments.
new 5648a9d Clean up new APIs.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../java/org/apache/commons/io/file/PathUtils.java | 104 ++++++++++++++-------
.../java/org/apache/commons/io/CopyUtilsTest.java | 6 +-
.../org/apache/commons/io/file/PathUtilsTest.java | 3 -
3 files changed, 73 insertions(+), 40 deletions(-)
[commons-io] 02/02: Clean up new APIs.
Posted by gg...@apache.org.
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
commit 5648a9dc560c760792b61e1ac6d5c00e1206748a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Oct 30 22:44:54 2021 -0400
Clean up new APIs.
---
.../java/org/apache/commons/io/file/PathUtils.java | 104 ++++++++++++++-------
.../org/apache/commons/io/file/PathUtilsTest.java | 3 -
2 files changed, 72 insertions(+), 35 deletions(-)
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 e5d08db..0e04e9d 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -43,6 +43,7 @@ import java.nio.file.attribute.AclEntry;
import java.nio.file.attribute.AclFileAttributeView;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.DosFileAttributeView;
+import java.nio.file.attribute.DosFileAttributes;
import java.nio.file.attribute.FileAttribute;
import java.nio.file.attribute.FileTime;
import java.nio.file.attribute.PosixFileAttributeView;
@@ -989,30 +990,7 @@ public final class PathUtils {
* @since 2.12.0
*/
public static boolean isPosix(final Path test, final LinkOption... options) {
- return readAttributes(test, PosixFileAttributes.class, options) != null;
- }
-
- /**
- * Calls {@link Files#readAttributes(Path, Class, LinkOption...)} but returns null instead of throwing
- * {@link UnsupportedOperationException} or {@link IOException}.
- *
- * @param <A> The {@code BasicFileAttributes} type
- * @param test The Path to test.
- * @param type the {@code Class} of the file attributes required to read.
- * @param options options indicating how to handle symbolic links.
- * @return the file attributes.
- * @since 2.12.0
- */
- public static <A extends BasicFileAttributes> A readAttributes(final Path test, final Class<A> type, final LinkOption... options) {
- try {
- return Files.readAttributes(test, type, options);
- } catch (final UnsupportedOperationException e) {
- // For example, on Windows.
- return null;
- } catch (final IOException e) {
- // For example, when the path does not exist.
- return null;
- }
+ return readPosixFileAttributes(test, options) != null;
}
/**
@@ -1083,32 +1061,94 @@ public final class PathUtils {
}
/**
- * Shorthand for {@code Files.readAttributes(path, BasicFileAttributes.class)}
+ * Reads the BasicFileAttributes from the given path.
*
* @param path the path to read.
* @return the path attributes.
* @throws IOException if an I/O error occurs.
* @since 2.9.0
+ * @deprecated Will be removed in 3.0.0 in favor of {@link #readBasicFileAttributes(Path, LinkOption...)}.
*/
+ @Deprecated
public static BasicFileAttributes readBasicFileAttributes(final Path path) throws IOException {
return Files.readAttributes(path, BasicFileAttributes.class);
}
/**
- * Shorthand for {@code Files.readAttributes(path, BasicFileAttributes.class)} while wrapping {@link IOException} as
- * {@link UncheckedIOException}.
+ * Reads the BasicFileAttributes from the given path. Returns null instead of throwing
+ * {@link UnsupportedOperationException}. Throws {@link UncheckedIOExceptions} instead of {@link IOException}.
+ *
+ * @param <A> The {@code BasicFileAttributes} type
+ * @param test The Path to test.
+ * @param type the {@code Class} of the file attributes required to read.
+ * @param options options indicating how to handle symbolic links.
+ * @return the file attributes.
+ * @see Files#readAttributes(Path, Class, LinkOption...)
+ * @since 2.12.0
+ */
+ public static <A extends BasicFileAttributes> A readAttributes(final Path test, final Class<A> type, final LinkOption... options) {
+ try {
+ return Files.readAttributes(test, type, options);
+ } catch (final UnsupportedOperationException e) {
+ // For example, on Windows.
+ return null;
+ } catch (final IOException e) {
+ throw UncheckedIOExceptions.create(test, e);
+ }
+ }
+
+ /**
+ * Reads the BasicFileAttributes from the given path. Returns null instead of throwing
+ * {@link UnsupportedOperationException}.
+ *
+ * @param path the path to read.
+ * @param options options indicating how to handle symbolic links.
+ * @return the path attributes.
+ * @since 2.12.0
+ */
+ public static BasicFileAttributes readBasicFileAttributes(final Path path, final LinkOption... options) {
+ return readAttributes(path, BasicFileAttributes.class, options);
+ }
+
+ /**
+ * Reads the BasicFileAttributes from the given path. Returns null instead of throwing
+ * {@link UnsupportedOperationException}.
*
* @param path the path to read.
* @return the path attributes.
* @throws UncheckedIOException if an I/O error occurs
* @since 2.9.0
+ * @deprecated Use {@link #readBasicFileAttributes(Path, LinkOption...)}.
*/
+ @Deprecated
public static BasicFileAttributes readBasicFileAttributesUnchecked(final Path path) {
- try {
- return readBasicFileAttributes(path);
- } catch (final IOException e) {
- throw UncheckedIOExceptions.create(path, e);
- }
+ return readBasicFileAttributes(path, EMPTY_LINK_OPTION_ARRAY);
+ }
+
+ /**
+ * Reads the DosFileAttributes from the given path. Returns null instead of throwing
+ * {@link UnsupportedOperationException}.
+ *
+ * @param path the path to read.
+ * @param options options indicating how to handle symbolic links.
+ * @return the path attributes.
+ * @since 2.12.0
+ */
+ public static DosFileAttributes readDosFileAttributes(final Path path, final LinkOption... options) {
+ return readAttributes(path, DosFileAttributes.class, options);
+ }
+
+ /**
+ * Reads the PosixFileAttributes from the given path. Returns null instead of throwing
+ * {@link UnsupportedOperationException}.
+ *
+ * @param test The Path to test.
+ * @param options options indicating how to handle symbolic links.
+ * @return the file attributes.
+ * @since 2.12.0
+ */
+ public static PosixFileAttributes readPosixFileAttributes(final Path test, final LinkOption... options) {
+ return readAttributes(test, PosixFileAttributes.class, options);
}
/**
diff --git a/src/test/java/org/apache/commons/io/file/PathUtilsTest.java b/src/test/java/org/apache/commons/io/file/PathUtilsTest.java
index 98ce81b..6f311be 100644
--- a/src/test/java/org/apache/commons/io/file/PathUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/file/PathUtilsTest.java
@@ -20,7 +20,6 @@ package org.apache.commons.io.file;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assumptions.assumeFalse;
@@ -198,7 +197,6 @@ public class PathUtilsTest extends TestArguments {
isPosix = false;
}
assertEquals(isPosix, PathUtils.isPosix(PathUtils.current()));
- assertEquals(false, PathUtils.isPosix(Paths.get("does not.exist")));
}
@Test
@@ -262,7 +260,6 @@ public class PathUtilsTest extends TestArguments {
isPosix = false;
}
assertEquals(isPosix, PathUtils.readAttributes(PathUtils.current(), PosixFileAttributes.class) != null);
- assertNull(PathUtils.readAttributes(Paths.get("does not.exist"), PosixFileAttributes.class));
}
@Test
[commons-io] 01/02: Remove useless comments.
Posted by gg...@apache.org.
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
commit 6b7f261dbd035ebb3248eb75f012d48444e69003
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Oct 30 21:29:25 2021 -0400
Remove useless comments.
---
src/test/java/org/apache/commons/io/CopyUtilsTest.java | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/CopyUtilsTest.java b/src/test/java/org/apache/commons/io/CopyUtilsTest.java
index af71861..715b457 100644
--- a/src/test/java/org/apache/commons/io/CopyUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/CopyUtilsTest.java
@@ -54,10 +54,6 @@ public class CopyUtilsTest {
private final byte[] inData = TestUtils.generateTestData(FILE_SIZE);
- // ----------------------------------------------------------------
- // Tests
- // ----------------------------------------------------------------
-
@Test
public void copy_byteArrayToOutputStream() throws Exception {
final ByteArrayOutputStream baout = new ByteArrayOutputStream();
@@ -215,4 +211,4 @@ public class CopyUtilsTest {
// Nothing to assert, the constructor is public and does not blow up.
}
-} // CopyUtilsTest
+}