Package org.nd4j.common.io

Class ClassPathResource

java.lang.Object

org.nd4j.common.io.AbstractResource

org.nd4j.common.io.AbstractFileResolvingResource

org.nd4j.common.io.ClassPathResource

All Implemented Interfaces:

InputStreamSource, Resource

public class ClassPathResource
extends AbstractFileResolvingResource

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClassPathResource(String path)
	ClassPathResource(String path, Class<?> clazz)
	ClassPathResource(String path, ClassLoader classLoader)
protected	ClassPathResource(String path, ClassLoader classLoader, Class<?> clazz)

Method Summary

Modifier and Type	Method	Description
void	copyDirectory(File destination)	Extract the directory recursively to the specified location.
Resource	createRelative(String relativePath)
boolean	equals(Object obj)
boolean	exists()	Whether the resource exists on the classpath
ClassLoader	getClassLoader()
String	getDescription()
File	getFile()	Get the File.
String	getFilename()
InputStream	getInputStream()
String	getPath()
File	getTempFileFromArchive()	Get a temp file from the classpath. This is for resources where a file is needed and the classpath resource is in a jar file.
File	getTempFileFromArchive(File rootDirectory)	Get a temp file from the classpath, and (optionally) place it in the specified directory Note that: - If the directory is not specified, the file is copied to the default temporary directory, using Files.createTempFile(String, String, FileAttribute[]).
URL	getURL()
int	hashCode()

Methods inherited from class org.nd4j.common.io.AbstractFileResolvingResource

contentLength, getFile, getFileForLastModifiedCheck, isReadable, lastModified

Methods inherited from class org.nd4j.common.io.AbstractResource

getURI, isOpen, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassPathResource

public ClassPathResource(String path)

ClassPathResource

public ClassPathResource(String path,
                         ClassLoader classLoader)

ClassPathResource

public ClassPathResource(String path,
                         Class<?> clazz)

ClassPathResource

protected ClassPathResource(String path,
                            ClassLoader classLoader,
                            Class<?> clazz)

Method Detail

getPath

public final String getPath()

getClassLoader

public final ClassLoader getClassLoader()

getFile

public File getFile()
             throws IOException

Get the File. If the file cannot be accessed directly (for example, it is in a JAR file), we will attempt to extract it from the JAR and copy it to the temporary directory, using getTempFileFromArchive()

Specified by:

getFile in interface Resource

Overrides:

getFile in class AbstractFileResolvingResource

Returns:

The File, or a temporary copy if it can not be accessed directly

Throws:

IOException

getTempFileFromArchive

public File getTempFileFromArchive()
                            throws IOException

Get a temp file from the classpath.
This is for resources where a file is needed and the classpath resource is in a jar file. The file is copied to the default temporary directory, using Files.createTempFile(String, String, FileAttribute[]). Consequently, the extracted file will have a different filename to the extracted one.

Returns:

the temp file

Throws:

IOException - If an error occurs when files are being copied

See Also:

getTempFileFromArchive(File)

getTempFileFromArchive

public File getTempFileFromArchive(File rootDirectory)
                            throws IOException

Get a temp file from the classpath, and (optionally) place it in the specified directory
Note that:
- If the directory is not specified, the file is copied to the default temporary directory, using Files.createTempFile(String, String, FileAttribute[]). Consequently, the extracted file will have a different filename to the extracted one.
- If the directory *is* specified, the file is copied directly - and the original filename is maintained

Parameters:

rootDirectory - May be null. If non-null, copy to the specified directory

Returns:

the temp file

Throws:

IOException - If an error occurs when files are being copied

See Also:

getTempFileFromArchive(File)

copyDirectory

public void copyDirectory(File destination)
                   throws IOException

Extract the directory recursively to the specified location. Current ClassPathResource must point to a directory.
For example, if classpathresource points to "some/dir/", then the contents - not including the parent directory "dir" - will be extracted or copied to the specified destination.

Parameters:

destination - Destination directory. Must exist

Throws:

IOException

exists

public boolean exists()

Description copied from interface: Resource

Whether the resource exists on the classpath

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractFileResolvingResource

Returns:

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface Resource

Overrides:

getURL in class AbstractResource

Returns:

Throws:

IOException

createRelative

public Resource createRelative(String relativePath)

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class AbstractResource

Returns:

getFilename

public String getFilename()

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

Returns:

getDescription

public String getDescription()

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractResource

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResource