org.webjars

Class WebJarExtractor

java.lang.Object

org.webjars.WebJarExtractor

public class WebJarExtractor
extends java.lang.Object

Utility for extracting WebJars onto the filesystem. The extractor also recognises the node_modules convention used by WebJars. node_modules are a special place within a WebJar that contain the assets required in an environment conforming to the Node API for require.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebJarExtractor.Cache A cache for extracting WebJar assets.
static class	WebJarExtractor.Cacheable
static class	WebJarExtractor.MemoryCache An in memory cache.

Field Summary

Fields

Modifier and Type	Field and Description
static WebJarExtractor.Cache	NO_CACHE
static java.lang.String	PACKAGE_JSON
static java.lang.String	PACKAGE_JSON_NAME The node_modules directory prefix as a convenience.

Constructor Summary

Constructors

Constructor and Description
WebJarExtractor()
WebJarExtractor(java.lang.ClassLoader classLoader)
WebJarExtractor(WebJarExtractor.Cache cache, java.lang.ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	extractAllNodeModulesTo(java.io.File to) Extract the node_modules of all WebJars and merge them into the same folder.
void	extractAllWebJarsTo(java.io.File to) Extract all WebJars.
void	extractWebJarTo(java.lang.String name, java.io.File to) Extract the given WebJar to the given location.

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_JSON_NAME

public static final java.lang.String PACKAGE_JSON_NAME

The node_modules directory prefix as a convenience.

See Also:

Constant Field Values

PACKAGE_JSON

public static final java.lang.String PACKAGE_JSON

See Also:

Constant Field Values

NO_CACHE

public static WebJarExtractor.Cache NO_CACHE

Constructor Detail

WebJarExtractor

public WebJarExtractor()

WebJarExtractor

public WebJarExtractor(java.lang.ClassLoader classLoader)

WebJarExtractor

public WebJarExtractor(WebJarExtractor.Cache cache,
                       java.lang.ClassLoader classLoader)

Method Detail

extractAllWebJarsTo

public void extractAllWebJarsTo(java.io.File to)
                         throws java.io.IOException

Extract all WebJars.

Parameters:

to - The directory to extract to.

Throws:

java.io.IOException - There was a problem extracting the WebJars

extractWebJarTo

public void extractWebJarTo(java.lang.String name,
                            java.io.File to)
                     throws java.io.IOException

Extract the given WebJar to the given location. The WebJar will be extracted, without its version in the path, to the given directory.

Parameters:

name - The name of the WebJar to extract.

to - The location to extract it to. All WebJars will be merged into this location.

Throws:

java.io.IOException - There was a problem extracting the WebJars

extractAllNodeModulesTo

public void extractAllNodeModulesTo(java.io.File to)
                             throws java.io.IOException

Extract the node_modules of all WebJars and merge them into the same folder.

Parameters:

to - The location to extract it to. All WebJars will be merged into this location.

Throws:

java.io.IOException - There was a problem extracting the WebJars