org.eclipse.jkube.kit.common.util

Class FileUtil

java.lang.Object

org.eclipse.jkube.kit.common.util.FileUtil

public class FileUtil
extends Object

File related methods which cannot be found elsewhere

Author:

roland

Method Summary

Modifier and Type	Method and Description
static void	cleanDirectory(File directoryFile)
static void	copy(File sourceFile, File targetFile)
static void	copy(Path sourcePath, Path targetPath)
static void	copyDirectoryIfNotExists(File sourceDir, File targetDir)
static void	createDirectory(File directory)
static File	createTempDirectory()
static void	downloadRemotes(File outputDirectory, List<String> remotes, KitLogger log)
static String	getAbsolutePath(String fileName) Returns the absolute path to a file with name fileName
static String	getAbsolutePath(URL url) Returns the absolute path to a resource addressed by the given url
static String	getRelativeFilePath(String oldFilePath, String newFilePath) Adapted from https://github.com/sonatype/plexus-utils/blob/5ba6cfcca911200b5b9d2b313bb939e6d7cbbac6/src/main/java/org/codehaus/plexus/util/PathTool.java#L302
static File	getRelativePath(File baseDir, File file)
static List<File>	listFilesAndDirsRecursivelyInDirectory(File directory)
static String	stripPostfix(String text, String postfix)
static String	stripPrefix(String text, String prefix)
static String	trimWildcardCharactersFromPath(String filePath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createTempDirectory

public static File createTempDirectory()

getRelativePath

public static File getRelativePath(File baseDir,
                                   File file)

stripPrefix

public static String stripPrefix(String text,
                                 String prefix)

stripPostfix

public static String stripPostfix(String text,
                                  String postfix)

getAbsolutePath

public static String getAbsolutePath(String fileName)

Returns the absolute path to a file with name fileName

Parameters:

fileName - the name of a file

Returns:

absolute path to the file

getAbsolutePath

public static String getAbsolutePath(URL url)

Returns the absolute path to a resource addressed by the given url

Parameters:

url - resource URL

Returns:

absolute path to the resource

downloadRemotes

public static void downloadRemotes(File outputDirectory,
                                   List<String> remotes,
                                   KitLogger log)

cleanDirectory

public static void cleanDirectory(File directoryFile)
                           throws IOException

Throws:

IOException

getRelativeFilePath

public static String getRelativeFilePath(String oldFilePath,
                                         String newFilePath)

Adapted from https://github.com/sonatype/plexus-utils/blob/5ba6cfcca911200b5b9d2b313bb939e6d7cbbac6/src/main/java/org/codehaus/plexus/util/PathTool.java#L302

This method can calculate the relative path between two paths on a file system.

 getRelativeFilePath( null, null )                                   = ""
 getRelativeFilePath( null, "/usr/local/java/bin" )                  = ""
 getRelativeFilePath( "/usr/local", null )                           = ""
 getRelativeFilePath( "/usr/local", "/usr/local/java/bin" )          = "java/bin"
 getRelativeFilePath( "/usr/local", "/usr/local/java/bin/" )         = "java/bin"
 getRelativeFilePath( "/usr/local/java/bin", "/usr/local/" )         = "../.."
 getRelativeFilePath( "/usr/local/", "/usr/local/java/bin/java.sh" ) = "java/bin/java.sh"
 getRelativeFilePath( "/usr/local/java/bin/java.sh", "/usr/local/" ) = "../../.."
 getRelativeFilePath( "/usr/local/", "/bin" )                        = "../../bin"
 getRelativeFilePath( "/bin", "/usr/local/" )                        = "../usr/local"
 

Note: On Windows based system, the / character should be replaced by \ character.

Parameters:

oldFilePath - the old file path

newFilePath - the new file path

Returns:

a relative file path from oldFilePath.

copy

public static void copy(File sourceFile,
                        File targetFile)
                 throws IOException

Throws:

IOException

copy

public static void copy(Path sourcePath,
                        Path targetPath)
                 throws IOException

Throws:

IOException

copyDirectoryIfNotExists

public static void copyDirectoryIfNotExists(File sourceDir,
                                            File targetDir)
                                     throws IOException

Throws:

IOException

trimWildcardCharactersFromPath

public static String trimWildcardCharactersFromPath(String filePath)

listFilesAndDirsRecursivelyInDirectory

public static List<File> listFilesAndDirsRecursivelyInDirectory(File directory)

createDirectory

public static void createDirectory(File directory)
                            throws IOException

Throws:

IOException