com.atlassian.sal.core.message

Class NoopHelpPathResolver

java.lang.Object

com.atlassian.sal.core.message.NoopHelpPathResolver

All Implemented Interfaces:

HelpPathResolver

public class NoopHelpPathResolver
extends Object
implements HelpPathResolver

Default noop implementation of HelpPathResolver. This will return null in all cases.

Since:

2.4

Constructor Summary

Constructors

Constructor and Description
NoopHelpPathResolver()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopHelpPathResolver

public NoopHelpPathResolver()

Method Detail

getHelpPath

public HelpPath getHelpPath(String key)

Description copied from interface: HelpPathResolver

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

Specified by:

getHelpPath in interface HelpPathResolver

Parameters:

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

Returns:

HelpPath for the key.