com.atlassian.crowd.embedded.impl
Class DelegatingUserWithAttributes

java.lang.Object
  extended by com.atlassian.crowd.embedded.impl.AbstractDelegatingEntityWithAttributes
      extended by com.atlassian.crowd.embedded.impl.DelegatingUserWithAttributes
All Implemented Interfaces:
Attributes, User, UserWithAttributes, java.lang.Comparable<User>, java.security.Principal
Direct Known Subclasses:
DelegatingUserWithAttributes

public class DelegatingUserWithAttributes
extends AbstractDelegatingEntityWithAttributes
implements UserWithAttributes

Implementation of UserWithAttributes that simply delegates to an underlying User and Attributes object.

Instances of this class will be effectively immutable so long as either:


Constructor Summary
DelegatingUserWithAttributes(User user, Attributes attributes)
           
 
Method Summary
 int compareTo(User user)
          CompareTo must be compatible with the equals() and hashCode() methods
 boolean equals(java.lang.Object o)
          Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
 long getDirectoryId()
           
 java.lang.String getDisplayName()
           
 java.lang.String getEmailAddress()
           
 java.lang.String getName()
           
 int hashCode()
          Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
 boolean isActive()
           
 
Methods inherited from class com.atlassian.crowd.embedded.impl.AbstractDelegatingEntityWithAttributes
getKeys, getValue, getValues, isEmpty
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.security.Principal
toString
 
Methods inherited from interface com.atlassian.crowd.embedded.api.Attributes
getKeys, getValue, getValues, isEmpty
 

Constructor Detail

DelegatingUserWithAttributes

public DelegatingUserWithAttributes(User user,
                                    Attributes attributes)
Method Detail

getDirectoryId

public long getDirectoryId()
Specified by:
getDirectoryId in interface User
Returns:
id of the directory in which the User is stored.

isActive

public boolean isActive()
Specified by:
isActive in interface User
Returns:
true if and only if the user is allowed to authenticate.

getEmailAddress

public java.lang.String getEmailAddress()
Specified by:
getEmailAddress in interface User
Returns:
email address of the user.

getDisplayName

public java.lang.String getDisplayName()
Specified by:
getDisplayName in interface User
Returns:
display name (eg. full name) of the user, must never be null.

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 java.lang.Comparable<User>

getName

public java.lang.String getName()
Specified by:
getName in interface java.security.Principal

equals

public boolean equals(java.lang.Object o)
Description copied from interface: User
Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().

Specified by:
equals in interface User
Specified by:
equals in interface java.security.Principal
Overrides:
equals in class java.lang.Object
Parameters:
o - object to compare to.
Returns:
true if and only if the directoryId and name.toLowerCase() of the directory entities match.

hashCode

public int hashCode()
Description copied from interface: User
Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().

Specified by:
hashCode in interface User
Specified by:
hashCode in interface java.security.Principal
Overrides:
hashCode in class java.lang.Object
Returns:
hashcode.


Copyright © 2010 Atlassian. All Rights Reserved.