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

static java.lang.String	S16_16
static java.lang.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

User(java.net.URI self, java.lang.String name, java.lang.String displayName, java.lang.String emailAddress, ExpandableProperty<java.lang.String> groups, java.util.Map<java.lang.String,java.net.URI> avatarUris, java.lang.String timezone)

Method Summary

boolean	equals(java.lang.Object obj)
java.net.URI	getAvatarUri()
java.net.URI	getAvatarUri(java.lang.String sizeDefinition) As of JIRA 5.0 there can be several different user avatar URIs - for different size.
java.lang.String	getEmailAddress()
ExpandableProperty<java.lang.String>	getGroups()
java.net.URI	getSmallAvatarUri()
java.lang.String	getTimezone()
int	hashCode()
java.lang.String	toString()

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

getDisplayName, isSelfUriIncomplete

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

getName, getSelf, getToStringHelper

Methods inherited from class java.lang.Object

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

Field Detail

S16_16

public static java.lang.String S16_16

S48_48

public static java.lang.String S48_48

Constructor Detail

User

public User(java.net.URI self,
            java.lang.String name,
            java.lang.String displayName,
            java.lang.String emailAddress,
            @Nullable
            ExpandableProperty<java.lang.String> groups,
            java.util.Map<java.lang.String,java.net.URI> avatarUris,
            @Nullable
            java.lang.String timezone)

Method Detail

getEmailAddress

public java.lang.String getEmailAddress()

getAvatarUri

public java.net.URI getAvatarUri()

getSmallAvatarUri

@Nullable
public java.net.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 java.net.URI getAvatarUri(java.lang.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<java.lang.String> getGroups()

Returns:

groups given user belongs to

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class BasicUser

hashCode

public int hashCode()

Overrides:

hashCode in class BasicUser

getTimezone

@Nullable
public java.lang.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

toString

public java.lang.String toString()

Overrides:

toString in class BasicUser