com.atlassian.jira.issue.search.searchers.transformer
Class UserSearchInput

java.lang.Object
  com.atlassian.jira.issue.search.searchers.transformer.UserSearchInput

All Implemented Interfaces:

Comparable<UserSearchInput>

public class UserSearchInput
extends Object
implements Comparable<UserSearchInput>

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

Since:

5.2

Nested Class Summary

static class

UserSearchInput.InputType

Method Summary

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)

Methods inherited from class java.lang.Object

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

Method Detail

currentUser

public static UserSearchInput currentUser()

Returns:

An instance representing the "currentUser()" value.

empty

public static UserSearchInput empty()

Returns:

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

group

public static UserSearchInput group(String name)

Parameters:

name - The name of the group.

Returns:

An instance representing a particular group.

user

public static UserSearchInput user(String name)

Parameters:

name - The user's username.

Returns:

An instance representing a particular user.

compareTo

public int compareTo(UserSearchInput other)

Specified by:

compareTo in interface Comparable<UserSearchInput>

equals

public boolean equals(Object that)

Overrides:

equals in class Object

getObject

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).

getType

public UserSearchInput.InputType getType()

Returns:

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

getValue

public String getValue()

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCurrentUser

public boolean isCurrentUser()

Returns:

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

isEmpty

public boolean isEmpty()

Returns:

Whether the instance represents the "empty" value.

isGroup

public boolean isGroup()

Returns:

Whether the instance represents a particular group.

isUser

public boolean isUser()

Returns:

Whether the instance represents a particular user.

setObject

public void setObject(Object object)

Parameters:

object - The object to set.