org.nd4j.resources

Class Resources

java.lang.Object

org.nd4j.resources.Resources

public class Resources
extends java.lang.Object

API for accessing resources (usually test resources) from a path. For example, depending on the implementation (underlying set of instances this class cas be used to resolve files on the classpath, or reference files (referring to a remote file that needs to be downloaded).
By default only the StrumpfResolver is used, but others can be added using the Java ServiceLoader mechanism for Resolver class.

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Resolver>	resolvers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resources()

Method Summary

Modifier and Type	Method and Description
static java.io.File	asFile(java.lang.String resourcePath) Get the specified resource as a local file.
static java.io.InputStream	asStream(java.lang.String resourcePath) Get the specified resource as an input stream. If it cannot be found (i.e., exists(String) returns false) this method will throw an exception.
void	copyDir(java.lang.String directoryPath, java.io.File destinationDir)
static void	copyDirectory(java.lang.String directoryPath, java.io.File destinationDir) Copy the contents of the specified directory (path) to the specified destination directory, resolving any resources in the process
static boolean	exists(java.lang.String resourcePath) Check if the specified resource exists (can be resolved by any method) hence can be loaded by asFile(String) or asStream(String)
protected java.io.File	getAsFile(java.lang.String resourcePath)
java.io.InputStream	getAsStream(java.lang.String resourcePath)
protected boolean	resourceExists(java.lang.String resourcePath)

Methods inherited from class java.lang.Object

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

Field Detail

resolvers

protected final java.util.List<Resolver> resolvers

Constructor Detail

Resources

protected Resources()

Method Detail

exists

public static boolean exists(@NonNull
                             java.lang.String resourcePath)

Check if the specified resource exists (can be resolved by any method) hence can be loaded by asFile(String) or asStream(String)

Parameters:

resourcePath - Path of the resource to be resolved

Returns:

Whether the resource can be resolved or not

asFile

public static java.io.File asFile(@NonNull
                                  java.lang.String resourcePath)

Get the specified resource as a local file. If it cannot be found (i.e., exists(String) returns false) this method will throw an exception.

Parameters:

resourcePath - Path of the resource to get

Returns:

Resource file

asStream

public static java.io.InputStream asStream(@NonNull
                                           java.lang.String resourcePath)

Get the specified resource as an input stream.
If it cannot be found (i.e., exists(String) returns false) this method will throw an exception.

Parameters:

resourcePath - Path of the resource to get

Returns:

Resource stream

copyDirectory

public static void copyDirectory(@NonNull
                                 java.lang.String directoryPath,
                                 @NonNull
                                 java.io.File destinationDir)

Copy the contents of the specified directory (path) to the specified destination directory, resolving any resources in the process

Parameters:

directoryPath - Directory to copy contents of

destinationDir - Destination

resourceExists

protected boolean resourceExists(java.lang.String resourcePath)

getAsFile

protected java.io.File getAsFile(java.lang.String resourcePath)

getAsStream

public java.io.InputStream getAsStream(java.lang.String resourcePath)

copyDir

public void copyDir(java.lang.String directoryPath,
                    java.io.File destinationDir)