org.hkijena.jipipe.utils

Class PathUtils

java.lang.Object

org.hkijena.jipipe.utils.PathUtils

public class PathUtils
extends Object

Utilities for handling paths

Method Summary

Modifier and Type	Method and Description
static Path	absoluteToJIPipeUserDirRelative(Path path)
static String	computeFileSHA1(File file) Computes the SHA1 of a file
static void	copyDirectory(Path sourcePath, Path targetPath, JIPipeProgressInfo progressInfo)
static void	copyDirectory(Path sourcePath, Path targetPath, Predicate<Path> directoryFilter, JIPipeProgressInfo progressInfo)
static void	copyOrLink(Path source, Path target, JIPipeProgressInfo progressInfo)
static void	createDirectories(Path path)
static Path	createTempDirectory(Path root, String prefix)
static void	deleteDirectoryRecursively(Path path, JIPipeProgressInfo progressInfo)
static boolean	ensureEmptyFolder(Component parent, Path path) Ensures that the path exists and is empty
static Path	ensureExtension(Path path, String extension, String... alternativeExtensions) Ensures that the file name of the path has one of the provided extensions
static void	ensureParentDirectoriesExist(Path path) Ensures that the parent directories of the path exist.
static Path	findAnyOf(Path... paths) Returns the first path that exists
static Path	findFileByExtensionIn(Path folder, String... extensions) Finds a file in the specified folder with given extension
static Path	findFileByExtensionRecursivelyIn(Path folder, String... extensions) Finds a file in the specified folder with given extension
static List<Path>	findFilesByExtensionIn(Path folder, String... extensions) Finds a file in the specified folder with given extension
static Path	getImageJDir() Gets the ImageJ directory
static Path	getJIPipeUserDir() Returns the JIPipe user directory
static Path	getJIPipeUserDirBase() Returns the base directory that contains all profiles
static Path	getLegacyJIPipeUserDir() Gets the legacy user directory.
static List<Path>	listSubDirectories(Path folder) Finds a file in the specified folder with given extension
static void	makeAllUnixExecutable(Path dir, JIPipeProgressInfo progressInfo) Marks all files in that directory as Unix executable
static void	makeUnixExecutable(Path path) Makes a file/directory executable Does nothing if the OS is Windows
static Path	normalize(Path path)
static void	normalizeList(List<Path> paths) Converts UNIX paths to Windows and Windows paths to UNIX
static Path	orElse(Path firstChoice, Path alternative) Returns the first path if it exists or the alternative path if it doesn't
static Path	relativeJIPipeUserDirToAbsolute(Path path) Converts relative paths to absolute paths, relative to the ImageJ directory Absolute paths are left unchanged
static Path	resolveAndMakeSubDirectory(Path directory, Path name)
static Path	resolveAndMakeSubDirectory(Path directory, String name)

Methods inherited from class java.lang.Object

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

Method Detail

makeUnixExecutable

public static void makeUnixExecutable(Path path)

Makes a file/directory executable Does nothing if the OS is Windows

Parameters:

path - the path

resolveAndMakeSubDirectory

public static Path resolveAndMakeSubDirectory(Path directory,
                                              String name)

resolveAndMakeSubDirectory

public static Path resolveAndMakeSubDirectory(Path directory,
                                              Path name)

copyDirectory

public static void copyDirectory(Path sourcePath,
                                 Path targetPath,
                                 JIPipeProgressInfo progressInfo)

copyDirectory

public static void copyDirectory(Path sourcePath,
                                 Path targetPath,
                                 Predicate<Path> directoryFilter,
                                 JIPipeProgressInfo progressInfo)

deleteDirectoryRecursively

public static void deleteDirectoryRecursively(Path path,
                                              JIPipeProgressInfo progressInfo)

computeFileSHA1

public static String computeFileSHA1(File file)
                              throws IOException

Computes the SHA1 of a file

Parameters:

file - the file

