com.goterl.resourceloader

Class ResourceLoader

java.lang.Object

com.goterl.resourceloader.ResourceLoader

Direct Known Subclasses:

FileLoader, SharedLibraryLoader

public class ResourceLoader
extends java.lang.Object

Loads resources from a relative or absolute path even if the file is in a JAR.

Method Summary

Modifier and Type	Method and Description
java.io.File	copyToTempDirectory(java.lang.String relativePath, java.lang.Class outsideClass) Copies a file into a temporary directory regardless of if it is in a JAR or not.
static java.io.File	createMainTempDirectory() Creates the main temporary directory for resource-loader.
java.io.File	extractFromWithinAJarFile(java.net.URL jarPath, java.io.File mainTempDir, java.lang.String relativePath)
static java.net.URL	getThePathToTheJarWeAreIn(java.lang.Class<?> c) Gets the base location of the given class.
protected boolean	isPosixCompliant() Is the system we're running on Posix compliant?
void	requestDeletion(java.io.File file) Mark the file or directory as "to be deleted".
java.io.File	setPermissions(java.io.File file) Sets permissions on a file or directory.
java.io.File	setPermissions(java.io.File file, java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions) Sets a file or directory's permissions.
static java.io.File	urlToFile(java.lang.String url) Converts the given URL string to its corresponding File.
static java.io.File	urlToFile(java.net.URL url) Converts the given URL to its corresponding File.

Methods inherited from class java.lang.Object

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

Method Detail

copyToTempDirectory

public java.io.File copyToTempDirectory(java.lang.String relativePath,
                                        java.lang.Class outsideClass)
                                 throws java.io.IOException,
                                        java.net.URISyntaxException

Copies a file into a temporary directory regardless of if it is in a JAR or not.

Parameters:

relativePath - A relative path to a file or directory relative to the resources folder.

Returns:

The file or directory you want to load.

Throws:

java.io.IOException - If at any point processing of the resource file fails.

java.net.URISyntaxException - If cannot find the resource file.

extractFromWithinAJarFile

public java.io.File extractFromWithinAJarFile(java.net.URL jarPath,
                                              java.io.File mainTempDir,
                                              java.lang.String relativePath)
                                       throws java.io.IOException,
                                              java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

createMainTempDirectory

public static java.io.File createMainTempDirectory()
                                            throws java.io.IOException

Creates the main temporary directory for resource-loader.

Returns:

A directory that you can store temporary resources in

Throws:

java.io.IOException - Could not create a temporary directory

setPermissions

public java.io.File setPermissions(java.io.File file)
                            throws java.io.IOException

Sets permissions on a file or directory. This allows all users to read, write and execute.

Parameters:

file - A file to set global permissions on

Returns:

The file with the global permissions set

Throws:

java.io.IOException - Could not set permissions

See Also:

setPermissions(File, Set)

setPermissions

public java.io.File setPermissions(java.io.File file,
                                   java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions)
                            throws java.io.IOException

Sets a file or directory's permissions. @{code filePermissions} can be null, in that case then global read, wrote and execute permissions will be set, so use with caution.

Parameters:

file - The file to set new permissions on.

filePermissions - New permissions.

Returns:

The file with correct permissions set.

Throws:

java.io.IOException

requestDeletion

public void requestDeletion(java.io.File file)

Mark the file or directory as "to be deleted".

Parameters:

file - The file or directory to be deleted.

isPosixCompliant

protected boolean isPosixCompliant()

Is the system we're running on Posix compliant?

Returns:

True if posix compliant.

getThePathToTheJarWeAreIn

public static java.net.URL getThePathToTheJarWeAreIn(java.lang.Class<?> c)

Gets the base location of the given class. From SciJava class.

If the class is directly on the file system (e.g., "/path/to/my/package/MyClass.class") then it will return the base directory (e.g., "file:/path/to").

If the class is within a JAR file (e.g., "/path/to/my-jar.jar!/my/package/MyClass.class") then it will return the path to the JAR (e.g., "file:/path/to/my-jar.jar").

Parameters:

c - The class whose location is desired.

urlToFile

public static java.io.File urlToFile(java.net.URL url)

Converts the given URL to its corresponding File. From SciJava class.

This method is similar to calling new File(url.toURI()) except that it also handles "jar:file:" URLs, returning the path to the JAR file.

Parameters:

url - The URL to convert.

Returns:

A file path suitable for use with e.g. FileInputStream

Throws:

java.lang.IllegalArgumentException - if the URL does not correspond to a file.

urlToFile

public static java.io.File urlToFile(java.lang.String url)

Converts the given URL string to its corresponding File. From SciJava class.

Parameters:

url - The URL to convert.

Returns:

A file path suitable for use with e.g. FileInputStream

Throws:

java.lang.IllegalArgumentException - if the URL does not correspond to a file.