com.atlassian.jira.hints

Class DefaultHintManager

java.lang.Object

com.atlassian.jira.hints.DefaultHintManager

All Implemented Interfaces:

HintManager

public class DefaultHintManager
extends Object
implements HintManager

Default implementation of the HintManager.

Since:

v4.2

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.hints.HintManager

HintManager.Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_HINTS_SECTION
static String	HINTS_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultHintManager(com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager)

Method Summary

Modifier and Type	Method and Description
List<Hint>	getAllHints(ApplicationUser user, JiraHelper jiraHelper) Get all hints visible in given user context.
Hint	getHintForContext(ApplicationUser remoteUser, JiraHelper jiraHelper, HintManager.Context context) Given a valid HintManager.Context this method returns a random link for that context.
Hint	getRandomHint(ApplicationUser user, JiraHelper jiraHelper) Get random hint visible in given user context.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_HINTS_SECTION

public static final String ALL_HINTS_SECTION

See Also:

Constant Field Values

HINTS_PREFIX

public static final String HINTS_PREFIX

See Also:

Constant Field Values

Constructor Detail

DefaultHintManager

public DefaultHintManager(com.atlassian.plugin.web.api.DynamicWebInterfaceManager webInterfaceManager)

Method Detail

getRandomHint

public Hint getRandomHint(ApplicationUser user,
                          JiraHelper jiraHelper)

Description copied from interface: HintManager

Get random hint visible in given user context.

Specified by:

getRandomHint in interface HintManager

Parameters:

user - current user

jiraHelper - JIRA helper

Returns:

random hint

getAllHints

public List<Hint> getAllHints(ApplicationUser user,
                              JiraHelper jiraHelper)

Description copied from interface: HintManager

Get all hints visible in given user context.

Specified by:

getAllHints in interface HintManager

Parameters:

user - current user

jiraHelper - JIRA helper

Returns:

all hints accessible to the user

getHintForContext

public Hint getHintForContext(ApplicationUser remoteUser,
                              JiraHelper jiraHelper,
                              HintManager.Context context)

Description copied from interface: HintManager

Given a valid HintManager.Context this method returns a random link for that context. May be null if no hints exist for the context specified.

Specified by:

getHintForContext in interface HintManager

Parameters:

remoteUser - The current user

jiraHelper - JIRA helper

context - The context to display a hint for

Returns:

A random hint for the context specified or null if none exist