Returns:

the SHA1

Throws:

IOException - exception

copyOrLink

public static void copyOrLink(Path source,
                              Path target,
                              JIPipeProgressInfo progressInfo)

findFileByExtensionIn

public static Path findFileByExtensionIn(Path folder,
                                         String... extensions)

Finds a file in the specified folder with given extension

Parameters:

folder - the path

extensions - Should contain the dot

Returns:

null if no file was found

findFileByExtensionRecursivelyIn

public static Path findFileByExtensionRecursivelyIn(Path folder,
                                                    String... extensions)

Finds a file in the specified folder with given extension

Parameters:

folder - the path

extensions - Should contain the dot

Returns:

null if no file was found

findFilesByExtensionIn

public static List<Path> findFilesByExtensionIn(Path folder,
                                                String... extensions)

Finds a file in the specified folder with given extension

Parameters:

folder - the path

extensions - Should contain the dot

Returns:

null if no file was found

listSubDirectories

public static List<Path> listSubDirectories(Path folder)

Finds a file in the specified folder with given extension

Parameters:

folder - the path

Returns:

null if no file was found

normalizeList

public static void normalizeList(List<Path> paths)

Converts UNIX paths to Windows and Windows paths to UNIX

Parameters:

paths - the paths. This list must be modifiable

normalize

public static Path normalize(Path path)

findAnyOf

public static Path findAnyOf(Path... paths)

Returns the first path that exists

Parameters:

paths - paths

Returns:

first path that exists or null

getLegacyJIPipeUserDir

public static Path getLegacyJIPipeUserDir()

Gets the legacy user directory. This will be automatically moved to the correct user directory if needed

Returns:

the legacy user directory

getJIPipeUserDirBase

public static Path getJIPipeUserDirBase()

Returns the base directory that contains all profiles

Returns:

the base directory

getJIPipeUserDir

public static Path getJIPipeUserDir()

Returns the JIPipe user directory

Returns:

the JIPipe user directory

getImageJDir

public static Path getImageJDir()

Gets the ImageJ directory

Returns:

the ImageJ directory

absoluteToJIPipeUserDirRelative

public static Path absoluteToJIPipeUserDirRelative(Path path)

relativeJIPipeUserDirToAbsolute

public static Path relativeJIPipeUserDirToAbsolute(Path path)

Converts relative paths to absolute paths, relative to the ImageJ directory Absolute paths are left unchanged

Parameters:

path - the path

Returns:

absolute paths

ensureEmptyFolder

public static boolean ensureEmptyFolder(Component parent,
                                        Path path)

Ensures that the path exists and is empty

Parameters:

parent - the parent component for the dialog box

path - the path

Returns:

if the operation was successful

ensureExtension

public static Path ensureExtension(Path path,
                                   String extension,
                                   String... alternativeExtensions)

Ensures that the file name of the path has one of the provided extensions

Parameters:

path - the path

extension - the extension (should include the dot)

alternativeExtensions - alternative extensions that are also valid (should include the dot)

Returns:

path with a filename that has the provided extension

ensureParentDirectoriesExist

public static void ensureParentDirectoriesExist(Path path)

Ensures that the parent directories of the path exist. If the parent directory is null, nothing will be done

Parameters:

path - the path

orElse

public static Path orElse(Path firstChoice,
                          Path alternative)

Returns the first path if it exists or the alternative path if it doesn't

Parameters:

firstChoice - the first choice. can be null.

alternative - the alternative

Returns:

firstChoice if it is not null and if it does exist, alternative instead

makeAllUnixExecutable

public static void makeAllUnixExecutable(Path dir,
                                         JIPipeProgressInfo progressInfo)

Marks all files in that directory as Unix executable

Parameters:

dir - the directory

progressInfo - the progress

createTempDirectory

public static Path createTempDirectory(Path root,
                                       String prefix)

createDirectories

public static void createDirectories(Path path)