Package com.atlassian.plugin.webresource.condition

Class DecoratingUrlReadingCondition

java.lang.Object

com.atlassian.plugin.webresource.condition.DecoratingUrlReadingCondition

All Implemented Interfaces:

com.atlassian.plugin.web.api.baseconditions.BaseCondition, com.atlassian.plugin.web.baseconditions.BaseCondition, DecoratingCondition

public class DecoratingUrlReadingCondition
extends Object
implements DecoratingCondition

Instance of a DecoratingCondition that wraps a UrlReadingCondition

Since:

v3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,String>	params
protected final UrlReadingCondition	urlReadingCondition

Constructor Summary

Constructors

Constructor	Description
DecoratingUrlReadingCondition(UrlReadingCondition urlReadingCondition, Map<String,String> params, String pluginKey, String conditionClassName)

Method Summary

Modifier and Type	Method	Description
void	addToUrl(UrlBuilder urlBuilder, UrlBuildingStrategy urlBuilderStrategy)	Called when constructing the URL as the hosting HTML page is being served.
Map<String,String>	getParams()
UrlReadingCondition	getUrlReadingCondition()
DecoratingCondition	invertCondition()
boolean	shouldDisplay(QueryParams params)	Determine whether the web fragment should be displayed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

urlReadingCondition

protected final UrlReadingCondition urlReadingCondition

params

protected final Map<String,String> params

Constructor Details

DecoratingUrlReadingCondition

public DecoratingUrlReadingCondition(UrlReadingCondition urlReadingCondition,
 Map<String,String> params,
 String pluginKey,
 String conditionClassName)

Method Details

addToUrl

public void addToUrl(UrlBuilder urlBuilder,
 UrlBuildingStrategy urlBuilderStrategy)

Description copied from interface: DecoratingCondition

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.

Specified by:

addToUrl in interface DecoratingCondition

Parameters:

urlBuilder - interface for contributing to the URL

shouldDisplay

public boolean shouldDisplay(QueryParams params)

Description copied from interface: DecoratingCondition

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

Specified by:

shouldDisplay in interface DecoratingCondition

Parameters:

params - query params

Returns:

true if the user should see the fragment, false otherwise

invertCondition

public DecoratingCondition invertCondition()

Specified by:

invertCondition in interface DecoratingCondition

Returns:

a version of this condition with inverted boolean logic.

getParams

public Map<String,String> getParams()

getUrlReadingCondition

public UrlReadingCondition getUrlReadingCondition()