com.atlassian.plugin.webresource

Class JavascriptWebResource

java.lang.Object

com.atlassian.plugin.webresource.JavascriptWebResource

All Implemented Interfaces:

WebResourceFilter, WebResourceFormatter

public class JavascriptWebResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static WebResourceFormatter	FORMATTER

Fields inherited from interface com.atlassian.plugin.webresource.WebResourceFormatter

webResourceFormatters

Constructor Summary

Constructors

Constructor and Description
JavascriptWebResource()

Method Summary

Modifier and Type	Method and Description
String	formatResource(String url, Map<String,String> attributes) Returns a formatted resource string.
String	formatResource(String url, Map<String,String> attributes, boolean enableDeferJsAttribute)
protected List<String>	getAttributeParameters() Should return a List of parameter name Strings, which the WebResourceFormatter will write out as HTML attributes.
protected List<String>	getParametersAsAttributes(Map params) A convenient method to convert the given parameter map into a List of HTML String attributes.
boolean	matches(String name) Returns true if this filter supports the inclusion of the given resource.

Methods inherited from class java.lang.Object

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

Field Detail

FORMATTER

public static final WebResourceFormatter FORMATTER

Constructor Detail

JavascriptWebResource

public JavascriptWebResource()

Method Detail

matches

public boolean matches(String name)

Description copied from interface: WebResourceFilter

Returns true if this filter supports the inclusion of the given resource.

Parameters:

name - name of the resource

Returns:

true if the filter includes this resource, false otherwise

formatResource

public String formatResource(String url,
                             Map<String,String> attributes)

Description copied from interface: WebResourceFormatter

Returns a formatted resource string.

Parameters:

url - url path to the resource

attributes - a Map of resource parameters

Returns:

a formatted resource String.

formatResource

public String formatResource(String url,
                             Map<String,String> attributes,
                             boolean enableDeferJsAttribute)

getAttributeParameters

protected List<String> getAttributeParameters()

Should return a List of parameter name Strings, which the WebResourceFormatter will write out as HTML attributes.

Returns:

a List of parameter names

getParametersAsAttributes

protected List<String> getParametersAsAttributes(Map params)

A convenient method to convert the given parameter map into a List of HTML String attributes. For example, an entry with key 'foo' and value 'bar' is converted to the attribute string, foo="bar".

Only parameters that are supported by the WebResourceFormatter are formatted (See getAttributeParameters()).

Parameters:

params - a Map of parameters

Returns:

a list of HTML String attributes