Amend description of FilenameUtils#getFullPathNoEndSeparator(String) to reflect correct named user result with trailing slash #553
Conversation
| @@ -669,7 +669,7 @@ public static String getFullPath(final String fileName) { | |||
| * ~ --> ~ | |||
| * ~/ --> ~ | |||
| * ~user --> ~user | |||
| * ~user/ --> ~user | |||
| * ~user/ --> ~user/ | |||
There was a problem hiding this comment.
This causes the Javadoc to contradict itself with the above's excluding the final directory separator.
The question is whether Windows's "C:\" unchanged output is a special case or a bug.
CC: @elharo
There was a problem hiding this comment.
The existing javadoc and API is very unclear. I do not understand "Gets the full path from a full fileName, which is the prefix + path, and also excluding the final directory separator."
The argument is not a filename. There is no such thing as a "full path" in normal parlance. Bug filed. https://issues.apache.org/jira/browse/IO-836
I also agree that if this method turns ~user/ into ~user/ that's a bug. It should produce ~user.
C:\ should also (80% certainty) turn into C:, not C:\
I further expect there are additional bugs in this method involving Unix shell conventions and platform dependencies, but I'd have to dig into the rest of the class to understand exactly what those are.
What a tasty can of worms you've opened. :-)
garydgregory
changed the title
| @@ -669,7 +669,7 @@ public static String getFullPath(final String fileName) { | |||
| * ~ --> ~ | |||
| * ~/ --> ~ | |||
| * ~user --> ~user | |||
| * ~user/ --> ~user | |||
| * ~user/ --> ~user/ | |||
There was a problem hiding this comment.
The existing javadoc and API is very unclear. I do not understand "Gets the full path from a full fileName, which is the prefix + path, and also excluding the final directory separator."
The argument is not a filename. There is no such thing as a "full path" in normal parlance. Bug filed. https://issues.apache.org/jira/browse/IO-836
I also agree that if this method turns ~user/ into ~user/ that's a bug. It should produce ~user.
C:\ should also (80% certainty) turn into C:, not C:\
I further expect there are additional bugs in this method involving Unix shell conventions and platform dependencies, but I'd have to dig into the rest of the class to understand exactly what those are.
What a tasty can of worms you've opened. :-)
|
Note that we should not treat ~ in any special way since it is a Unix-like shell utility and not a file system functionality. |
|
@elharo @garydgregory i totally see the points you've raised and agree it may be worth tackling the current behaviour in a bugfix. However, until that happens, i believe it will be worthwhile to sync the JavaDoc with the current behavior to minimize bad surprises when consuming the library. |
|
Hello @Philzen |
Similar to #551, the trailing slash is actually preserved in the result here.
Confirmed to have this behaviour in 2.4 and latest 2.15.1