dev.jeka.core.api.utils

Class JkUtilsPath

java.lang.Object

dev.jeka.core.api.utils.JkUtilsPath

public final class JkUtilsPath
extends java.lang.Object

Utility class providing convenient methods to deal with Path. Mainly for wrapping checked exceptions and handle safely null parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkUtilsPath.JkZipRoot A container object representing both a zip file and its content.

Method Summary

Modifier and Type	Method and Description
static int	childrenCount(java.nio.file.Path dir, int max, boolean includeDirectories, java.nio.file.PathMatcher pathMatcher) Returns the file count contained in the specified directory (recursively) to concurrence to specified max count.
static void	copy(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... copyOptions) Delegates to Files.copy(Path, Path, CopyOption...) wrapping checked exception.
static int	copyDirContent(java.nio.file.Path sourceDir, java.nio.file.Path targetDir, java.nio.file.PathMatcher pathMatcher, java.nio.file.CopyOption... copyOptions) Copies the content of the source directory into the target directory.
static void	createDirectories(java.nio.file.Path path, java.nio.file.attribute.FileAttribute<?>... attrs) Delegates to Files.createDirectories(Path, FileAttribute[]) wrapping checked exception.
static void	createFile(java.nio.file.Path path, java.nio.file.attribute.FileAttribute<?>... attrs) Delegates to Files.createFile(Path, FileAttribute[])s
static void	createFileSafely(java.nio.file.Path path, java.nio.file.attribute.FileAttribute<?>... attrs) Delegates to Files.createFile(Path, FileAttribute[]) but checking first if the specified file does not already exist.
static java.nio.file.Path	createTempDirectory(java.lang.String prefix, java.nio.file.attribute.FileAttribute... fileAttributes) Delegates to FilescreateTempDirectory(String, FileAttribute[])
static java.nio.file.Path	createTempFile(java.lang.String prefix, java.lang.String extension, java.nio.file.attribute.FileAttribute... fileAttributes) Delegates to Files.createTempFile(String, String, FileAttribute[])
static void	deleteFile(java.nio.file.Path path) Delegates to FilesdeleteFile(Path)
static void	deleteIfExists(java.nio.file.Path path) Delegates to FilesdeleteIfExists(Path)
static void	deleteIfExistsSafely(java.nio.file.Path path) Delegates to FilesdeleteIfExists(Path)
static void	deleteQuietly(java.nio.file.Path path, boolean ignoreDeleteError)
static java.util.List<java.nio.file.Path>	disambiguate(java.lang.Iterable<java.nio.file.Path> paths) As Path implements Iterable it is not obvious if an Iterable of Path was intended to be a list of Path or a single Path.
static java.nio.file.Path	firstExisting(java.nio.file.Path... paths) Returns the first specified path that exist.
static java.lang.String	friendlyName(java.nio.file.Path path)
static java.nio.file.Path	get(java.net.URL url)
static java.util.Optional<java.lang.Long>	getLastModifiedTime(java.nio.file.Path path, java.nio.file.LinkOption... options)
static boolean	isSameFile(java.nio.file.Path path1, java.nio.file.Path path2) Delegates to FilesisSameFile(Path, Path)
static java.util.stream.Stream<java.lang.String>	lines(java.nio.file.Path file, java.nio.charset.Charset charset)
static java.util.List<java.nio.file.Path>	listDirectChildren(java.nio.file.Path path)
static void	move(java.nio.file.Path from, java.nio.file.Path to, java.nio.file.StandardCopyOption... options)
static void	moveDir(java.nio.file.Path source, java.nio.file.Path target) Move directory along all its children and subdirectories recursively
static java.nio.file.DirectoryStream<java.nio.file.Path>	newDirectoryStream(java.nio.file.Path root, java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
static java.io.InputStream	newInputStream(java.nio.file.Path path, java.nio.file.OpenOption... openOptions)
static byte[]	readAllBytes(java.nio.file.Path path) Delegates to Files.readAllBytes(Path) (Path)
static java.util.List<java.lang.String>	readAllLines(java.nio.file.Path path) Delegates to Files.readAllLines(Path)
static java.util.Properties	readPropertyFile(java.nio.file.Path propertyFile) Returns the content of the specified property file as a Properties object.
static java.nio.file.WatchKey	register(java.nio.file.Path dir, java.nio.file.WatchService watchService, java.nio.file.WatchEvent.Kind<?>... watchEventKinds)
static java.nio.file.Path	relativizeFromDirIfAbsolute(java.nio.file.Path referent, java.nio.file.Path pathToRelativize) Returns the relative path to working dir of the specified path.
static java.nio.file.Path	relativizeFromWorkingDir(java.nio.file.Path path) Returns the relative path to working dir of the specified path.
static long	size(java.nio.file.Path path)
static java.util.List<java.io.File>	toFiles(java.util.Collection<java.nio.file.Path> paths)
static java.io.File[]	toFiles(java.nio.file.Path... paths)
static java.nio.file.Path[]	toPaths(java.io.File... files)
static java.util.List<java.nio.file.Path>	toPaths(java.lang.Iterable<java.io.File> files)
static java.net.URL	toUrl(java.io.File file) Get the url to the specified file.
static java.net.URL	toUrl(java.nio.file.Path path) Get the url to the specified path.
static java.util.stream.Stream<java.nio.file.Path>	walk(java.nio.file.Path path, java.nio.file.FileVisitOption... options)
static java.util.stream.Stream<java.nio.file.Path>	walk(java.nio.file.Path path, int deep, java.nio.file.FileVisitOption... options)
static void	walkFileTree(java.nio.file.Path path, java.nio.file.FileVisitor<java.nio.file.Path> visitor)
static void	write(java.nio.file.Path path, byte[] bytes, java.nio.file.OpenOption... options) Delegates to Fileswrite(Path, byte[], OpenOption...)
static JkUtilsPath.JkZipRoot	zipRoot(java.nio.file.Path zipFile)

Methods inherited from class java.lang.Object

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

Method Detail

friendlyName

public static java.lang.String friendlyName(java.nio.file.Path path)

disambiguate

public static java.util.List<java.nio.file.Path> disambiguate(java.lang.Iterable<java.nio.file.Path> paths)

As Path implements Iterable it is not obvious if an Iterable of Path was intended to be a list of Path or a single Path. This method helps by returning a list of Path containing either a single element if the argument was an instance of Path nor a list of elements contained in the iterable argument.

Parameters:

paths -

Returns:

firstExisting

public static java.nio.file.Path firstExisting(java.nio.file.Path... paths)

Returns the first specified path that exist. Returns null if none.

get

public static java.nio.file.Path get(java.net.URL url)

zipRoot

public static JkUtilsPath.JkZipRoot zipRoot(java.nio.file.Path zipFile)

move

public static void move(java.nio.file.Path from,
                        java.nio.file.Path to,
                        java.nio.file.StandardCopyOption... options)

See Also:

Files.move(Path, Path, CopyOption...)

readPropertyFile

public static java.util.Properties readPropertyFile(java.nio.file.Path propertyFile)

Returns the content of the specified property file as a Properties object.

toUrl

public static java.net.URL toUrl(java.io.File file)

Get the url to the specified file.

newInputStream

public static java.io.InputStream newInputStream(java.nio.file.Path path,
                                                 java.nio.file.OpenOption... openOptions)

toFiles

public static java.util.List<java.io.File> toFiles(java.util.Collection<java.nio.file.Path> paths)

toFiles

public static java.io.File[] toFiles(java.nio.file.Path... paths)

toPaths

public static java.nio.file.Path[] toPaths(java.io.File... files)

toPaths

public static java.util.List<java.nio.file.Path> toPaths(java.lang.Iterable<java.io.File> files)

isSameFile

public static boolean isSameFile(java.nio.file.Path path1,
                                 java.nio.file.Path path2)

Delegates to FilesisSameFile(Path, Path)

createTempFile

public static java.nio.file.Path createTempFile(java.lang.String prefix,
                                                java.lang.String extension,
                                                java.nio.file.attribute.FileAttribute... fileAttributes)

Delegates to Files.createTempFile(String, String, FileAttribute[])

readAllLines

public static java.util.List<java.lang.String> readAllLines(java.nio.file.Path path)

Delegates to Files.readAllLines(Path)

lines

public static java.util.stream.Stream<java.lang.String> lines(java.nio.file.Path file,
                                                              java.nio.charset.Charset charset)

readAllBytes

public static byte[] readAllBytes(java.nio.file.Path path)

Delegates to Files.readAllBytes(Path) (Path)

deleteQuietly

public static void deleteQuietly(java.nio.file.Path path,
                                 boolean ignoreDeleteError)

deleteFile

public static void deleteFile(java.nio.file.Path path)

Delegates to FilesdeleteFile(Path)

deleteIfExists

public static void deleteIfExists(java.nio.file.Path path)

Delegates to FilesdeleteIfExists(Path)

deleteIfExistsSafely

public static void deleteIfExistsSafely(java.nio.file.Path path)

Delegates to FilesdeleteIfExists(Path)

createFile

public static void createFile(java.nio.file.Path path,
                              java.nio.file.attribute.FileAttribute<?>... attrs)

Delegates to Files.createFile(Path, FileAttribute[])s

createFileSafely

public static void createFileSafely(java.nio.file.Path path,
                                    java.nio.file.attribute.FileAttribute<?>... attrs)

Delegates to Files.createFile(Path, FileAttribute[]) but checking first if the specified file does not already exist. If so, do nothing, else creates parent directories if needed prior creating the file.

write

public static void write(java.nio.file.Path path,
                         byte[] bytes,
                         java.nio.file.OpenOption... options)

Delegates to Fileswrite(Path, byte[], OpenOption...)

createTempDirectory

public static java.nio.file.Path createTempDirectory(java.lang.String prefix,
                                                     java.nio.file.attribute.FileAttribute... fileAttributes)

Delegates to FilescreateTempDirectory(String, FileAttribute[])

newDirectoryStream

public static java.nio.file.DirectoryStream<java.nio.file.Path> newDirectoryStream(java.nio.file.Path root,
                                                                                   java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)

listDirectChildren

public static java.util.List<java.nio.file.Path> listDirectChildren(java.nio.file.Path path)

createDirectories

public static void createDirectories(java.nio.file.Path path,
                                     java.nio.file.attribute.FileAttribute<?>... attrs)

Delegates to Files.createDirectories(Path, FileAttribute[]) wrapping checked exception.

copy

public static void copy(java.nio.file.Path source,
                        java.nio.file.Path target,
                        java.nio.file.CopyOption... copyOptions)

Delegates to Files.copy(Path, Path, CopyOption...) wrapping checked exception.

toUrl

public static java.net.URL toUrl(java.nio.file.Path path)

Get the url to the specified path.

walk

public static java.util.stream.Stream<java.nio.file.Path> walk(java.nio.file.Path path,
                                                               java.nio.file.FileVisitOption... options)

walk

public static java.util.stream.Stream<java.nio.file.Path> walk(java.nio.file.Path path,
                                                               int deep,
                                                               java.nio.file.FileVisitOption... options)

walkFileTree

public static void walkFileTree(java.nio.file.Path path,
                                java.nio.file.FileVisitor<java.nio.file.Path> visitor)

copyDirContent

public static int copyDirContent(java.nio.file.Path sourceDir,
                                 java.nio.file.Path targetDir,
                                 java.nio.file.PathMatcher pathMatcher,
                                 java.nio.file.CopyOption... copyOptions)

Copies the content of the source directory into the target directory. The root of source directory is not created as an entry of the target directory.

Returns:

the copied file count.

childrenCount

public static int childrenCount(java.nio.file.Path dir,
                                int max,
                                boolean includeDirectories,
                                java.nio.file.PathMatcher pathMatcher)

Returns the file count contained in the specified directory (recursively) to concurrence to specified max count. If the effective count is greater than max count, returns max + 1. This method is designed to stop file traversal as soon as count is greater than max.

relativizeFromWorkingDir

public static java.nio.file.Path relativizeFromWorkingDir(java.nio.file.Path path)

Returns the relative path to working dir of the specified path. Returns the specified path itself, if this one is already relative.

relativizeFromDirIfAbsolute

public static java.nio.file.Path relativizeFromDirIfAbsolute(java.nio.file.Path referent,
                                                             java.nio.file.Path pathToRelativize)

Returns the relative path to working dir of the specified path. Returns the specified path itself, if this one is already relative.

getLastModifiedTime

public static java.util.Optional<java.lang.Long> getLastModifiedTime(java.nio.file.Path path,
                                                                     java.nio.file.LinkOption... options)

size

public static long size(java.nio.file.Path path)

register

public static java.nio.file.WatchKey register(java.nio.file.Path dir,
                                              java.nio.file.WatchService watchService,
                                              java.nio.file.WatchEvent.Kind<?>... watchEventKinds)

moveDir

public static void moveDir(java.nio.file.Path source,
                           java.nio.file.Path target)

Move directory along all its children and subdirectories recursively