Package com.atlassian.confluence.api.model.people

Class User

java.lang.Object

com.atlassian.confluence.api.model.people.Person

com.atlassian.confluence.api.model.people.User

All Implemented Interfaces:

Subject, Relatable

Direct Known Subclasses:

KnownUser, UnknownUser

@ExperimentalApi
public class User
extends Person
implements Relatable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	User.Expansions

Field Summary

Fields

Modifier and Type	Field	Description
static com.google.common.base.Predicate<User>	isUserKnown	A predicate that filters out unknown users.
static com.google.common.base.Function<User,String>	mapUserToUsername
protected String	username

Fields inherited from class com.atlassian.confluence.api.model.people.Person

ANONYMOUS_USER_TYPE, KNOWN_USER_TYPE

Constructor Summary

Constructors

Constructor	Description
User(Icon profilePicture, String username)	Deprecated. since 5.6.
User(Icon profilePicture, String username, String displayName, com.atlassian.sal.api.user.UserKey userKey)
User(Icon profilePicture, String username, String displayName, String userKey)

Method Summary

Modifier and Type	Method	Description
static User	fromUserkey(com.atlassian.sal.api.user.UserKey key)	Creates a user object with only the userkey filled in, suitable for passing to services that accept a User object
static User	fromUsername(String username)	Creates a user object with only the username filled in, suitable for passing to services that accept a User object
com.atlassian.fugue.Option<String>	getOptionalUsername()	Deprecated. since 7.0.1.
com.atlassian.fugue.Option<com.atlassian.sal.api.user.UserKey>	getUserKey()	Deprecated. since 7.0.1.
String	getUsername()
String	toString()

Methods inherited from class com.atlassian.confluence.api.model.people.Person

getDisplayName, getProfilePicture, getSubjectType, optionalUserKey, optionalUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

username

protected final String username

mapUserToUsername

public static final com.google.common.base.Function<User,String> mapUserToUsername

isUserKnown

public static final com.google.common.base.Predicate<User> isUserKnown

A predicate that filters out unknown users.

Constructor Detail

User

public User(Icon profilePicture,
            String username,
            String displayName,
            String userKey)

User

public User(Icon profilePicture,
            String username,
            String displayName,
            com.atlassian.sal.api.user.UserKey userKey)

User

@Deprecated
public User(Icon profilePicture,
            String username)

Deprecated.

since 5.6. Use User(Icon, String, String, UserKey) instead.

Method Detail

getUsername

public String getUsername()

getOptionalUsername

@Deprecated
public com.atlassian.fugue.Option<String> getOptionalUsername()

Deprecated.

since 7.0.1. Use Person.optionalUsername()

Specified by:

getOptionalUsername in class Person

getUserKey

@Deprecated
public com.atlassian.fugue.Option<com.atlassian.sal.api.user.UserKey> getUserKey()

Deprecated.

since 7.0.1. Use Person.optionalUserKey()

Specified by:

getUserKey in class Person

toString

public String toString()

Overrides:

toString in class Object

fromUsername

public static User fromUsername(String username)

Creates a user object with only the username filled in, suitable for passing to services that accept a User object

fromUserkey

public static User fromUserkey(com.atlassian.sal.api.user.UserKey key)

Creates a user object with only the userkey filled in, suitable for passing to services that accept a User object