com.atlassian.plugin.webresource.condition

Interface DecoratingCondition

All Superinterfaces:

com.atlassian.plugin.web.baseconditions.BaseCondition

All Known Implementing Classes:

DecoratingAndCompositeCondition, DecoratingUrlReadingCondition

public interface DecoratingCondition
extends com.atlassian.plugin.web.baseconditions.BaseCondition

A condition interface that wraps either UrlReadingCondition or Condition instances.

Since:

v3.0

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

Method Detail

addToUrl

void addToUrl(UrlBuilder urlBuilder,
              UrlBuildingStrategy urlBuilderStrategy)

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

canEncodeStateIntoUrl

boolean canEncodeStateIntoUrl()

Returns:

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

shouldDisplayImmediate

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

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

Parameters:

context - passed by conditions

Returns:

true if this should be displayed

invertCondition

DecoratingCondition invertCondition()

Returns:

a version of this condition with inverted boolean logic.

computeDimensions

Dimensions computeDimensions()