com.jme3.asset.plugins

Class ClasspathLocator

java.lang.Object

com.jme3.asset.plugins.ClasspathLocator

All Implemented Interfaces:

AssetLocator

public class ClasspathLocator
extends java.lang.Object
implements AssetLocator

The ClasspathLocator looks up an asset in the classpath. This locator is used by default in all jME3 projects (unless unregistered ). Unlike Java's default resource loading mechanism, the ClasspathLocator enforces case-sensitivity on platforms which do not have it such as Windows. Therefore, it is critical to provide a path matching the case of the file on the filesystem. This also ensures that the file can be loaded if it was later included in a .JAR file instead of a folder.

Constructor Summary

Constructors

Constructor and Description
ClasspathLocator()

Method Summary

Modifier and Type	Method and Description
AssetInfo	locate(AssetManager manager, AssetKey key) Request to locate an asset.
void	setRootPath(java.lang.String rootPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathLocator

public ClasspathLocator()

Method Detail

setRootPath

public void setRootPath(java.lang.String rootPath)

Specified by:

setRootPath in interface AssetLocator

Parameters:

rootPath - The root path where to look for assets. Typically this method will only be called once per instance of an asset locator.

locate

public AssetInfo locate(AssetManager manager,
                        AssetKey key)

Description copied from interface: AssetLocator

Request to locate an asset. The asset key contains a name identifying the asset. If an asset was not found, null should be returned. The AssetInfo implementation provided should have a proper return value for its AssetInfo.openStream() method.

Specified by:

locate in interface AssetLocator

Parameters:

manager - for managing assets

key - identifies the asset to be located

Returns:

The AssetInfo that was located, or null if not found.