com.atlassian.plugin.webresource.transformer

Interface WebResourceTransformerFactory

All Known Subinterfaces:

DimensionAwareWebResourceTransformerFactory

public interface WebResourceTransformerFactory

Factory to create URL aware web resource transformers

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
default UrlReadingWebResourceTransformer	makeResourceTransformer(org.dom4j.Element configElement, TransformerParameters parameters) Deprecated. this method is added as a temporary solution to support Bitbucket Server's AbstractUrlReadingClientWebFragmentTransformer, and will be removed after Bitbucket 7.0 is released
UrlReadingWebResourceTransformer	makeResourceTransformer(TransformerParameters parameters) Return the transformer for this transform
TransformerUrlBuilder	makeUrlBuilder(TransformerParameters parameters) Return the URL builder for this transform

Method Detail

makeUrlBuilder

TransformerUrlBuilder makeUrlBuilder(TransformerParameters parameters)

Return the URL builder for this transform

Parameters:

parameters - transformer parameters

Returns:

an builder that contributes parameters to the URL

makeResourceTransformer

UrlReadingWebResourceTransformer makeResourceTransformer(TransformerParameters parameters)

Return the transformer for this transform

Parameters:

parameters - transformer parameters

Returns:

a transformer that reads values from the url and transforms a webresource

makeResourceTransformer

@Deprecated
default UrlReadingWebResourceTransformer makeResourceTransformer(org.dom4j.Element configElement,
                                                                             TransformerParameters parameters)

Deprecated. this method is added as a temporary solution to support Bitbucket Server's AbstractUrlReadingClientWebFragmentTransformer, and will be removed after Bitbucket 7.0 is released

Return the transformer for this transform

The default implementation discards the configElement and calls makeResourceTransformer(TransformerParameters). This default implementation is provided for backwards compatibility. New implementations of this interface must override this method if they need access to the configElement.

Parameters:

configElement - the transformer config from the plugin descriptor file

parameters - transformer parameters

Returns:

a transformer that reads values from the url and transforms a webresource