uk.ac.liv.pgb.analytica.lib.wrappedr

Class FileSystem

java.lang.Object

uk.ac.liv.pgb.analytica.lib.wrappedr.FileSystem

public final class FileSystem
extends Object

Utility class to help to find files/executables and to manipulate environments.

Author:

sperkins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystem.SystemType The system type.

Method Summary

Modifier and Type	Method and Description
static boolean	addFolderToPathForJavaSession(File folder) Add a folder to the path variable for the session, in a few places.
static boolean	addFolderToPathPermanent(File folder) Add a folder to the permanent path variable.
static boolean	deleteRecursive(File path) Recursively deletes the path represented by the given file..
static File	findExecutionCommand(String command) Finds a executable/command from its name.
static File	findExecutionCommand(String command, Iterable<File> locationHints) Finds a executable/command from its name, given some location hints.
static File	findFile(String fileName, File rootDirectory) Finds a file from its name in the given directories..
static File	findFile(String fileName, File rootDirectory, boolean skipSystemLocationCheck, boolean isDirectory) Finds a file from its name in the given directories..
static FileSystem.SystemType	getSystemType() Gets the system type.
static boolean	setEnvironmentVariableForJavaSession(String name, String value) Set an environment variable for the session.
static boolean	setEnvironmentVariablePermanent(String name, String value) Set an environment variable permanently.

Methods inherited from class java.lang.Object

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

Method Detail

deleteRecursive

public static boolean deleteRecursive(File path)
                               throws FileNotFoundException

Recursively deletes the path represented by the given file..

Parameters:

path - The path represented by a file.

Returns:

True if the path is successfully deleted.

Throws:

FileNotFoundException - Thrown if the path does not exist.

findExecutionCommand

public static File findExecutionCommand(String command)

Finds a executable/command from its name.

Parameters:

command - Executable/command name.

Returns:

The command/executable represented by a file.

findExecutionCommand

public static File findExecutionCommand(String command,
                                        Iterable<File> locationHints)

Finds a executable/command from its name, given some location hints.

Parameters:

command - Executable/command name.

locationHints - Hints to the location of the command/executable.

Returns:

The command/executable represented by a file.

findFile

public static File findFile(String fileName,
                            File rootDirectory)

Finds a file from its name in the given directories..

Parameters:

fileName - The file name.

rootDirectory - The directory in which to look for the file.

Returns:

The found file.

findFile

public static File findFile(String fileName,
                            File rootDirectory,
                            boolean skipSystemLocationCheck,
                            boolean isDirectory)

Finds a file from its name in the given directories..

Parameters:

fileName - The file name.

rootDirectory - The directory in which to look for the file.

skipSystemLocationCheck - Whether to skip looking in system locations.

isDirectory - Whether the file we are looking for is in fact a directory.

Returns:

The found file.

addFolderToPathPermanent

public static boolean addFolderToPathPermanent(File folder)

Add a folder to the permanent path variable.

Parameters:

folder - Folder to add to the path permanently.

Returns:

True if there was no error setting the path.

addFolderToPathForJavaSession

public static boolean addFolderToPathForJavaSession(File folder)

Add a folder to the path variable for the session, in a few places.

Parameters:

folder - Folder to add to the path for the session.

Returns:

True if there was no error setting the path.

setEnvironmentVariablePermanent

public static boolean setEnvironmentVariablePermanent(String name,
                                                      String value)

Set an environment variable permanently. If running in administrator mode, a system-level variable will be set, otherwise a a user-level variable.

Parameters:

name - The environment variable name.

value - The environment variable value.

Returns:

True if there was no error setting the environment variable.

setEnvironmentVariableForJavaSession

public static boolean setEnvironmentVariableForJavaSession(String name,
                                                           String value)

Set an environment variable for the session.

Parameters:

name - The environment variable name.

value - The environment variable value.

Returns:

True if there was no error setting the environment variable.

getSystemType

public static FileSystem.SystemType getSystemType()

Gets the system type.

Returns:

The system type.