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

Class Person

java.lang.Object

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

All Implemented Interfaces:

Subject

Direct Known Subclasses:

Anonymous, User

public abstract class Person
extends Object
implements Subject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Person.PersonBuilder<T extends Person.PersonBuilder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANONYMOUS_USER_TYPE
protected static final String	KNOWN_USER_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Person(Person.PersonBuilder personBuilder)
protected	Person(Reference<Icon> profilePicture, String displayName)
protected	Person(Icon profilePicture)	Deprecated. since 5.6 use invalid @link {@link #Person(Reference of Icon, String) } instead
protected	Person(Icon profilePicture, String displayName)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns a name that is suitable for display to identify the user / group.
@Nullable Icon	getProfilePicture()
SubjectType	getSubjectType()
abstract Optional<com.atlassian.sal.api.user.UserKey>	optionalUserKey()
abstract Optional<String>	optionalUsername()

Methods inherited from class java.lang.Object

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

Field Details

KNOWN_USER_TYPE

protected static final String KNOWN_USER_TYPE

See Also:

• Constant Field Values

ANONYMOUS_USER_TYPE

public static final String ANONYMOUS_USER_TYPE

See Also:

• Constant Field Values

Constructor Details

Person

protected Person(Reference<Icon> profilePicture,
 String displayName)

Person

protected Person(Icon profilePicture,
 String displayName)

Person

protected Person(Person.PersonBuilder personBuilder)

Person

@Deprecated
protected Person(Icon profilePicture)

Deprecated.

since 5.6 use

invalid @link

{@link #Person(Reference of Icon, String)

} instead

Method Details

getProfilePicture

public @Nullable Icon getProfilePicture()

getDisplayName

public String getDisplayName()

Description copied from interface: Subject

Returns a name that is suitable for display to identify the user / group. Will never return null.

Specified by:

getDisplayName in interface Subject

Since:

5.6

optionalUsername

public abstract Optional<String> optionalUsername()

Since:

7.0.1

optionalUserKey

public abstract Optional<com.atlassian.sal.api.user.UserKey> optionalUserKey()

Since:

7.0.1

getSubjectType

public SubjectType getSubjectType()

Specified by:

getSubjectType in interface Subject

Returns:

SubjectType corresponding to this Subject

See Also:

• SubjectType.VALUES