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

@ExperimentalApi
public abstract class Person
extends Object
implements Subject

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Person(Icon profilePicture) Deprecated. since 5.6 use Person(Icon, String) instead
protected	Person(Icon profilePicture, String displayName)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

KNOWN_USER_TYPE

protected static final String KNOWN_USER_TYPE

See Also:

Constant Field Values

ANONYMOUS_USER_TYPE

protected static final String ANONYMOUS_USER_TYPE

See Also:

Constant Field Values

Constructor Detail

Person

protected Person(Icon profilePicture,
                 String displayName)

Person

@Deprecated
protected Person(Icon profilePicture)

Deprecated. since 5.6 use Person(Icon, String) instead

Method Detail

getProfilePicture

public 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

getOptionalUsername

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

Since:

5.6

getUserKey

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

Since:

5.6

getSubjectType

public SubjectType getSubjectType()

Specified by:

getSubjectType in interface Subject

Returns:

SubjectType corresponding to this Subject

See Also:

SubjectType#VALUES}