sirius.kernel.commons

Class Files

java.lang.Object

sirius.kernel.commons.Files

public class Files
extends Object

Helperclass for handling files in Java 8.

Method Summary

Modifier and Type	Method and Description
static void	delete(File file) If the given file is not null and exists, tries to delete that file and logs when a file cannot be deleted.
static void	delete(Path directory) Deletes the given directory structure including all sub directories.
static String	getBasepath(String path) Returns the basepath of the given path to a file.
static String	getFileExtension(String path) Returns the file extension of the given path or filename.
static String	getFilenameAndExtension(String path) Returns the filename with the file extension of the given path.
static String	getFilenameWithoutExtension(String path) Returns the filename without its file extension.
static void	removeChildren(Path directory) Removes all children (files and directories) of the given directory.
static Optional<String>	toSaneFileName(String input) Converts the given string to a valid and sane filename.

Methods inherited from class java.lang.Object

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

Method Detail

toSaneFileName

@Nonnull
public static Optional<String> toSaneFileName(@Nullable
                                                       String input)

Converts the given string to a valid and sane filename.

The result will only consist of letters, digits '-' and '_'. Everything else will be replaced by a '_'. German umlauts like 'ä', 'ö', 'ü' are replaced the appropriate ASCII sequences.

Parameters:

input - the filename to fix

Returns:

the transformed filename wrapped as Optional or an empty Optional if the filename is not filled

getFileExtension

@Nullable
public static String getFileExtension(@Nullable
                                                String path)

Returns the file extension of the given path or filename.

A path could be /dir/foo/test.txt, a filename would be test.txt.

Parameters:

path - the path to parse

Returns:

the file extension (txt for test.txt) without the leading dot. Returns null if the input is empty or does not contain a file extension. The a file contains several extensions, like .txt.zip, only the last is returned.

getBasepath

@Nullable
public static String getBasepath(@Nullable
                                           String path)

Returns the basepath of the given path to a file.

The basepath is everything but the filename of the given path. So /foo/bar/test.txt will yield /foo/bar as as path. text.txt will yield null.

Note that both / and \ are accepted as path separators and are preserved in the output.

Parameters:

path - the path to a file to parse

Returns:

the path part of the given path, which is everything but the last separator and the filename. Returns null if the given path is empty or does not contain a path.

getFilenameAndExtension

@Nullable
public static String getFilenameAndExtension(@Nullable
                                                       String path)

Returns the filename with the file extension of the given path.

The filename is everything after the last separator (/ or \). If the given path does not contain a separator, the whole path will be returned.

Parameters:

path - the path to a file to parse

Returns:

the filename without the path to it. Returns null if the input is empty or null.

getFilenameWithoutExtension

@Nullable
public static String getFilenameWithoutExtension(@Nullable
                                                           String path)

Returns the filename without its file extension.

The file extension is everything after the last . in the filename.

Parameters:

path - the path to a file to parse

Returns:

the filename without extension or null if the given path is empty, null or does not have a filename (ends with a sepratator).

delete

public static void delete(@Nullable
                          File file)

If the given file is not null and exists, tries to delete that file and logs when a file cannot be deleted. T his is useful for error reporting and to diagnose why a file cannot be deleted.

Parameters:

file - the file to delete

delete

public static void delete(Path directory)
                   throws IOException

Deletes the given directory structure including all sub directories.

Parameters:

directory - the directory to delete (along with all sub directories)

Throws:

IOException - in case of an io error while deleting the files and directories

removeChildren

public static void removeChildren(Path directory)
                           throws IOException

Removes all children (files and directories) of the given directory.

Parameters:

directory - the containing the children to delete (along with all sub directories)

Throws:

IOException - in case of an io error while deleting the files and directories