org.thales.punch.libraries.utils.api

Class UtilFiles

java.lang.Object

org.thales.punch.libraries.utils.api.UtilFiles

public final class UtilFiles
extends Object

Tools to manipulate Files

Method Summary

Modifier and Type	Method and Description
static Path	createPathInExistingRootFolder(String rootPath, String childFilePath) Create a child file path from a given root with its parent folder recursively, but do not attempt to create the first provided root folder.
static byte[]	createTar(String dirOrFilePath) Create a tar archive in memory and return the corresponding byte array.
static byte[]	createTar(String root, List<Path> files)
static void	deleteIfExists(File file) This is interesting to make your code shorter while compliant with sonar.
static String	getFileExtension(String filename) Return file extension from name or path
static String	getPerDayPath(long ms) Given q long return a file path with year month day.
static String	getPerDayPath(ZonedDateTime zdt) Given a ZonedDateTime returns a suffix like "2019/11/09".
static boolean	isExistingDir(String dir) Check if a local unix filesystem directory exists
static List<String>	listDirectoriesInADirectory(String dirPath) List of the files in a directory and his subdirectories
static void	listFiles(Path path, List<Path> files, boolean withHidden, boolean withSymbolicLink) List of the files in a directory and his subdirectories (without suffix)
static void	listFiles(Path path, List<Path> files, String suffix, boolean withHidden, boolean withSymbolicLink) List of the files in a directory and his subdirectories
static List<String>	listFilesInADirectory(String dirPath) List of the files in a directory
static String	readHjson(String path)
static void	recursiveDelete(Path rootPathToDelete) Recursively delete all directories and files contained in a specified path.
static int	writeToFile(String dirPath, String absFileName, ByteBuffer data) Write some byte buffer to a file.

Methods inherited from class java.lang.Object

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

Method Detail

listFiles

public static void listFiles(Path path,
                             List<Path> files,
                             boolean withHidden,
                             boolean withSymbolicLink)
                      throws IOException

List of the files in a directory and his subdirectories (without suffix)

Parameters:

path - the path

files - found files

withHidden - include hidden files

withSymbolicLink - include symbolic links

Throws:

IOException - if some of the file cannot be read

listFiles

public static void listFiles(Path path,
                             List<Path> files,
                             String suffix,
                             boolean withHidden,
                             boolean withSymbolicLink)
                      throws IOException

List of the files in a directory and his subdirectories

Parameters:

path - directory path

files - list of files

suffix - the suffix to search

withHidden - include or not hidden files

withSymbolicLink - include or not symbolic links

Throws:

IOException - if some of the file cannot be read

listDirectoriesInADirectory

public static List<String> listDirectoriesInADirectory(String dirPath)

List of the files in a directory and his subdirectories

Parameters:

dirPath - directory path

Returns:

list of file path

listFilesInADirectory

public static List<String> listFilesInADirectory(String dirPath)

List of the files in a directory

Parameters:

dirPath - directory path

Returns:

list of file path

createTar

public static byte[] createTar(String dirOrFilePath)
                        throws IOException

Create a tar archive in memory and return the corresponding byte array. Hidden file and Symbolic link are not taken into account.

Parameters:

dirOrFilePath - directory or file path

Returns:

archive as byte array

Throws:

IOException - io exception

createTar

public static byte[] createTar(String root,
                               List<Path> files)
                        throws IOException

Throws:

IOException

recursiveDelete

public static void recursiveDelete(Path rootPathToDelete)
                            throws IOException

Recursively delete all directories and files contained in a specified path.

Note: deletion is not really recursive (method does not call itself), but its uses Files.walk() method, which recursively all directories and files contained in a directory. Next it's important to reverse list order to delete deep files first.

If a file is created during the whole deletion, an IOException will be thrown.

Parameters:

rootPathToDelete - root path containing directories and files to delete

Throws:

IOException - if some of the file could not be deleted

getPerDayPath

public static String getPerDayPath(long ms)

Given q long return a file path with year month day.

Example : UtilFiles.getPath(1573272040575L) returns "2019/11/09".

Parameters:

ms - a long timestamp

Returns:

a day path

getPerDayPath

public static String getPerDayPath(ZonedDateTime zdt)

Given a ZonedDateTime returns a suffix like "2019/11/09".

Parameters:

zdt - a ZonedDateTime

Returns:

a suffix

writeToFile

public static int writeToFile(String dirPath,
                              String absFileName,
                              ByteBuffer data)
                       throws IOException

Write some byte buffer to a file. This variant is handy for archiving because it accepts a folder path (/tmp/archive) and a file path (2019/12/myfile.csv.gz),

Parameters:

dirPath - Path to target directory

absFileName - Full filename

data - Bytes to write

Returns:

the number of bytes written

Throws:

IOException - : Error when writing

isExistingDir

public static boolean isExistingDir(String dir)

Check if a local unix filesystem directory exists

Parameters:

dir - the absolute directory path* @throws IOException if not

Returns:

true or false

createPathInExistingRootFolder

public static Path createPathInExistingRootFolder(String rootPath,
                                                  String childFilePath)
                                           throws IOException

Create a child file path from a given root with its parent folder recursively, but do not attempt to create the first provided root folder.

Parameters:

rootPath - the root absolute path

childFilePath - the child path.

Returns:

the target file path

Throws:

IOException - if the root does not exists or one of the intermediary path is a existing file

deleteIfExists

public static void deleteIfExists(File file)

This is interesting to make your code shorter while compliant with sonar.

Parameters:

file - a file handle

getFileExtension

public static String getFileExtension(String filename)

Return file extension from name or path

Parameters:

filename - file name or path (eg. toto.md, /tmp/test/my_file.txt)

Returns:

the file extension (eg. md, txt, jar ...)

readHjson

public static String readHjson(String path)
                        throws IOException

Parameters:

path - absolute path of a file whose content is either json or hjson valid

Returns:

content of read file

Throws:

IOException