org.webjars

Class RequireJS

java.lang.Object

org.webjars.RequireJS

public final class RequireJS
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	WEBJARS_MAVEN_PREFIX

Constructor Summary

Constructors

Constructor and Description
RequireJS()

Method Summary

Modifier and Type	Method and Description
static String	generateSetupJavaScript(List<String> prefixes) Returns the JavaScript that is used to setup the RequireJS config.
static String	generateSetupJavaScript(List<String> prefixes, Map<String,String> webJars) Deprecated.
static Map<String,com.fasterxml.jackson.databind.node.ObjectNode>	generateSetupJson(List<Map.Entry<String,Boolean>> prefixes) Returns the JSON used to setup the RequireJS config for each WebJar in the CLASSPATH.
static com.fasterxml.jackson.databind.node.ObjectNode	getBowerWebJarRequireJsConfig(Map.Entry<String,String> webJar, List<Map.Entry<String,Boolean>> prefixes) Returns the JSON RequireJS config for a given Bower WebJar
static com.fasterxml.jackson.databind.node.ObjectNode	getNpmWebJarRequireJsConfig(Map.Entry<String,String> webJar, List<Map.Entry<String,Boolean>> prefixes) Returns the JSON RequireJS config for a given Bower WebJar
static String	getRawWebJarRequireJsConfig(Map.Entry<String,String> webJar)
static String	getSetupJavaScript(String urlPrefix) Returns the JavaScript that is used to setup the RequireJS config.
static String	getSetupJavaScript(String cdnPrefix, String urlPrefix) Returns the JavaScript that is used to setup the RequireJS config.
static Map<String,com.fasterxml.jackson.databind.node.ObjectNode>	getSetupJson(String urlPrefix) Returns the JSON that is used to setup the RequireJS config.
static Map<String,com.fasterxml.jackson.databind.node.ObjectNode>	getSetupJson(String cdnPrefix, String urlPrefix) Returns the JSON that is used to setup the RequireJS config.
static String	getWebJarConfig(Map.Entry<String,String> webJar) Deprecated.
static com.fasterxml.jackson.databind.node.ObjectNode	getWebJarRequireJsConfig(Map.Entry<String,String> webJar, List<Map.Entry<String,Boolean>> prefixes) Returns the JSON RequireJS config for a given WebJar

Methods inherited from class java.lang.Object

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

Field Detail

WEBJARS_MAVEN_PREFIX

public static final String WEBJARS_MAVEN_PREFIX

See Also:

Constant Field Values

Constructor Detail

RequireJS

public RequireJS()

Method Detail

getSetupJavaScript

public static String getSetupJavaScript(String urlPrefix)

Returns the JavaScript that is used to setup the RequireJS config. This value is cached in memory so that all of the processing to get the String only has to happen once.

Parameters:

urlPrefix - The URL prefix where the WebJars can be downloaded from with a trailing slash, e.g. /webJars/

Returns:

The JavaScript block that can be embedded or loaded in a <script> tag

getSetupJavaScript

public static String getSetupJavaScript(String cdnPrefix,
                                        String urlPrefix)

Returns the JavaScript that is used to setup the RequireJS config. This value is cached in memory so that all of the processing to get the String only has to happen once.

Parameters:

urlPrefix - The URL prefix where the WebJars can be downloaded from with a trailing slash, e.g. /webJars/

cdnPrefix - The optional CDN prefix where the WebJars can be downloaded from

Returns:

The JavaScript block that can be embedded or loaded in a <script> tag

generateSetupJavaScript

public static String generateSetupJavaScript(List<String> prefixes)

Returns the JavaScript that is used to setup the RequireJS config. This value is not cached.

Parameters:

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config.

Returns:

The JavaScript block that can be embedded or loaded in a <script> tag.

generateSetupJavaScript

@Deprecated
public static String generateSetupJavaScript(List<String> prefixes,
                                                         Map<String,String> webJars)

Deprecated.

