org.webjars

Class WebJarExtractor

java.lang.Object

org.webjars.WebJarExtractor

public class WebJarExtractor
extends 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOWER_JSON The bower.json file name.
static String	PACKAGE_JSON The node_modules directory prefix as a convenience.

Constructor Summary

Constructors

Constructor and Description
WebJarExtractor()
WebJarExtractor(ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	extractAllBowerComponentsTo(File to) Extract the bower_components of all WebJars and merge them into the same folder.
void	extractAllNodeModulesTo(File to) Extract the node_modules of all WebJars and merge them into the same folder.
void	extractAllWebJarsTo(File to) Extract all WebJars.
void	extractWebJarTo(String name, File to) Extract the given WebJar to the given location.
protected static String	getJsonModuleId(String packageJson)

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_JSON

public static final String PACKAGE_JSON

The node_modules directory prefix as a convenience.

See Also:

Constant Field Values

BOWER_JSON

public static final String BOWER_JSON

The bower.json file name.

See Also:

Constant Field Values

Constructor Detail

WebJarExtractor

public WebJarExtractor()

WebJarExtractor

public WebJarExtractor(@Nonnull
                       ClassLoader classLoader)

Method Detail

extractAllWebJarsTo

public void extractAllWebJarsTo(@Nullable
                                File to)
                         throws IOException

Extract all WebJars.

Parameters:

to - The directory to extract to

Throws:

IOException - There was a problem extracting the WebJars

extractWebJarTo

public void extractWebJarTo(@Nullable
                            String name,
                            @Nullable
                            File to)
                     throws 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:

IOException - There was a problem extracting the WebJars

extractAllNodeModulesTo

public void extractAllNodeModulesTo(@Nullable
                                    File to)
                             throws 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:

IOException - There was a problem extracting the WebJars

extractAllBowerComponentsTo

public void extractAllBowerComponentsTo(@Nullable
                                        File to)
                                 throws IOException

Extract the bower_components 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:

IOException - There was a problem extracting the WebJars

getJsonModuleId

@Nullable
protected static String getJsonModuleId(@Nonnull
                                                  String packageJson)
                                           throws IOException

Throws:

IOException