com.atlassian.jira.bc.user.search

Class UserSearchUtilities

java.lang.Object

com.atlassian.jira.bc.user.search.UserSearchUtilities

public final class UserSearchUtilities
extends Object

Provide a centralised location for accessing functions and other utilities that help to produce the queries needed to perform user searches in both Crowd and in-memory Java

Since:

v7.0

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ApplicationUser>	APPLICATION_USER_COMPARATOR A comparator for ApplicationUser that respects ApplicationUser::getDirectoryId.
static String	SEPARATORS_STRING
static Comparator<UserDTO>	USER_DTO_COMPARATOR A comparator for UserDTO that respects UserDTO::getDirectoryId.

Constructor Summary

Constructors

Constructor and Description
UserSearchUtilities()

Method Summary

Modifier and Type	Method and Description
static List<ApplicationUser>	intersectionRespectingUsernameAndDirId(List<ApplicationUser> list1, List<ApplicationUser> list2)
static List<ApplicationUser>	removeDuplicatesRespectingUsernameAndDirId(List<ApplicationUser> list)
static boolean	userSearchMatchUser(ApplicationUser user, String searchName) Check if user can be matched using given String by username or display name.
static com.querydsl.core.types.Predicate	userSearchQueryDSLPredicate(String queryString) Create a Predicate to make a search for users against the given queryString by username or display name.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATORS_STRING

public static final String SEPARATORS_STRING

APPLICATION_USER_COMPARATOR

public static final Comparator<ApplicationUser> APPLICATION_USER_COMPARATOR

A comparator for ApplicationUser that respects ApplicationUser::getDirectoryId.

USER_DTO_COMPARATOR

public static final Comparator<UserDTO> USER_DTO_COMPARATOR

A comparator for UserDTO that respects UserDTO::getDirectoryId.

Constructor Detail

UserSearchUtilities

public UserSearchUtilities()

Method Detail

userSearchQueryDSLPredicate

public static com.querydsl.core.types.Predicate userSearchQueryDSLPredicate(@Nullable
                                                                            String queryString)

Create a Predicate to make a search for users against the given queryString by username or display name.

It is used in searching methods that make calls to crowd/database for users that meet the requirements. (Used for example during searching for mentionable or assignable users)

Display name is compared by each token located in it witch is created by splitting display name by DISPLAY_NAME_SEPARATOR

It is consistent with userSearchMatchUser(com.atlassian.jira.user.ApplicationUser, java.lang.String)

Parameters:

queryString - string that users will be match with

Returns:

Predicate allowing to match users by username and display name

userSearchMatchUser

public static boolean userSearchMatchUser(ApplicationUser user,
                                          String searchName)

Check if user can be matched using given String by username or display name.

Display name is tokenised by DISPLAY_NAME_SEPARATOR and the tokens are compared to searchName

It is consistent with userSearchQueryDSLPredicate(java.lang.String)

Parameters:

user - user that will be checked if match

searchName - searchName String used for matching

Returns:

boolean value if user can be matched with given searchName

intersectionRespectingUsernameAndDirId

public static List<ApplicationUser> intersectionRespectingUsernameAndDirId(List<ApplicationUser> list1,
                                                                           List<ApplicationUser> list2)

removeDuplicatesRespectingUsernameAndDirId

public static List<ApplicationUser> removeDuplicatesRespectingUsernameAndDirId(List<ApplicationUser> list)