com.atlassian.plugin.webresource

Interface WebResourceFormatter

All Superinterfaces:

WebResourceFilter

All Known Implementing Classes:

CssWebResource, JavascriptWebResource, PrefetchLinkWebResource

public interface WebResourceFormatter
extends WebResourceFilter

A formatter to format web resources into HTML.

The WebResourceFilter.matches(String) method should be called before calling formatResource(String, Map), to ensure correct formatting of the resource.

Field Summary

Fields

Modifier and Type	Field and Description
static List<WebResourceFormatter>	webResourceFormatters The formatters used for normal output (rendering the current page).

Method Summary

Modifier and Type	Method and Description
String	formatResource(String url, Map<String,String> parameters) Returns a formatted resource string.

Methods inherited from interface com.atlassian.plugin.webresource.WebResourceFilter

matches

Field Detail

webResourceFormatters

static final List<WebResourceFormatter> webResourceFormatters

The formatters used for normal output (rendering the current page).

Note that prefetch link formatting (for WebResourceSet.writePrefetchLinks(java.io.Writer, com.atlassian.webresource.api.UrlMode)) does not use these formatters. See PrefetchLinkWebResource.

Method Detail

formatResource

String formatResource(String url,
                      Map<String,String> parameters)

Returns a formatted resource string.

Parameters:

url - url path to the resource

parameters - a Map of resource parameters

Returns:

a formatted resource String.