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
FileUtilities.FileType	checkFileType(java.io.File file) Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.
FileUtilities.FileType	checkFileType(java.lang.String file) Check the given file for its type, whether it is a regular file, a Windows link or a UNIX symlink.
boolean	checkPermissions(java.io.File fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	checkPermissions(java.nio.file.Path fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	checkPermissions(java.lang.String fileOrDirectory) Check the given file or directory for read- and write-permission.
boolean	checkReadPermission(java.io.File fileOrDirectory) Check the given file or directory for read-permission.
boolean	checkReadPermission(java.nio.file.Path fileOrDirectory) Check the given file or directory for read-permission.
boolean	checkReadPermission(java.lang.String fileOrDirectory) Check the given file or directory for read-permission.
boolean	checkWritePermission(java.io.File fileOrDirectory) Check the given file or directory for write-permission.
boolean	checkWritePermission(java.nio.file.Path fileOrDirectory) Check the given file or directory for write-permission.
boolean	checkWritePermission(java.lang.String fileOrDirectory) Check the given file or directory for write-permission.
void	createDirectories(java.nio.file.Path directory) Create a directory, including any necessary parent directories.
boolean	isLink(java.io.File file) Check if the given file is a UNIX symlink or Windows lnk.
boolean	isLink(java.lang.String file) Check if the given file is a UNIX symlink or Windows lnk.
void	openFile(java.io.File fileToOpen) Open the specified file in an editor.
void	openFile(java.lang.String fileToOpen) Open the specified file in an editor.
void	openFolder(java.io.File folder) Open the specified folder in the file explorer.
void	openFolder(java.lang.String folder) Open the specified folder in the file explorer.
boolean	replaceFile(java.io.File sourceFile, java.io.File destinationFile) Move a file from source to destination, and replace the destination file if it exists.
java.lang.String	resolveLink(java.io.File link) Resolve a given link/symlink to its source.
java.lang.String	resolveLink(java.lang.String link) Resolve a given link/symlink to its source.
void	unzipArchive(java.lang.String zipFile, 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

public FileUtilities()

Method Detail

replaceFile

public boolean replaceFile(java.io.File sourceFile,
                           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:

Boolean. 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(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(java.lang.String zipFile,
                         java.lang.String destinationDirectory)

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

Parameters:

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

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

checkFileType

public FileUtilities.FileType checkFileType(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

public FileUtilities.FileType checkFileType(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(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(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

public java.lang.String resolveLink(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

public java.lang.String resolveLink(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.

checkPermissions

public boolean checkPermissions(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.

checkPermissions

public boolean checkPermissions(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.

checkReadPermission

public boolean checkReadPermission(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.

checkWritePermission

public boolean checkWritePermission(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.

checkPermissions

public boolean checkPermissions(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)

checkReadPermission

public boolean checkReadPermission(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.

checkReadPermission

public boolean checkReadPermission(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.

checkWritePermission

public boolean checkWritePermission(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.

checkWritePermission

public boolean checkWritePermission(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(java.lang.String folder)

Open the specified folder in the file explorer.

Parameters:

folder - The folder to open.

openFolder

public void openFolder(java.io.File folder)

Open the specified folder in the file explorer.

Parameters:

folder - The folder to open.

openFile

public void openFile(java.lang.String fileToOpen)

Open the specified file in an editor.

Parameters:

fileToOpen - The file to open.

openFile

public void openFile(java.io.File fileToOpen)

Open the specified file in an editor.

Parameters:

fileToOpen - The file to open.