com.atlassian.confluence.user

Class ConfluenceUserImpl

java.lang.Object

com.atlassian.confluence.user.ConfluenceUserImpl

All Implemented Interfaces:

RelatableEntity, ConfluenceUser, HasBackingUser, com.atlassian.user.Entity, com.atlassian.user.User, Serializable, Cloneable, Principal

public class ConfluenceUserImpl
extends Object
implements ConfluenceUser, Cloneable, Serializable, HasBackingUser

An implementation of the ConfluenceUser which wraps an atlassian-user User

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfluenceUserImpl()
ConfluenceUserImpl(String username, String fullName, String email) Create a new ConfluenceUserImpl with an automatically generated backing User.
ConfluenceUserImpl(com.atlassian.user.User backingUser)

Method Summary

Modifier and Type	Method and Description
ConfluenceUserImpl	clone() Return a new copy of this ConfluenceUserImpl
boolean	equals(Object o)
com.atlassian.user.User	getBackingUser()
String	getEmail()
String	getFullName()
com.atlassian.sal.api.user.UserKey	getKey() Return the immutable and unique key for the user.
@Nullable String	getLowerName()
String	getName()
int	hashCode()
void	setBackingUser(com.atlassian.user.User backingUser) Provided to aid the strategy of automatically setting the backing user as this object is loaded.
void	setLowerName(@Nullable String lowerName)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

ConfluenceUserImpl

public ConfluenceUserImpl()

ConfluenceUserImpl

public ConfluenceUserImpl(String username,
                          String fullName,
                          String email)

Create a new ConfluenceUserImpl with an automatically generated backing User.

ConfluenceUserImpl

public ConfluenceUserImpl(com.atlassian.user.User backingUser)

Method Detail

getName

public String getName()

Specified by:

getName in interface com.atlassian.user.Entity

Specified by:

getName in interface Principal

getLowerName

public @Nullable String getLowerName()

Specified by:

getLowerName in interface ConfluenceUser

Returns:

the lower username

getKey

public com.atlassian.sal.api.user.UserKey getKey()

Description copied from interface: ConfluenceUser

Return the immutable and unique key for the user.

Specified by:

getKey in interface ConfluenceUser

Returns:

the unique key for this user.

getFullName

public String getFullName()

Specified by:

getFullName in interface com.atlassian.user.User

getEmail

public String getEmail()

Specified by:

getEmail in interface com.atlassian.user.User

getBackingUser

public com.atlassian.user.User getBackingUser()

Specified by:

getBackingUser in interface HasBackingUser

Returns:

the backing user

setName

public void setName(String name)

setLowerName

public void setLowerName(@Nullable String lowerName)

setBackingUser

public void setBackingUser(com.atlassian.user.User backingUser)

Provided to aid the strategy of automatically setting the backing user as this object is loaded.

Parameters:

backingUser - the backing User to set

equals

public boolean equals(Object o)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

clone

public ConfluenceUserImpl clone()
                         throws CloneNotSupportedException

Return a new copy of this ConfluenceUserImpl

Overrides:

clone in class Object

Throws:

CloneNotSupportedException