Package com.atlassian.administration.quicksearch.impl.spi.alias

Class StaticParamAliasProvider

java.lang.Object

com.atlassian.administration.quicksearch.impl.spi.alias.StaticParamAliasProvider

All Implemented Interfaces:

AdminLinkAliasProvider

Direct Known Subclasses:

JiraStaticParamAliasProvider

public class StaticParamAliasProvider
extends Object
implements AdminLinkAliasProvider

Looks for a link param, whose value is assumed to be i18n key of a list of aliases to return.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
StaticParamAliasProvider(StaticAliasProviderHelper aliasHelper, com.atlassian.plugin.event.PluginEventManager eventManager)
StaticParamAliasProvider(com.atlassian.plugin.event.PluginEventManager eventManager)
StaticParamAliasProvider(String paramName, StaticAliasProviderHelper aliasHelper, com.atlassian.plugin.event.PluginEventManager eventManager)
StaticParamAliasProvider(String paramName, com.atlassian.plugin.event.PluginEventManager eventManager)

Method Summary

Modifier and Type	Method	Description
Set<String>	getAliases(AdminLink link, Iterable<AdminLinkSection> parentSections, UserContext userContext)	Provide aliases for given link in given context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PARAM_NAME

public static final String DEFAULT_PARAM_NAME

See Also:

• Constant Field Values

Constructor Details

StaticParamAliasProvider

public StaticParamAliasProvider(String paramName,
 com.atlassian.plugin.event.PluginEventManager eventManager)

StaticParamAliasProvider

public StaticParamAliasProvider(com.atlassian.plugin.event.PluginEventManager eventManager)

StaticParamAliasProvider

public StaticParamAliasProvider(String paramName,
 StaticAliasProviderHelper aliasHelper,
 com.atlassian.plugin.event.PluginEventManager eventManager)

StaticParamAliasProvider

public StaticParamAliasProvider(StaticAliasProviderHelper aliasHelper,
 com.atlassian.plugin.event.PluginEventManager eventManager)

Method Details

getAliases

public Set<String> getAliases(AdminLink link,
 Iterable<AdminLinkSection> parentSections,
 UserContext userContext)

Description copied from interface: AdminLinkAliasProvider

Provide aliases for given link in given context

Specified by:

getAliases in interface AdminLinkAliasProvider

Parameters:

link - link

parentSections - list of parent sections, starting from the top down to the direct parent of the link

userContext - user context

Returns:

set of aliases for the link in given context, may be empty but cannot be null