de.griefed.serverpackcreator.utilities.common

Class FileUtilities

java.lang.Object

de.griefed.serverpackcreator.utilities.common.FileUtilities

@Component
public final class FileUtilities
extends java.lang.Object

Utility-class revolving around various file-interactions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUtilities.FileType

Constructor Summary

Constructors

Constructor and Description
FileUtilities()

Method Summary

Modifier and Type	Method and Description
@NotNull FileUtilities.FileType	checkFileType(@NotNull java.io.File file) Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.
@NotNull FileUtilities.FileType	checkFileType(@NotNull java.lang.String file) Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.
void	createDirectories(@NotNull java.nio.file.Path directory) Create a directory, including any necessary parent directories.
boolean	isLink(@NotNull java.io.File file) Check if the given file is a UNIX symlink or Windows lnk.
boolean	isLink(@NotNull java.lang.String file) Check if the given file is a UNIX symlink or Windows lnk.
boolean	isReadPermissionSet(@NotNull java.io.File fileOrDirectory) Check the given file or directory for read-permission.
boolean	isReadPermissionSet(@NotNull java.nio.file.Path fileOrDirectory) Check the given file or directory for read-permission.
boolean	isReadPermissionSet(@NotNull java.lang.String fileOrDirectory) Check the given file or directory for read-permission.
boolean	isReadWritePermissionSet(@NotNull java.io.File fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	isReadWritePermissionSet(@NotNull java.nio.file.Path fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	isReadWritePermissionSet(@NotNull java.lang.String fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	isWritePermissionSet(@NotNull java.io.File fileOrDirectory) Check the given file or directory for write-permission.
boolean	isWritePermissionSet(@NotNull java.nio.file.Path fileOrDirectory) Check the given file or directory for write-permission.
boolean	isWritePermissionSet(@NotNull java.lang.String fileOrDirectory) Check the given file or directory for write-permission.
void	openFile(@NotNull java.io.File fileToOpen) Open the specified file in an editor.
void	openFile(@NotNull java.lang.String fileToOpen) Open the specified file in an editor.
void	openFolder(@NotNull java.io.File folder) Open the specified folder in the file explorer.
void	openFolder(@NotNull java.lang.String folder) Open the specified folder in the file explorer.
boolean	replaceFile(@NotNull java.io.File sourceFile, @NotNull java.io.File destinationFile) Move a file from source to destination, and replace the destination file if it exists.
@NotNull java.lang.String	resolveLink(@NotNull java.io.File link) Resolve a given link/symlink to its source.
@NotNull java.lang.String	resolveLink(@NotNull java.lang.String link) Resolve a given link/symlink to its source.
void	unzipArchive(@NotNull java.lang.String zipFile, @NotNull java.lang.String destinationDirectory) Unzips the downloaded modpack ZIP-archive to the specified directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtilities

@Contract(pure=true)
public FileUtilities()

Method Detail

replaceFile

public boolean replaceFile(@NotNull
                           @NotNull java.io.File sourceFile,
                           @NotNull
                           @NotNull java.io.File destinationFile)
                    throws java.io.IOException

Move a file from source to destination, and replace the destination file if it exists.

Parameters:

sourceFile - The source file.

destinationFile - The destination file to be replaced by the source file.

Returns:

Returns true if the file was sucessfully replaced.

Throws:

java.io.IOException - Thrown if an error occurs when the file is moved.

createDirectories

public void createDirectories(@NotNull
                              @NotNull java.nio.file.Path directory)

Create a directory, including any necessary parent directories. If an error is encountered, it is printed to our logs.

Parameters:

directory - The directory to create.

unzipArchive

public void unzipArchive(@NotNull
                         @NotNull java.lang.String zipFile,
                         @NotNull
                         @NotNull java.lang.String destinationDirectory)

Unzips the downloaded modpack ZIP-archive to the specified directory.

Parameters:

zipFile - The path to the ZIP-archive which we want to unzip.

destinationDirectory - The directory into which the ZIP-archive will be unzipped into.

checkFileType

@NotNull
public @NotNull FileUtilities.FileType checkFileType(@NotNull
                                                              @NotNull java.lang.String file)

Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.

Parameters:

file - The file to check

Returns:

The type of the given file. Either FileUtilities.FileType.FILE, FileUtilities.FileType.LINK or FileUtilities.FileType.SYMLINK

checkFileType

@NotNull
public @NotNull FileUtilities.FileType checkFileType(@NotNull
                                                              @NotNull java.io.File file)

Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.

Parameters:

file - The file to check

Returns:

The type of the given file. Either FileUtilities.FileType.FILE, FileUtilities.FileType.LINK or FileUtilities.FileType.SYMLINK

isLink

public boolean isLink(@NotNull
                      @NotNull java.lang.String file)

Check if the given file is a UNIX symlink or Windows lnk.

Parameters:

file - The file to check.

Returns:

true if the given file is a UNIX symlink or Windows lnk.

isLink

public boolean isLink(@NotNull
                      @NotNull java.io.File file)

Check if the given file is a UNIX symlink or Windows lnk.

Parameters:

file - The file to check.

Returns:

true if the given file is a UNIX symlink or Windows lnk.

resolveLink

@NotNull
public @NotNull java.lang.String resolveLink(@NotNull
                                                      @NotNull java.lang.String link)
                                               throws InvalidFileTypeException,
                                                      java.io.IOException

Resolve a given link/symlink to its source.

Parameters:

link - The link you want to resolve.

Returns:

Path to the source of the link. If the specified file is not a link, the path to the passed file is returned.

Throws:

java.io.IOException - if the link could not be parsed.

InvalidFileTypeException - if the specified file is neither a file, lnk nor symlink.

resolveLink

@NotNull
public @NotNull java.lang.String resolveLink(@NotNull
                                                      @NotNull java.io.File link)
                                               throws java.io.IOException,
                                                      InvalidFileTypeException

Resolve a given link/symlink to its source.

Parameters:

link - The link you want to resolve.

Returns:

Path to the source of the link. If the specified file is not a link, the path to the passed file is returned.

Throws:

java.io.IOException - if the link could not be parsed.

InvalidFileTypeException - if the specified file is neither a file, lnk nor symlink.

isReadWritePermissionSet

public boolean isReadWritePermissionSet(@NotNull
                                        @NotNull java.lang.String fileOrDirectory)
                                 throws java.nio.file.InvalidPathException

Check the given file or directory for read- and write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if both read- and write-permissions are set.

Throws:

java.nio.file.InvalidPathException - if the path string cannot be converted to a Path.

isReadWritePermissionSet

public boolean isReadWritePermissionSet(@NotNull
                                        @NotNull java.nio.file.Path fileOrDirectory)

Check the given file or directory for read- and write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if both read- and write-permissions are set.

isReadPermissionSet

public boolean isReadPermissionSet(@NotNull
                                   @NotNull java.nio.file.Path fileOrDirectory)

Check the given file or directory for read-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if read-permissions are set.

isWritePermissionSet

public boolean isWritePermissionSet(@NotNull
                                    @NotNull java.nio.file.Path fileOrDirectory)

Check the given file or directory for write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if write-permissions are set.

isReadWritePermissionSet

public boolean isReadWritePermissionSet(@NotNull
                                        @NotNull java.io.File fileOrDirectory)
                                 throws java.nio.file.InvalidPathException

Check the given file or directory for read- and write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if both read- and write-permissions are set.

Throws:

java.nio.file.InvalidPathException - if a Path object cannot be constructed from the abstract path (see FileSystem.getPath)

isReadPermissionSet

public boolean isReadPermissionSet(@NotNull
                                   @NotNull java.lang.String fileOrDirectory)

Check the given file or directory for read-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if read-permissions are set.

isReadPermissionSet

public boolean isReadPermissionSet(@NotNull
                                   @NotNull java.io.File fileOrDirectory)

Check the given file or directory for read-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if read-permissions are set.

isWritePermissionSet

public boolean isWritePermissionSet(@NotNull
                                    @NotNull java.lang.String fileOrDirectory)

Check the given file or directory for write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if write-permissions are set.

isWritePermissionSet

public boolean isWritePermissionSet(@NotNull
                                    @NotNull java.io.File fileOrDirectory)

Check the given file or directory for write-permission.

Parameters:

fileOrDirectory - File or directory.

Returns:

true if write-permissions are set.

openFolder

public void openFolder(@NotNull
                       @NotNull java.lang.String folder)

Open the specified folder in the file explorer.

Parameters:

folder - The folder to open.

openFolder

public void openFolder(@NotNull
                       @NotNull java.io.File folder)

Open the specified folder in the file explorer.

Parameters:

folder - The folder to open.

openFile

public void openFile(@NotNull
                     @NotNull java.lang.String fileToOpen)

Open the specified file in an editor.

Parameters:

fileToOpen - The file to open.

openFile

public void openFile(@NotNull
                     @NotNull java.io.File fileToOpen)

Open the specified file in an editor.

Parameters:

fileToOpen - The file to open.