Generate the JavaScript that is used to setup the RequireJS config. This value is not cached. This uses nasty stuff that is really not maintainable or testable. So this has been deprecated and the implementation will eventually be replaced with something better.

Parameters:

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config.

webJars - The WebJars (artifactId -> version) to use

Returns:

The JavaScript block that can be embedded or loaded in a <script> tag.

getSetupJson

public static Map<String,com.fasterxml.jackson.databind.node.ObjectNode> getSetupJson(String urlPrefix)

Returns the JSON that is used to setup the RequireJS config. This value is cached in memory so that all of the processing to get the JSON only has to happen once.

Parameters:

urlPrefix - The URL prefix where the WebJars can be downloaded from with a trailing slash, e.g. /webJars/

Returns:

The JSON structured config

getSetupJson

public static Map<String,com.fasterxml.jackson.databind.node.ObjectNode> getSetupJson(String cdnPrefix,
                                                                                      String urlPrefix)

Returns the JSON that is used to setup the RequireJS config. This value is cached in memory so that all of the processing to get the JSON only has to happen once.

Parameters:

cdnPrefix - The CDN prefix where the WebJars can be downloaded from

urlPrefix - The URL prefix where the WebJars can be downloaded from with a trailing slash, e.g. /webJars/

Returns:

The JSON structured config

generateSetupJson

public static Map<String,com.fasterxml.jackson.databind.node.ObjectNode> generateSetupJson(List<Map.Entry<String,Boolean>> prefixes)

Returns the JSON used to setup the RequireJS config for each WebJar in the CLASSPATH. This value is not cached.

Parameters:

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config with a boolean flag indicating whether or not to include the version.

Returns:

The JSON structured config for each WebJar.

getWebJarRequireJsConfig

public static com.fasterxml.jackson.databind.node.ObjectNode getWebJarRequireJsConfig(Map.Entry<String,String> webJar,
                                                                                      List<Map.Entry<String,Boolean>> prefixes)

Returns the JSON RequireJS config for a given WebJar

Parameters:

webJar - A tuple (artifactId -> version) representing the WebJar.

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config.

Returns:

The JSON RequireJS config for the WebJar based on the meta-data in the WebJar's pom.xml file.

getBowerWebJarRequireJsConfig

public static com.fasterxml.jackson.databind.node.ObjectNode getBowerWebJarRequireJsConfig(Map.Entry<String,String> webJar,
                                                                                           List<Map.Entry<String,Boolean>> prefixes)

Returns the JSON RequireJS config for a given Bower WebJar

Parameters:

webJar - A tuple (artifactId -> version) representing the WebJar.

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config.

Returns:

The JSON RequireJS config for the WebJar based on the meta-data in the WebJar's pom.xml file.

getNpmWebJarRequireJsConfig

public static com.fasterxml.jackson.databind.node.ObjectNode getNpmWebJarRequireJsConfig(Map.Entry<String,String> webJar,
                                                                                         List<Map.Entry<String,Boolean>> prefixes)

Returns the JSON RequireJS config for a given Bower WebJar

Parameters:

webJar - A tuple (artifactId -> version) representing the WebJar.

prefixes - A list of the prefixes to use in the `paths` part of the RequireJS config.

Returns:

The JSON RequireJS config for the WebJar based on the meta-data in the WebJar's pom.xml file.

getRawWebJarRequireJsConfig

public static String getRawWebJarRequireJsConfig(Map.Entry<String,String> webJar)

Parameters:

webJar - A tuple (artifactId -> version) representing the WebJar.

Returns:

The raw RequireJS config string from the WebJar's pom.xml meta-data.

getWebJarConfig

@Deprecated
public static String getWebJarConfig(Map.Entry<String,String> webJar)

Deprecated.

The legacy webJars-requirejs.js based RequireJS config for a WebJar.

Parameters:

webJar - A tuple (artifactId -> version) representing the WebJar.

Returns:

The contents of the webJars-requirejs.js file.