public abstract class

AbstractFisheyeCondition

extends Object
implements Condition
java.lang.Object
   ↳ com.atlassian.fisheye.plugin.web.conditions.AbstractFisheyeCondition

Class Overview

Base class for FishEye and Crucible conditions. Plugins extend this class to create their own conditions. Instances of conditions are created as the decision to display a web-item is taken, and are then discarded.

Summary

Public Constructors
AbstractFisheyeCondition()
Public Methods
final void init(Map<StringString> params)
final boolean shouldDisplay(Map context)
Protected Methods
final Map<StringString> getParams()
Get a Map of the parameters provided to the condition.
final String getRequiredParam(String name)
Get a named parameter, throwing an exception if it is not set.
abstract boolean shouldDisplay(Helper context)
Subclasses must implement this method and return a boolean indicating whether to display the item.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.plugin.web.Condition

Public Constructors

public AbstractFisheyeCondition ()

Public Methods

public final void init (Map<StringString> params)

Throws
PluginParseException

public final boolean shouldDisplay (Map context)

Protected Methods

protected final Map<StringString> getParams ()

Get a Map of the parameters provided to the condition.

Returns
  • a Map containing the parameters

protected final String getRequiredParam (String name)

Get a named parameter, throwing an exception if it is not set.

Parameters
name a String naming the parameter
Returns
  • the value of the parameter

protected abstract boolean shouldDisplay (Helper context)

Subclasses must implement this method and return a boolean indicating whether to display the item. The decision should be based on the context the web-item is being shown in, and the parameters the Condition has been configured with.

Parameters
context a Helper containing the context in which the web-item would be shown
Returns
  • true if the web-item should be displayed, false if it should not be displayed