com.atlassian.plugin.webresource.condition

Interface UrlReadingCondition

All Superinterfaces:

com.atlassian.plugin.web.baseconditions.BaseCondition

All Known Subinterfaces:

DimensionAwareUrlReadingCondition

All Known Implementing Classes:

SimpleUrlReadingCondition

@ExperimentalApi
public interface UrlReadingCondition
extends com.atlassian.plugin.web.baseconditions.BaseCondition

Condition that contributes to the URL.

Web Resource module descriptors can use Conditions of this class or of Condition, however the use of Condition for webresources is discouraged. If a webresource contains a com.atlassian.plugin.web.Condition, that webresource is taken out of the batch and included as a standalone resource download. This has two negative effects:

• It breaks resource dependency, as the resource is no longer sent to the browser in dependency order
• It reduces performance, as the browser must initiate more connections to download resources that would otherwise be batched

UrlReadingConditions are included in batches. When an HTML page is served, the UrlReadingCondition is asked to contribute to the URL in addToUrl(com.atlassian.plugin.webresource.url.UrlBuilder). At resource serve time, the condition evaluates whether it should display based on the querystring.

Since:

v3.0

Method Summary

Modifier and Type	Method and Description
void	addToUrl(UrlBuilder urlBuilder) Called when constructing the URL as the hosting HTML page is being served.
void	init(Map<String,String> params) Called after creation and autowiring.
boolean	shouldDisplay(QueryParams params) Determine whether the web fragment should be displayed.

Method Detail

init

void init(Map<String,String> params)
   throws com.atlassian.plugin.PluginParseException

Called after creation and autowiring.

Parameters:

params - The optional map of parameters specified in XML.

Throws:

com.atlassian.plugin.PluginParseException

addToUrl

void addToUrl(UrlBuilder urlBuilder)

Called when constructing the URL as the hosting HTML page is being served. Can add parameters to the query string and alter the resource hash.

Parameters:

urlBuilder - interface for contributing to the URL

shouldDisplay

boolean shouldDisplay(QueryParams params)

Determine whether the web fragment should be displayed. This method should only read values from its config and the query params.

Parameters:

params - query params

Returns:

true if the user should see the fragment, false otherwise