public class

UserSearchInput

extends Object
implements Comparable<T>
java.lang.Object
   ↳ com.atlassian.jira.issue.search.searchers.transformer.UserSearchInput

Class Overview

A value entered into a user searcher (e.g. current user, a specific user).

Summary

Nested Classes
enum UserSearchInput.InputType  
Public Methods
int compareTo(UserSearchInput other)
static UserSearchInput currentUser()
static UserSearchInput empty()
boolean equals(Object that)
Object getObject()
UserSearchInput.InputType getType()
String getValue()
static UserSearchInput group(String name)
int hashCode()
boolean isCurrentUser()
boolean isEmpty()
boolean isGroup()
boolean isUser()
void setObject(Object object)
static UserSearchInput user(String name)
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable

Public Methods

public int compareTo (UserSearchInput other)

public static UserSearchInput currentUser ()

Returns
  • An instance representing the "currentUser()" value.

public static UserSearchInput empty ()

Returns
  • An instance representing the "empty" value (e.g. unassigned).

public boolean equals (Object that)

public Object getObject ()

Returns
  • The actual object that corresponds to the user's input (i.e. the group/user object with the given name/username).

public UserSearchInput.InputType getType ()

Returns
  • The type of the input value (i.e. current user, empty, etc.).

public String getValue ()

Returns
  • The input value (i.e. the name of the group/user).

public static UserSearchInput group (String name)

Parameters
name The name of the group.
Returns
  • An instance representing a particular group.

public int hashCode ()

public boolean isCurrentUser ()

Returns
  • Whether the instance represents the "currentUser()" value.

public boolean isEmpty ()

Returns
  • Whether the instance represents the "empty" value.

public boolean isGroup ()

Returns
  • Whether the instance represents a particular group.

public boolean isUser ()

Returns
  • Whether the instance represents a particular user.

public void setObject (Object object)

Parameters
object The object to set.

public static UserSearchInput user (String name)

Parameters
name The user's username.
Returns
  • An instance representing a particular user.