com.atlassian.crowd.model.user

Class ImmutableUser

java.lang.Object

com.atlassian.crowd.model.user.ImmutableUser

All Implemented Interfaces:

User, DirectoryEntity, Comparable<User>, Principal

public final class ImmutableUser
extends Object
implements User

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableUser.Builder

Constructor Summary

Constructors

Constructor and Description
ImmutableUser(long directoryId, String name, String displayName, String emailAddress, boolean active, String firstName, String lastName, String externalId)
ImmutableUser(User user)

Method Summary

Modifier and Type	Method and Description
static ImmutableUser.Builder	builder(long directoryId, String name)
static ImmutableUser.Builder	builder(String name)
static ImmutableUser.Builder	builder(User user)
int	compareTo(User user) CompareTo must be compatible with the equals() and hashCode() methods
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
static ImmutableUser	from(User user)
long	getDirectoryId()
String	getDisplayName()
String	getEmailAddress()
String	getExternalId()
String	getFirstName()
String	getLastName()
String	getName()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

ImmutableUser

public ImmutableUser(User user)

ImmutableUser

public ImmutableUser(long directoryId,
                     String name,
                     String displayName,
                     String emailAddress,
                     boolean active,
                     String firstName,
                     String lastName,
                     String externalId)

Method Detail

from

public static ImmutableUser from(User user)

Returns:

an ImmutableUser with the same properties as the given user. Will avoid creating a copy if possible.

builder

public static ImmutableUser.Builder builder(long directoryId,
                                            String name)

builder

public static ImmutableUser.Builder builder(String name)

builder

public static ImmutableUser.Builder builder(User user)

isActive

public boolean isActive()

Specified by:

isActive in interface User

Returns:

true if and only if the user is allowed to authenticate.

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface User

Specified by:

getDirectoryId in interface DirectoryEntity

Returns:

id of the directory in which the DirectoryEntity is stored.

getName

public String getName()

Specified by:

getName in interface DirectoryEntity

Specified by:

getName in interface Principal

Returns:

name of the entity.

getEmailAddress

public String getEmailAddress()

Specified by:

getEmailAddress in interface User

Returns:

email address of the user.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface User

Returns:

display name (eg. full name) of the user, must never be null.

getFirstName

public String getFirstName()

getLastName

public String getLastName()

getExternalId

public String getExternalId()

equals

public boolean equals(Object o)

Description copied from interface: DirectoryEntity

Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().

Specified by:

equals in interface User

Specified by:

equals in interface DirectoryEntity

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and the lowercase names of the directory entities match.

hashCode

public int hashCode()

Description copied from interface: DirectoryEntity

Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().

Specified by:

hashCode in interface User

Specified by:

hashCode in interface DirectoryEntity

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

hashcode.

compareTo

public int compareTo(User user)

Description copied from interface: User

CompareTo must be compatible with the equals() and hashCode() methods

Specified by:

compareTo in interface User

Specified by:

compareTo in interface Comparable<User>

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object