org.nd4j.common.resources.strumpf

Class StrumpfResolver

java.lang.Object

org.nd4j.common.resources.strumpf.StrumpfResolver

All Implemented Interfaces:

Resolver

public class StrumpfResolver
extends Object
implements Resolver

Field Summary

Fields

Modifier and Type	Field and Description
protected File	cacheDir
static String	DEFAULT_CACHE_DIR
protected List<String>	localResourceDirs
static String	REF

Constructor Summary

Constructors

Constructor and Description
StrumpfResolver()

Method Summary

Modifier and Type	Method and Description
File	asFile(String resourcePath) Get the specified resources as a standard local file.
protected void	assertExists(String resourcePath)
InputStream	asStream(String resourcePath) Get the specified resources as an input stream.
void	copyDirectory(String dirPath, File destinationDir) Copy the directory resource (recursively) to the specified destination directory
boolean	directoryExists(String dirPath) Determine if the specified directory resource can be resolved by Resolver.copyDirectory(String, File)
boolean	exists(@NonNull String resourcePath) Determine if the specified file resource can be resolved by Resolver.asFile(String) and Resolver.asStream(String)
boolean	hasLocalCache()
File	localCacheRoot()
String	normalizePath(@NonNull String path) Normalize the path that may be a resource reference.
int	priority() Priority of this resolver.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_DIR

public static final String DEFAULT_CACHE_DIR

REF

public static final String REF

See Also:

Constant Field Values

localResourceDirs

protected final List<String> localResourceDirs

cacheDir

protected final File cacheDir

Constructor Detail

StrumpfResolver

public StrumpfResolver()

Method Detail

priority

public int priority()

Description copied from interface: Resolver

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

Specified by:

priority in interface Resolver

exists

public boolean exists(@NonNull
                      @NonNull String resourcePath)

Description copied from interface: Resolver

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

Specified by:

exists in interface Resolver

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

public boolean directoryExists(String dirPath)

Description copied from interface: Resolver

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

Specified by:

directoryExists in interface Resolver

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

public File asFile(String resourcePath)

Description copied from interface: Resolver

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

Specified by:

asFile in interface Resolver

Parameters:

resourcePath - Path of the resource.

Returns:

The local file version of the resource

asStream

public InputStream asStream(String resourcePath)

Description copied from interface: Resolver

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

Specified by:

asStream in interface Resolver

Parameters:

resourcePath - Path of the resource.

Returns:

The resource as an input stream

copyDirectory

public void copyDirectory(String dirPath,
                          File destinationDir)

Description copied from interface: Resolver

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

Specified by:

copyDirectory in interface Resolver

Parameters:

dirPath - Path of the resource directory to resolve

destinationDir - Where the files should be copied to

hasLocalCache

public boolean hasLocalCache()

Specified by:

hasLocalCache in interface Resolver

Returns:

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

localCacheRoot

public File localCacheRoot()

Specified by:

localCacheRoot in interface Resolver

Returns:

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

normalizePath

public String normalizePath(@NonNull
                            @NonNull String path)

Description copied from interface: Resolver

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

Specified by:

normalizePath in interface Resolver

assertExists

protected void assertExists(String resourcePath)