ml.comet.experiment.impl.utils

Class FileUtils

java.lang.Object

ml.comet.experiment.impl.utils.FileUtils

public class FileUtils
extends Object

Provides common file system utilities.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static Path	assetFilePath(@NonNull Path assetDir, @NonNull Path assetFile) Allows building path to the asset file.
static boolean	fileContentsEquals(@NonNull Path assetFile, @NonNull Path otherPath) Allows checking if content of asset file is equal to the content of the specified file.
static Stream<Path>	listFiles(File folder, boolean recursive) Lists files under given folder.
static Optional<Path>	resolveAssetPath(@NonNull Path dir, @NonNull Path file, @NonNull AssetOverwriteStrategy overwriteStrategy) Allows resolving of the path to the asset file based on provided parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtils

public FileUtils()

Method Detail

listFiles

public static Stream<Path> listFiles(File folder,
                                     boolean recursive)
                              throws IOException

Lists files under given folder.

Parameters:

folder - the folder to list files in.

recursive - if true then subfolder files will be included recursively.

Returns:

the list of files under given directory.

Throws:

IOException - if an I/O exception occurs.

resolveAssetPath

public static Optional<Path> resolveAssetPath(@NonNull
                                              @NonNull Path dir,
                                              @NonNull
                                              @NonNull Path file,
                                              @NonNull
                                              @NonNull AssetOverwriteStrategy overwriteStrategy)
                                       throws FileAlreadyExistsException,
                                              IOException

Allows resolving of the path to the asset file based on provided parameters. As a result of this method invocation the missing parent directories can be created.

Parameters:

dir - the path to the parent directory of the asset file.

file - the relative path to the asset file within dir.

overwriteStrategy - the overwrite strategy to be applied in case file already exists.

Returns:

the optional path to the asset file in the file system or empty if asset file already exists and must be preserved.

Throws:

IOException - if an I/O exception occurred.

FileAlreadyExistsException - if overwriteStrategy is to FAIL when file already exists.

fileContentsEquals

public static boolean fileContentsEquals(@NonNull
                                         @NonNull Path assetFile,
                                         @NonNull
                                         @NonNull Path otherPath)
                                  throws IOException

Allows checking if content of asset file is equal to the content of the specified file.

Parameters:

assetFile - the relative path to the asset file

otherPath - the path to the other file

Returns:

true if contents of both files are equal.

Throws:

IOException - thrown if any I/O exception occured during the operation.

assetFilePath

public static Path assetFilePath(@NonNull
                                 @NonNull Path assetDir,
                                 @NonNull
                                 @NonNull Path assetFile)

Allows building path to the asset file.

Parameters:

assetDir - the parent directory of the asset file

assetFile - the relative path to the asset file

Returns:

the Path to the asset file.