Package com.atlassian.plugin.webresource.transformer

Interface StaticTransformers

All Superinterfaces:

TwoPhaseResourceTransformer

All Known Implementing Classes:

DefaultStaticTransformers

public interface StaticTransformers
extends TwoPhaseResourceTransformer

Applies a fixed set of transformers to all resources by type. These transformers are always applied after pluggable transformers.

Since:

v3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	PARAMETERS_USED

Method Summary

Modifier and Type	Method	Description
void	addToUrl(String locationType, TransformerParameters transformerParameters, UrlBuilder urlBuilder, UrlBuildingStrategy urlBuildingStrategy)	Contributes to the URL for all static transformers matching the given type
Set<String>	getParamKeys()	Get list of param keys used by this transformers.
Content	transform(Content content, TransformerParameters transformerParameters, com.atlassian.plugin.elements.ResourceLocation resourceLocation, QueryParams queryParams, String sourceUrl)	Performs transformation for all static transformers for the given type.

Methods inherited from interface com.atlassian.webresource.spi.transformer.TwoPhaseResourceTransformer

hasTwoPhaseProperties, loadTwoPhaseProperties

Field Details

PARAMETERS_USED

static final String[] PARAMETERS_USED

Method Details

addToUrl

void addToUrl(String locationType,
 TransformerParameters transformerParameters,
 UrlBuilder urlBuilder,
 UrlBuildingStrategy urlBuildingStrategy)

Contributes to the URL for all static transformers matching the given type

Parameters:

locationType - type of resource (eg js, css, less)

transformerParameters - parameters to pass to transformers

urlBuilder - url building to contribute to

transform

Content transform(Content content,
 TransformerParameters transformerParameters,
 com.atlassian.plugin.elements.ResourceLocation resourceLocation,
 QueryParams queryParams,
 String sourceUrl)

Performs transformation for all static transformers for the given type.

Parameters:

content - content to transform

transformerParameters - the TransformerParameters object

resourceLocation - resource location

queryParams - url querystring containing information for transformers

sourceUrl - url of original source file

Returns:

a DownloadableResource representing the completed transformation

getParamKeys

Set<String> getParamKeys()

Get list of param keys used by this transformers.

Since:

3.5.27