Package com.atlassian.jira.rest.client.api.domain

Class User

java.lang.Object

com.atlassian.jira.rest.client.api.domain.AddressableNamedEntity

com.atlassian.jira.rest.client.api.domain.BasicUser

com.atlassian.jira.rest.client.api.domain.User

All Implemented Interfaces:

AddressableEntity, NamedEntity

public class User
extends BasicUser

Complete information about a single JIRA user

Since:

v0.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	S16_16
static final String	S48_48

Fields inherited from class com.atlassian.jira.rest.client.api.domain.BasicUser

INCOMPLETE_URI

Fields inherited from class com.atlassian.jira.rest.client.api.domain.AddressableNamedEntity

name, self

Constructor Summary

Constructors

Constructor	Description
User(URI self, String name, String displayName, String emailAddress, boolean active, ExpandableProperty<String> groups, Map<String,URI> avatarUris, String timezone)
User(URI self, String name, String displayName, String emailAddress, ExpandableProperty<String> groups, Map<String,URI> avatarUris, String timezone)	Deprecated. since v5.1.0.
User(URI self, String name, String displayName, String accountId, String emailAddress, boolean active, ExpandableProperty<String> groups, Map<String,URI> avatarUris, String timezone)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
URI	getAvatarUri()
URI	getAvatarUri(String sizeDefinition)	As of JIRA 5.0 there can be several different user avatar URIs - for different size.
String	getEmailAddress()
ExpandableProperty<String>	getGroups()
URI	getSmallAvatarUri()
String	getTimezone()
protected com.google.common.base.MoreObjects.ToStringHelper	getToStringHelper()
int	hashCode()
boolean	isActive()

Methods inherited from class com.atlassian.jira.rest.client.api.domain.BasicUser

getAccountId, getDisplayName, isSelfUriIncomplete

Methods inherited from class com.atlassian.jira.rest.client.api.domain.AddressableNamedEntity

getName, getSelf, toString

Methods inherited from class java.lang.Object

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

Field Details

S16_16

public static final String S16_16

See Also:

• Constant Field Values

S48_48

public static final String S48_48

See Also:

• Constant Field Values

Constructor Details

User

public User(URI self,
 String name,
 String displayName,
 String accountId,
 String emailAddress,
 boolean active,
 @Nullable
 ExpandableProperty<String> groups,
 Map<String,URI> avatarUris,
 @Nullable
 String timezone)

User

public User(URI self,
 String name,
 String displayName,
 String emailAddress,
 boolean active,
 @Nullable
 ExpandableProperty<String> groups,
 Map<String,URI> avatarUris,
 @Nullable
 String timezone)

User

@Deprecated
public User(URI self,
 String name,
 String displayName,
 String emailAddress,
 @Nullable
 ExpandableProperty<String> groups,
 Map<String,URI> avatarUris,
 @Nullable
 String timezone)

Deprecated.

since v5.1.0. Use User(URI,String,String,String,boolean,ExpandableProperty,Map,String) instead.

This constructor is used to create an active user per default.

Method Details

getEmailAddress

public String getEmailAddress()

isActive

public boolean isActive()

getAvatarUri

public URI getAvatarUri()

getSmallAvatarUri

@Nullable
public URI getSmallAvatarUri()

Returns:

user avatar image URI for 16x16 pixels

Since:

0.5 com.atlassian.jira.rest.client.api, 5.0 server

getAvatarUri

@Nullable
public URI getAvatarUri(String sizeDefinition)

As of JIRA 5.0 there can be several different user avatar URIs - for different size.

Parameters:

sizeDefinition - size like "16x16" or "48x48". URI for 48x48 should be always defined.

Returns:

URI for specified size or null when there is no avatar image with given dimensions specified for this user

getGroups

@Nullable
public ExpandableProperty<String> getGroups()

Returns:

groups given user belongs to

equals

public boolean equals(Object obj)

Overrides:

equals in class BasicUser

hashCode

public int hashCode()

Overrides:

hashCode in class BasicUser

getTimezone

@Nullable
public String getTimezone()

Returns:

user timezone, like "Europe/Berlin" or null if timezone info is not available

Since:

com.atlassian.jira.rest.client.api 0.5, server 4.4

getToStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper getToStringHelper()

Overrides:

getToStringHelper in class BasicUser