com.atlassian.plugin.webresource.condition

Class SimpleUrlReadingCondition

java.lang.Object

com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition

All Implemented Interfaces:

com.atlassian.plugin.web.baseconditions.BaseCondition, UrlReadingCondition, DimensionAwareUrlReadingCondition

public abstract class SimpleUrlReadingCondition
extends Object
implements DimensionAwareUrlReadingCondition

Simple implementation for DimensionAwareUrlReadingCondition implementations.

Handles encoding a single boolean into the url. The convention here is that if the condition is true, it is added the querystring; if false it is not added to the querystring.

Since:

v3.1.0

Constructor Summary

Constructors

Constructor and Description
SimpleUrlReadingCondition()

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	addToUrl(UrlBuilder urlBuilder, Coordinate coord)
Dimensions	computeDimensions()
void	init(Map<String,String> params) Called after creation and autowiring.
protected abstract boolean	isConditionTrue()
protected abstract String	queryKey()
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

Constructor Detail

SimpleUrlReadingCondition

public SimpleUrlReadingCondition()

Method Detail

init

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

Description copied from interface: UrlReadingCondition

Called after creation and autowiring.

Specified by:

init in interface UrlReadingCondition

Parameters:

params - The optional map of parameters specified in XML.

Throws:

com.atlassian.plugin.PluginParseException

addToUrl

public void addToUrl(UrlBuilder urlBuilder)

Description copied from interface: UrlReadingCondition

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 UrlReadingCondition

Parameters:

urlBuilder - interface for contributing to the URL

computeDimensions

public Dimensions computeDimensions()

Specified by:

computeDimensions in interface DimensionAwareUrlReadingCondition

addToUrl

public void addToUrl(UrlBuilder urlBuilder,
                     Coordinate coord)

Specified by:

addToUrl in interface DimensionAwareUrlReadingCondition

shouldDisplay

public boolean shouldDisplay(QueryParams params)

Description copied from interface: UrlReadingCondition

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 UrlReadingCondition

Parameters:

params - query params

Returns:

true if the user should see the fragment, false otherwise

isConditionTrue

protected abstract boolean isConditionTrue()

Returns:

true if this condition passes. This is evaluated at url generation time.

queryKey

protected abstract String queryKey()

Returns:

the key to append to the query string