Package org.nd4j.common.resources

Class Resources

java.lang.Object

org.nd4j.common.resources.Resources

public class Resources
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Resolver>	resolvers

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Resources()

Method Summary

Modifier and Type	Method	Description
static File	asFile(@NonNull String resourcePath)	Get the specified resource as a local file.
static InputStream	asStream(@NonNull 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(String directoryPath, File destinationDir)
static void	copyDirectory(@NonNull String directoryPath, @NonNull File destinationDir)	Copy the contents of the specified directory (path) to the specified destination directory, resolving any resources in the process
static boolean	exists(@NonNull 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 File	getAsFile(String resourcePath)
InputStream	getAsStream(String resourcePath)
String	normalize(String path)
static String	normalizePath(String path)	Normalize the path that may be a resource reference.
protected boolean	resourceExists(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 List<Resolver> resolvers

Constructor Detail

Resources

protected Resources()

Method Detail

exists

public static boolean exists(@NonNull
                             @NonNull 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 File asFile(@NonNull
                          @NonNull 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 InputStream asStream(@NonNull
                                   @NonNull 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
                                 @NonNull String directoryPath,
                                 @NonNull
                                 @NonNull 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

normalizePath

public static String normalizePath(String path)

Normalize the path that may be a resource reference. For example: "someDir/myFile.zip.resource_reference" --> "someDir/myFile.zip" Returns null if the file cannot be resolved. If the file is not a reference, the original path is returned

resourceExists

protected boolean resourceExists(String resourcePath)

getAsFile

protected File getAsFile(String resourcePath)

getAsStream

public InputStream getAsStream(String resourcePath)

copyDir

public void copyDir(String directoryPath,
                    File destinationDir)

normalize

public String normalize(String path)