Package org.keycloak.utils

Enum Class SearchQueryUtils.UserSearchPrefix

java.lang.Object

java.lang.Enum<SearchQueryUtils.UserSearchPrefix>

org.keycloak.utils.SearchQueryUtils.UserSearchPrefix

All Implemented Interfaces:

Serializable, Comparable<SearchQueryUtils.UserSearchPrefix>, Constable

Enclosing class:

SearchQueryUtils

public static enum SearchQueryUtils.UserSearchPrefix
extends Enum<SearchQueryUtils.UserSearchPrefix>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL
ID
USERNAME

Method Summary

Modifier and Type	Method	Description
String	getPrefix()
UserModel	lookup(UserProvider users, RealmModel realm, String term)
static SearchQueryUtils.UserSearchPrefix	matching(String search)
String[]	splitTerms(String search)
static SearchQueryUtils.UserSearchPrefix	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchQueryUtils.UserSearchPrefix[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ID

public static final SearchQueryUtils.UserSearchPrefix ID

USERNAME

public static final SearchQueryUtils.UserSearchPrefix USERNAME

EMAIL

public static final SearchQueryUtils.UserSearchPrefix EMAIL

Method Details

values

public static SearchQueryUtils.UserSearchPrefix[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchQueryUtils.UserSearchPrefix valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPrefix

public String getPrefix()

lookup

public UserModel lookup(UserProvider users,
 RealmModel realm,
 String term)

splitTerms

public String[] splitTerms(String search)

matching

public static SearchQueryUtils.UserSearchPrefix matching(String search)