org.nd4j.resources

Interface Resolver

All Known Implementing Classes:

StrumpfResolver

public interface Resolver

Resolver interface: used to resolve a path (or directory path) to an actual file. This is mainly used to find test resources which need to be downloaded on-demand from a remote location, and (if appropriate) cached locally.

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
java.io.File	asFile(java.lang.String resourcePath) Get the specified resources as a standard local file.
java.io.InputStream	asStream(java.lang.String resourcePath) Get the specified resources as an input stream.
void	copyDirectory(java.lang.String dirPath, java.io.File destinationDir) Copy the directory resource (recursively) to the specified destination directory
boolean	directoryExists(java.lang.String dirPath) Determine if the specified directory resource can be resolved by copyDirectory(String, File)
boolean	exists(java.lang.String resourcePath) Determine if the specified file resource can be resolved by asFile(String) and asStream(String)
boolean	hasLocalCache()
java.io.File	localCacheRoot()
int	priority() Priority of this resolver.

Method Detail

priority

int priority()

Priority of this resolver. 0 is highest priority (check first), larger values are lower priority (check last)

exists

boolean exists(java.lang.String resourcePath)

Determine if the specified file resource can be resolved by asFile(String) and asStream(String)

Parameters:

resourcePath - Path of the resource to be resolved

Returns:

True if this resolver is able to resolve the resource file - i.e., whether it is a valid path and exists

directoryExists

boolean directoryExists(java.lang.String dirPath)

Determine if the specified directory resource can be resolved by copyDirectory(String, File)

Parameters:

dirPath - Path of the directory resource to be resolved

Returns:

True if this resolver is able to resolve the directory - i.e., whether it is a valid path and exists

asFile

java.io.File asFile(java.lang.String resourcePath)

Get the specified resources as a standard local file. Note that the resource must exist as determined by exists(String)

Parameters:

resourcePath - Path of the resource.

Returns:

The local file version of the resource

asStream

java.io.InputStream asStream(java.lang.String resourcePath)

Get the specified resources as an input stream. Note that the resource must exist as determined by exists(String)

Parameters:

resourcePath - Path of the resource.

Returns:

The resource as an input stream

copyDirectory

void copyDirectory(java.lang.String dirPath,
                   java.io.File destinationDir)

Copy the directory resource (recursively) to the specified destination directory

Parameters:

dirPath - Path of the resource directory to resolve

destinationDir - Where the files should be copied to

hasLocalCache

boolean hasLocalCache()

Returns:

True if the resolver has a local cache directory, as returned by localCacheRoot()

localCacheRoot

java.io.File localCacheRoot()

Returns:

Root directory of the local cache, or null if hasLocalCache() returns false