com.atlassian.sal.api.message

Interface HelpPathResolver

All Known Implementing Classes:

NoopHelpPathResolver

public interface HelpPathResolver

Help path resolver. This is used to retrieve product specific help. Plugins used with multiple Atlassian products may wish to have help integrated with the core product help, e.g. The administration plugin for embedded crowd directory management has different facilities in JIRA and Confluence and both JIRA and Confluence supply their own help pages for the plugin.

Since:

2.4

Method Summary

Methods

Modifier and Type	Method and Description
HelpPath	getHelpPath(String key) Retrieve the help path for a key.

Method Detail

getHelpPath

HelpPath getHelpPath(String key)

Retrieve the help path for a key. Implementers may choose to return null if no help is available for the given key.

Parameters:

key - Key to the help path. The key passed in may be null.

Returns:

HelpPath for the key.