Package com.atlassian.plugin.webresource.condition

Interface DecoratingCondition

All Superinterfaces:
com.atlassian.plugin.web.api.baseconditions.BaseCondition, 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 UrlReadingCondition.
Since:
v3.0

  • Method Details

    • 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

    • invertCondition

      DecoratingCondition invertCondition()
      Returns:
      a version of this condition with inverted boolean logic.