com.atlassian.plugin.webresource.condition

Class DecoratingUrlReadingCondition

java.lang.Object

com.atlassian.plugin.webresource.condition.DecoratingUrlReadingCondition

All Implemented Interfaces:

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 and Description
protected Map<String,String>	params
protected UrlReadingCondition	urlReadingCondition

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addToUrl(UrlBuilder urlBuilder, UrlBuildingStrategy urlBuilderStrategy) Called when constructing the URL as the hosting HTML page is being served.
boolean	canEncodeStateIntoUrl()
Dimensions	computeDimensions()
Map<String,String>	getParams()
UrlReadingCondition	getUrlReadingCondition()
DecoratingCondition	invertCondition()
boolean	shouldDisplay(QueryParams params) Determine whether the web fragment should be displayed.
boolean	shouldDisplayImmediate(Map<String,Object> context, UrlBuildingStrategy urlBuilderStrategy) Calls the legacy condition's wrapped shouldDisplay(Map context) method.

Methods inherited from class java.lang.Object

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

Field Detail

urlReadingCondition

protected final UrlReadingCondition urlReadingCondition

params

protected final Map<String,String> params

Constructor Detail

DecoratingUrlReadingCondition

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

Method Detail

computeDimensions

public Dimensions computeDimensions()

Specified by:

computeDimensions in interface DecoratingCondition

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

canEncodeStateIntoUrl

public boolean canEncodeStateIntoUrl()

Specified by:

canEncodeStateIntoUrl in interface DecoratingCondition

Returns:

true if this condition can fully encode its state into the URL; false if it cannot.

shouldDisplayImmediate

public boolean shouldDisplayImmediate(Map<String,Object> context,
                                      UrlBuildingStrategy urlBuilderStrategy)

Description copied from interface: DecoratingCondition

Calls the legacy condition's wrapped shouldDisplay(Map context) method. UrlReadingConditions should always return true here. If DecoratingCondition.canEncodeStateIntoUrl() returns true, this should never be called.

Specified by:

shouldDisplayImmediate in interface DecoratingCondition

Parameters:

context - passed by conditions

Returns:

true if this should be displayed

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()