com.atlassian.jira.issue.watchers
Interface IssueWatcherAccessor

public interface IssueWatcherAccessor

Get all watchers for an issue.

Since:

v4.1

Method Summary

Iterable<User>	getDetails(Locale displayLocale, Issue issue) Deprecated. Please use getWatchers(com.atlassian.jira.issue.Issue, java.util.Locale). Since 4.3
<T> Iterable<T>	getDetails(Locale displayLocale, Issue issue, Function<User,T> transformer) Deprecated. Please use getWatchers(com.atlassian.jira.issue.Issue, java.util.Locale). Since 4.3
Iterable<String>	getWatcherNames(Issue issue) Convenience function that simply returns the User names.
Iterable<com.atlassian.crowd.embedded.api.User>	getWatchers(Issue issue, Locale displayLocale) Convenience function that simply returns the User objects.
boolean	isWatchingEnabled()

Method Detail

isWatchingEnabled

boolean isWatchingEnabled()

getWatcherNames

@NotNull
Iterable<String> getWatcherNames(@NotNull
                                         Issue issue)

Convenience function that simply returns the User names.

Parameters:

issue - the issue to get the watchers for

Returns:

an Iterable of the user names, empty if no watchers

getDetails

@NotNull
Iterable<User> getDetails(@NotNull
                                  Locale displayLocale,
                                  @NotNull
                                  Issue issue)

Deprecated. Please use getWatchers(com.atlassian.jira.issue.Issue, java.util.Locale). Since 4.3

Convenience function that simply returns the User objects.

Parameters:

displayLocale - for sorting.

issue - the issue to get the watchers for

Returns:

an Iterable of the users, empty if no watchers

getWatchers

@NotNull
Iterable<com.atlassian.crowd.embedded.api.User> getWatchers(@NotNull
                                                                    Issue issue,
                                                                    @NotNull
                                                                    Locale displayLocale)

Convenience function that simply returns the User objects.

Parameters:

displayLocale - for sorting.

issue - the issue to get the watchers for

Returns:

an Iterable of the users, empty if no watchers

Since:

v4.3

getDetails

@NotNull
<T> Iterable<T> getDetails(@NotNull
                                   Locale displayLocale,
                                   @NotNull
                                   Issue issue,
                                   @NotNull
                                   Function<User,T> transformer)

Deprecated. Please use getWatchers(com.atlassian.jira.issue.Issue, java.util.Locale). Since 4.3

Return an Iterable of all watchers for the supplied issue. The elements are of the type the transformer function returns.

Type Parameters:

T - the type of element in the returned iterable.

Parameters:

displayLocale - for sorting.

issue - the issue to get the watchers for

transformer - to get the required details from the User objects.

Returns:

an Iterable of the user details, empty if no watchers