de.agilecoders.wicket.webjars

Class WebJarAssetLocator

java.lang.Object

de.agilecoders.wicket.webjars.WebJarAssetLocator

public class WebJarAssetLocator
extends Object

Locate WebJar assets. The class is thread safe.

Constructor Summary

Constructors

Constructor and Description
WebJarAssetLocator(IWebjarsSettings settings) Convenience constructor that will form a locator for all resources on the current class path.
WebJarAssetLocator(IWebjarsSettings settings, SortedMap<String,String> fullPathIndex) Establish a locator given an index that it should use.

Method Summary

Methods

Modifier and Type	Method and Description
SortedMap<String,String>	createFullPathIndex(Pattern filterExpr, ClassLoader... classLoaders) Return a map that can be used to perform index lookups of partial file paths.
String	getFullPath(String partialPath) Given a distinct path within the WebJar index passed in return the full path of the resource.
SortedMap<String,String>	getFullPathIndex()
Set<String>	listAssets(String folderPath) List assets within a folder.
static String	prependWebjarsPathIfMissing(String path) prepends the webjars path if missing
String	recentVersionOf(String partialPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebJarAssetLocator

public WebJarAssetLocator(IWebjarsSettings settings)

Convenience constructor that will form a locator for all resources on the current class path.

WebJarAssetLocator

public WebJarAssetLocator(IWebjarsSettings settings,
                  SortedMap<String,String> fullPathIndex)

Establish a locator given an index that it should use.

Parameters:

fullPathIndex - the index to use.

Method Detail

recentVersionOf

public String recentVersionOf(String partialPath)

prependWebjarsPathIfMissing

public static String prependWebjarsPathIfMissing(String path)

prepends the webjars path if missing

Parameters:

path - the file name to check

Returns:

file name that starts with "/webjars/"

getFullPath

public String getFullPath(String partialPath)

Given a distinct path within the WebJar index passed in return the full path of the resource.

Parameters:

partialPath - the path to return e.g. "jquery.js" or "abc/someother.js". This must be a distinct path within the index passed in.

Returns:

a fully qualified path to the resource.

getFullPathIndex

public SortedMap<String,String> getFullPathIndex()

listAssets

public Set<String> listAssets(String folderPath)

List assets within a folder.

Parameters:

folderPath - the root path to the folder. Must begin with '/'.

Returns:

a set of folder paths that match.

createFullPathIndex

public SortedMap<String,String> createFullPathIndex(Pattern filterExpr,
                                           ClassLoader... classLoaders)

Return a map that can be used to perform index lookups of partial file paths. This index constitutes a key that is the reverse form of the path it relates to. Thus if a partial lookup needs to be performed from the rightmost path components then the key to access can be expressed easily e.g. the path "a/b" would be the map tuple "b/a" -> "a/b". If we need to look for an asset named "a" without knowing the full path then we can perform a partial lookup on the sorted map.

Parameters:

filterExpr - the regular expression to be used to filter resources that will be included in the index.

classLoaders - the class loaders to be considered for loading the resources from.

Returns:

the index.