com.atlassian.plugin.webresource.condition

Class DecoratingAndCompositeCondition

java.lang.Object

com.atlassian.plugin.webresource.condition.DecoratingAndCompositeCondition

All Implemented Interfaces:

com.atlassian.plugin.web.baseconditions.BaseCondition, com.atlassian.plugin.web.baseconditions.CompositeCondition<DecoratingCondition>, DecoratingCondition

public class DecoratingAndCompositeCondition
extends Object

Implementation of DecoratingCompositeCondition that fits the new UrlReadingCondition interface.

Since:

v3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DecoratingCondition>	conditions

Constructor Summary

Constructors

Constructor and Description
DecoratingAndCompositeCondition()

Method Summary

Modifier and Type	Method and Description
void	addCondition(DecoratingCondition condition)
void	addToUrl(UrlBuilder urlBuilder, UrlBuildingStrategy urlBuilderStrategy) Called when constructing the URL as the hosting HTML page is being served.
boolean	canEncodeStateIntoUrl()
Dimensions	computeDimensions()
List<DecoratingCondition>	getConditions()
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

conditions

protected List<DecoratingCondition> conditions

Constructor Detail

DecoratingAndCompositeCondition

public DecoratingAndCompositeCondition()

Method Detail

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.

Parameters:

params - query params

Returns:

true if the user should see the fragment, false otherwise

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.

Parameters:

context - passed by conditions

Returns:

true if this should be displayed

invertCondition

public DecoratingCondition invertCondition()

Returns:

a version of this condition with inverted boolean logic.

addCondition

public void addCondition(DecoratingCondition condition)

Specified by:

addCondition in interface com.atlassian.plugin.web.baseconditions.CompositeCondition<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

computeDimensions

public Dimensions computeDimensions()

Specified by:

computeDimensions in interface DecoratingCondition

canEncodeStateIntoUrl

public boolean canEncodeStateIntoUrl()

Specified by:

canEncodeStateIntoUrl in interface DecoratingCondition

Returns:

true if this all child conditions can fully encode their state into the URL, otherwise false.

getConditions

public List<DecoratingCondition> getConditions()