Modifier and Type	Class and Description
public static class	WebJarAssetLocator.WebJarInfo

Modifier and Type	Field and Description
protected final Map<String, WebJarAssetLocator.WebJarInfo>	allWebJars
private static final Pattern	WEBJAR_EXTRACTOR_PATTERN
public static final String	WEBJARS_PACKAGE The webjar package name.
public static final String	WEBJARS_PATH_PREFIX The path to where webjar resources live.

Access	Constructor and Description
public	WebJarAssetLocator()
public	WebJarAssetLocator(final ClassLoader classLoader)
public	WebJarAssetLocator(final String... whitelistPaths)
public	WebJarAssetLocator(final ClassLoader classLoader, final String... whitelistPaths)
public	WebJarAssetLocator(ClassGraph classGraph)
public	WebJarAssetLocator(final Map<String, WebJarAssetLocator.WebJarInfo> allWebJars)

Method Summary

Modifier and Type	Method and Description
private static Optional<MavenProperties>	findMavenInfo(final URI classpathElementURI)
protected static Map<String, WebJarAssetLocator.WebJarInfo>	findWebJars(ScanResult scanResult)
public Map<String, WebJarAssetLocator.WebJarInfo>	getAllWebJars()
public String	Returns: a fully qualified path to the resource. getFullPath(final String the path to return e.g. "jquery.js" or "abc/someother.js". This must be a distinct path within the index passed in (not `null` or empty). partialPath) Given a distinct path within the WebJar index passed in return the full path of the resource.
public String	Returns: a fully qualified path to the resource getFullPath(final String The id of the WebJar to search (not `null` webjar, final String The partial path to look for (not `null` partialPath) Returns the full path of an asset within a specific WebJar
public String	Returns: a fully qualified path to the resource of `null` if WebJar not found getFullPathExact(final String The id of the WebJar to search (must not be `null` webJarName, final String The exact path of the file within the WebJar (may be `null` for legacy reasons) exactPath) Returns the full path of an asset within a specific WebJar
public static Map.Entry<String, String>	Returns: A WebJar tuple (Entry) with key = id and value = version or `null` if not a legal WebJar file format getWebJar(CharSequence The full WebJar path (not `null`) path)
public Map<String, String>	Returns: A map of the WebJars based on the files in the CLASSPATH where the key is the artifactId and the value is the version getWebJars()
public String	Returns: the Group ID for the WebJar or `null` if it can't be determined groupId(final String the fullPath to the asset in a WebJar, i.e. META-INF/resources/webjars/jquery/2.1.0/jquery.js fullPath) Gets the Group ID given a fullPath
private static boolean	isEmpty(String str)
public Set<String>	listAssets()
public Set<String>	Returns: a set of folder paths that match. listAssets(final String the root path to the folder. folderPath) List assets within a folder.
private static Map<String, WebJarAssetLocator.WebJarInfo>	scanForWebJars(ClassGraph classGraph)
private static void	throwMultipleMatchesException(final String partialPath, final List<String> matches)
private static void	throwNotFoundException(final String partialPath)
protected static ResourceList	webJarResources(final String webJarName, final ResourceList resources)
protected static String	webJarVersion(final String webJarName, final ResourceList resources)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allWebJars	back to summary
protected final Map<String, WebJarAssetLocator.WebJarInfo> allWebJars

WEBJAR_EXTRACTOR_PATTERN	back to summary
private static final Pattern WEBJAR_EXTRACTOR_PATTERN

WEBJARS_PACKAGE	back to summary
public static final String WEBJARS_PACKAGE The webjar package name.

WEBJARS_PATH_PREFIX	back to summary
public static final String WEBJARS_PATH_PREFIX The path to where webjar resources live.

Constructor Detail

WebJarAssetLocator	back to summary
public WebJarAssetLocator()

WebJarAssetLocator	back to summary
public WebJarAssetLocator(final ClassLoader classLoader)

WebJarAssetLocator	back to summary
public WebJarAssetLocator(final String... whitelistPaths)

WebJarAssetLocator	back to summary
public WebJarAssetLocator(final ClassLoader classLoader, final String... whitelistPaths)

WebJarAssetLocator	back to summary
public WebJarAssetLocator(ClassGraph classGraph)

WebJarAssetLocator	back to summary
public WebJarAssetLocator(final Map<String, WebJarAssetLocator.WebJarInfo> allWebJars)

Method Detail

findMavenInfo	back to summary
private static Optional<MavenProperties> findMavenInfo(final URI classpathElementURI)

findWebJars	back to summary
protected static Map<String, WebJarAssetLocator.WebJarInfo> findWebJars(ScanResult scanResult) Annotations @Nonnull

getAllWebJars	back to summary
public Map<String, WebJarAssetLocator.WebJarInfo> getAllWebJars()

getFullPath back to summary

getFullPath	back to summary
public String getFullPath(final String partialPath) Given a distinct path within the WebJar index passed in return the full path of the resource. Parameters partialPath:String the path to return e.g. "jquery.js" or "abc/someother.js". This must be a distinct path within the index passed in (not `null` or empty). Returns:String a fully qualified path to the resource. Annotations @Nonnull

public String getFullPath(final String partialPath)

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

Parameters

partialPath:String: the path to return e.g. "jquery.js" or "abc/someother.js". This must be a distinct path within the index passed in (not null or empty).

Returns:String

a fully qualified path to the resource.

Annotations

@Nonnull

getFullPath back to summary

getFullPath	back to summary
public String getFullPath(final String webjar, final String partialPath) Returns the full path of an asset within a specific WebJar Parameters webjar:String The id of the WebJar to search (not `null` partialPath:String The partial path to look for (not `null` Returns:String a fully qualified path to the resource Annotations @Nonnull Exceptions NotFoundException: if webjar or path not found

public String getFullPath(final String webjar, final String partialPath)

Returns the full path of an asset within a specific WebJar

Parameters

webjar:String: The id of the WebJar to search (not null
partialPath:String: The partial path to look for (not null

Returns:String

a fully qualified path to the resource

Annotations

@Nonnull

Exceptions

NotFoundException:: if webjar or path not found

getFullPathExact back to summary

getFullPathExact	back to summary
public String getFullPathExact(final String webJarName, final String exactPath) Returns the full path of an asset within a specific WebJar Parameters webJarName:String The id of the WebJar to search (must not be `null` exactPath:String The exact path of the file within the WebJar (may be `null` for legacy reasons) Returns:String a fully qualified path to the resource of `null` if WebJar not found Annotations @Nullable

public String getFullPathExact(final String webJarName, final String exactPath)

Returns the full path of an asset within a specific WebJar

Parameters

webJarName:String: The id of the WebJar to search (must not be null
exactPath:String: The exact path of the file within the WebJar (may be null for legacy reasons)

Returns:String

a fully qualified path to the resource of null if WebJar not found

Annotations

@Nullable

getWebJar	back to summary
public static Map.Entry<String, String> getWebJar(CharSequence path) Parameters path:CharSequence The full WebJar path (not `null`) Returns:Map.Entry<String, String> A WebJar tuple (Entry) with key = id and value = version or `null` if not a legal WebJar file format Annotations @Nullable

getWebJars	back to summary
public Map<String, String> getWebJars() Returns:Map<String, String> A map of the WebJars based on the files in the CLASSPATH where the key is the artifactId and the value is the version Annotations @Nonnull

groupId back to summary

groupId	back to summary
public String groupId(final String fullPath) Gets the Group ID given a fullPath Parameters fullPath:String the fullPath to the asset in a WebJar, i.e. META-INF/resources/webjars/jquery/2.1.0/jquery.js Returns:String the Group ID for the WebJar or `null` if it can't be determined Annotations @Nullable

public String groupId(final String fullPath)

Gets the Group ID given a fullPath

Parameters

fullPath:String: the fullPath to the asset in a WebJar, i.e. META-INF/resources/webjars/jquery/2.1.0/jquery.js

Returns:String

the Group ID for the WebJar or null if it can't be determined

Annotations

@Nullable

isEmpty	back to summary
private static boolean isEmpty(String str)

listAssets	back to summary
public Set<String> listAssets() Annotations @Nonnull

listAssets	back to summary
public Set<String> listAssets(final String folderPath) List assets within a folder. Parameters folderPath:String the root path to the folder. Returns:Set<String> a set of folder paths that match. Annotations @Nonnull

listAssets

back to summary

public Set<String> listAssets(final String folderPath)

List assets within a folder.

Parameters

folderPath:String: the root path to the folder.

Returns:Set<String>

a set of folder paths that match.

Annotations

@Nonnull

scanForWebJars	back to summary
private static Map<String, WebJarAssetLocator.WebJarInfo> scanForWebJars(ClassGraph classGraph) Annotations @Nonnull

throwMultipleMatchesException	back to summary
private static void throwMultipleMatchesException(final String partialPath, final List<String> matches)

throwNotFoundException	back to summary
private static void throwNotFoundException(final String partialPath)

webJarResources	back to summary
protected static ResourceList webJarResources(final String webJarName, final ResourceList resources) Annotations @Nonnull

webJarVersion	back to summary
protected static String webJarVersion(final String webJarName, final ResourceList resources) Annotations @Nullable

org.webjars back to summary

public Class WebJarAssetLocator.WebJarInfo

Class Inheritance

extends Object

java.lang.Object
org.webjars.WebJarAssetLocator.WebJarInfo

Field Summary

Modifier and Type	Field and Description
pack-priv final String	artifactId
pack-priv final Collection<String>	contents
pack-priv final String	groupId
pack-priv final URI	uri
pack-priv final String	version

Constructor Summary

Access	Constructor and Description
pack-priv	WebJarInfo(final String version, Optional<MavenProperties> mavenProperties, final URI uri, final Collection<String> contents)

Method Summary

Modifier and Type	Method and Description
public String	getArtifactId()
public Collection<String>	Returns: an immutable list of resources. getContents()
public String	getGroupId()
public URI	getUri()
public String	getVersion()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

artifactId	back to summary
pack-priv final String artifactId

contents	back to summary
pack-priv final Collection<String> contents

groupId	back to summary
pack-priv final String groupId

uri	back to summary
pack-priv final URI uri

version	back to summary
pack-priv final String version

Constructor Detail

WebJarInfo	back to summary
pack-priv WebJarInfo(final String version, Optional<MavenProperties> mavenProperties, final URI uri, final Collection<String> contents)

Method Detail

getArtifactId	back to summary
public String getArtifactId() Annotations @Nullable

getContents	back to summary
public Collection<String> getContents() Returns:Collection<String> an immutable list of resources. Annotations @Nonnull

getGroupId	back to summary
public String getGroupId() Annotations @Nullable

getUri	back to summary
public URI getUri()

getVersion	back to summary
public String getVersion() Annotations @Nullable

public Class WebJarAssetLocator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class WebJarAssetLocator.WebJarInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail