Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MSHARED-893] deprecate file methods we don't need in Java 7+ #35

Merged
merged 6 commits into from
May 27, 2020
Merged

[MSHARED-893] deprecate file methods we don't need in Java 7+ #35

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
48bccde
deprecate file methods we don't need in Java 7+
elharo May 27, 2020
12949d3
deprecate file methods we don't need in Java 7+
elharo May 27, 2020
9c36abd
deprecate file methods we don't need in Java 7+
elharo May 27, 2020
db5cce8
fix line length
elharo May 27, 2020
438b89f
we only support Java 7+ now
elharo May 27, 2020
803d84a
remove unused method
elharo May 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 49 additions & 18 deletions src/main/java/org/apache/maven/shared/utils/io/FileUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,47 +161,52 @@ protected FileUtils()
* Returns the directory path portion of a file specification string.
* Matches the equally named unix command.
*
* @param filename the file path
* @param path the file path
* @return the directory portion excluding the ending file separator
* @deprecated use {@code Paths.get(path).getParent().getName()}
michael-o marked this conversation as resolved.
Show resolved Hide resolved
*/
@Nonnull public static String dirname( @Nonnull String filename )
@Deprecated
@Nonnull public static String dirname( @Nonnull String path )
michael-o marked this conversation as resolved.
Show resolved Hide resolved
{
int i = filename.lastIndexOf( File.separator );
return ( i >= 0 ? filename.substring( 0, i ) : "" );
int i = path.lastIndexOf( File.separator );
return ( i >= 0 ? path.substring( 0, i ) : "" );
}

/**
* Returns the filename portion of a file specification string.
* Returns the filename portion of a path.
*
* @param filename the file path
* @param path the file path
* @return the filename string with extension
* @deprecated use {@code Paths.get(path).getName()}
*/
@Nonnull public static String filename( @Nonnull String filename )
@Deprecated
@Nonnull public static String filename( @Nonnull String path )
{
int i = filename.lastIndexOf( File.separator );
return ( i >= 0 ? filename.substring( i + 1 ) : filename );
int i = path.lastIndexOf( File.separator );
return ( i >= 0 ? path.substring( i + 1 ) : path );
}

/**
* Returns the extension portion of a file specification string.
* This everything after the last dot '.' in the filename (NOT including
* the dot).
* Returns the extension portion of a file path.
* This is everything after the last dot '.' in the path (NOT including the dot).
*
* @param filename the file path
* @param path the file path
* @return the extension of the file
* @deprecated use {@code org.apache.commons.io.FilenameUtils.getExtension}
*/
@Nonnull public static String extension( @Nonnull String filename )
@Deprecated
@Nonnull public static String extension( @Nonnull String path )
{
// Ensure the last dot is after the last file separator
int lastSep = filename.lastIndexOf( File.separatorChar );
int lastSep = path.lastIndexOf( File.separatorChar );
int lastDot;
if ( lastSep < 0 )
{
lastDot = filename.lastIndexOf( '.' );
lastDot = path.lastIndexOf( '.' );
}
else
{
lastDot = filename.substring( lastSep + 1 ).lastIndexOf( '.' );
lastDot = path.substring( lastSep + 1 ).lastIndexOf( '.' );
if ( lastDot >= 0 )
{
lastDot += lastSep + 1;
Expand All @@ -210,7 +215,7 @@ protected FileUtils()

if ( lastDot >= 0 && lastDot > lastSep )
{
return filename.substring( lastDot + 1 );
return path.substring( lastDot + 1 );
}

return "";
Expand All @@ -221,7 +226,9 @@ protected FileUtils()
*
* @param fileName the file path
* @return true if file exists
* @deprecated use {@code java.io.File.exists()}
*/
@Deprecated
public static boolean fileExists( @Nonnull String fileName )
{
File file = new File( fileName );
Expand All @@ -234,7 +241,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @param file the file path
* @return the file content using the platform encoding
* @throws IOException if any
* @deprecated use {@code new String(java.nio.files.Files.readAllBytes(file))}
*/
@Deprecated
@Nonnull public static String fileRead( @Nonnull String file )
throws IOException
{
Expand All @@ -246,7 +255,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @param encoding the wanted encoding
* @return the file content using the specified encoding
* @throws IOException if any
* @deprecated use {@code new String(java.nio.files.Files.readAllBytes(Paths.get(file)), encoding)}
*/
@Deprecated
@Nonnull private static String fileRead( @Nonnull String file, @Nullable String encoding )
throws IOException
{
Expand All @@ -259,7 +270,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @param file the file path
* @return the file content using the platform encoding
* @throws IOException if any
* @deprecated use {@code new String(java.nio.files.Files.readAllBytes(file.toPath()))}
*/
@Deprecated
@Nonnull public static String fileRead( @Nonnull File file )
throws IOException
{
Expand All @@ -271,7 +284,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @param encoding the wanted encoding
* @return the file content using the specified encoding
* @throws IOException if any
* @deprecated use {@code new String(java.nio.files.Files.readAllBytes(file.toPath()), encoding)}
*/
@Deprecated
@Nonnull public static String fileRead( @Nonnull File file, @Nullable String encoding )
throws IOException
{
Expand All @@ -298,7 +313,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @return the file content lines as String[] using the system default encoding.
* An empty List if the file doesn't exist.
* @throws IOException in case of failure
* @deprecated use {@code java.nio.files.Files.readAllLines()}
*/
@Deprecated
@Nonnull public static String[] fileReadArray( @Nonnull File file )
throws IOException
{
Expand All @@ -314,7 +331,9 @@ public static boolean fileExists( @Nonnull String fileName )
* @param fileName the path of the file to write
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(filename, data.getBytes(), StandardOpenOption.APPEND, StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileAppend( @Nonnull String fileName, @Nonnull String data )
throws IOException
{
Expand All @@ -328,7 +347,9 @@ public static void fileAppend( @Nonnull String fileName, @Nonnull String data )
* @param encoding the encoding of the file
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileAppend( @Nonnull String fileName, @Nullable String encoding, @Nonnull String data )
throws IOException
{
Expand All @@ -347,7 +368,9 @@ public static void fileAppend( @Nonnull String fileName, @Nullable String encodi
* @param fileName the path of the file to write
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(filename, data.getBytes(), StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileWrite( @Nonnull String fileName, @Nonnull String data )
throws IOException
{
Expand All @@ -361,7 +384,9 @@ public static void fileWrite( @Nonnull String fileName, @Nonnull String data )
* @param encoding the encoding of the file
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(Paths.get(filename), data.getBytes(encoding), StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileWrite( @Nonnull String fileName, @Nullable String encoding, @Nonnull String data )
throws IOException
{
Expand All @@ -376,7 +401,9 @@ public static void fileWrite( @Nonnull String fileName, @Nullable String encodin
* @param encoding the encoding of the file
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileWrite( @Nonnull File file, @Nullable String encoding, @Nonnull String data )
throws IOException
{
Expand All @@ -395,7 +422,9 @@ public static void fileWrite( @Nonnull File file, @Nullable String encoding, @No
* @param file the path of the file to write
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileWriteArray( @Nonnull File file, @Nullable String... data )
throws IOException
{
Expand All @@ -409,7 +438,9 @@ public static void fileWriteArray( @Nonnull File file, @Nullable String... data
* @param encoding the encoding of the file
* @param data the content to write to the file
* @throws IOException if any
* @deprecated use {@code java.nio.files.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)}
*/
@Deprecated
public static void fileWriteArray( @Nonnull File file, @Nullable String encoding, @Nullable String... data )
throws IOException
{
Expand Down