com.atlassian.plugin.webresource.transformer

Interface StaticTransformers

All Known Implementing Classes:

DefaultStaticTransformers

public interface StaticTransformers

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 and Description
static String[]	PARAMETERS_USED

Method Summary

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

Field Detail

PARAMETERS_USED

static final String[] PARAMETERS_USED

Method Detail

computeDimensions

Dimensions computeDimensions()

Returns the Dimensions of all registered transformers.

Returns:

dimensions of all registeres transformers

computeBundleDimensions

Dimensions computeBundleDimensions(Bundle bundle)

Parameters:

bundle - for which you want to get dimensions.

Returns:

Dimensions related to given bundle.

Since:

3.5.22

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,
                  String filePath,
                  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

filePath - file path

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