UserTemplateWithAttributes (Atlassian Crowd 4.3.0-rc1 API)

java.lang.Object
- com.atlassian.crowd.model.user.UserTemplate
- - com.atlassian.crowd.model.user.UserTemplateWithAttributes

All Implemented Interfaces:

Attributes, User, UserWithAttributes, DirectoryEntity, Serializable, Comparable<User>, Principal

Direct Known Subclasses:

UserTemplateWithCredentialAndAttributes
```
public class UserTemplateWithAttributes
extends UserTemplate
implements UserWithAttributes
```
Mutable user template with mutable attributes.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
	`UserTemplateWithAttributes(String username, long directoryId)`
`protected`	`UserTemplateWithAttributes(User user)`
`protected`	`UserTemplateWithAttributes(User user)`
	`UserTemplateWithAttributes(UserWithAttributes user)` Creates new UserTemplateWithAttributes based on the given user with attributes.
	`UserTemplateWithAttributes(UserWithAttributes user)` Creates new UserTemplateWithAttributes based on the given user with attributes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<String,Set<String>>`	`getAttributes()`
`Set<String>`	`getKeys()` Gets all the keys of the attributes.
`String`	`getValue(String name)` Returns any value associated with the given key, returns `null` if there is no value.
`Set<String>`	`getValues(String name)` Get all the values associated with a given key.
`boolean`	`isEmpty()`
`static UserTemplateWithAttributes`	`ofUserWithNoAttributes(User user)` Deprecated. Use `toUserWithNoAttributes(User)` instead. Since v2.9.
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Set<String> values)`
`void`	`setAttribute(String name, String value)`
`String`	`toString()`
`static UserTemplateWithAttributes`	`toUserWithNoAttributes(User user)` Creates new UserTemplateWithAttributes based on the given user with empty attributes.
`static UserTemplateWithAttributes`	`toUserWithNoAttributes(User user)` Creates new UserTemplateWithAttributes based on the given user with empty attributes.

Methods inherited from class com.atlassian.crowd.model.user.UserTemplate
compareTo, equals, getDirectoryId, getDisplayName, getEmailAddress, getExternalId, getFirstName, getLastName, getName, hashCode, isActive, setActive, setDirectoryId, setDisplayName, setEmailAddress, setExternalId, setFirstName, setLastName, setName

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.crowd.model.user.User
getExternalId, getFirstName, getLastName

Methods inherited from interface com.atlassian.crowd.model.DirectoryEntity
equals, getDirectoryId, getName, hashCode

Methods inherited from interface com.atlassian.crowd.embedded.api.User
compareTo, equals, getDirectoryId, getDisplayName, getEmailAddress, hashCode, isActive

Methods inherited from interface java.security.Principal
getName, implies

- Constructor Detail
  - UserTemplateWithAttributes
```
public UserTemplateWithAttributes(String username,
                                  long directoryId)
```
  - UserTemplateWithAttributes
```
public UserTemplateWithAttributes(UserWithAttributes user)
```
    Creates new UserTemplateWithAttributes based on the given user with attributes.
    
    Parameters:
    
    user - user to use as a template
  - UserTemplateWithAttributes
```
public UserTemplateWithAttributes(UserWithAttributes user)
```
    Creates new UserTemplateWithAttributes based on the given user with attributes.
    
    Parameters:
    
    user - user to use as a template
  - UserTemplateWithAttributes
```
protected UserTemplateWithAttributes(User user)
```
  - UserTemplateWithAttributes
```
protected UserTemplateWithAttributes(User user)
```
- Method Detail
  - ofUserWithNoAttributes
```
@Deprecated
public static UserTemplateWithAttributes ofUserWithNoAttributes(User user)
```
    Deprecated. Use toUserWithNoAttributes(User) instead. Since v2.9.
    
    Creates new UserTemplateWithAttributes based on the given user with empty attributes.
    
    Parameters:
    
    user - user to use as a template
    
    Returns:
    
    UserTemplateWithAttributes based on the given user with empty attributes
  - toUserWithNoAttributes
```
public static UserTemplateWithAttributes toUserWithNoAttributes(User user)
```
    Creates new UserTemplateWithAttributes based on the given user with empty attributes.
    
    Parameters:
    
    user - user to use as a template
    
    Returns:
    
    UserTemplateWithAttributes based on the given user with empty attributes
  - toUserWithNoAttributes
```
public static UserTemplateWithAttributes toUserWithNoAttributes(User user)
```
    Creates new UserTemplateWithAttributes based on the given user with empty attributes.
    
    Parameters:
    
    user - user to use as a template
    
    Returns:
    
    UserTemplateWithAttributes based on the given user with empty attributes
  - getAttributes
```
public Map<String,Set<String>> getAttributes()
```
  - getValues
```
@Nullable
public Set<String> getValues(String name)
```
    Description copied from interface: Attributes
    
    Get all the values associated with a given key. Duplicate values are not allowed, and this should be enforced case-insensitively to match the behaviour of LDAP servers. Will return null if the key does not exist.
    
    Specified by:
    
    getValues in interface Attributes
    
    Parameters:
    
    name - the key to retrieve the values for
    
    Returns:
    
    the values associated with the given key. It may return null or empty set if the key does not exist.
  - getValue
```
@Nullable
public String getValue(String name)
```
    Description copied from interface: Attributes
    
    Returns any value associated with the given key, returns null if there is no value.
    
    Specified by:
    
    getValue in interface Attributes
    
    Parameters:
    
    name - the key to retrieve the value for
    
    Returns:
    
    any value associated with the given key, or null if there is no value
  - getKeys
```
public Set<String> getKeys()
```
    Description copied from interface: Attributes
    
    Gets all the keys of the attributes. Warning: case-insensitive keys are currently no enforced, however this is the case for LDAP, so this may be implemented in the future.
    
    Specified by:
    
    getKeys in interface Attributes
    
    Returns:
    
    a set of all the keys.
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Attributes
    
    Returns:
    
    true if there are no attributes
  - setAttribute
```
public void setAttribute(String name,
                         String value)
```
  - setAttribute
```
public void setAttribute(String name,
                         Set<String> values)
```
  - removeAttribute
```
public void removeAttribute(String name)
```
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Principal
    
    Overrides:
    
    toString in class UserTemplate

Class UserTemplateWithAttributes

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.crowd.model.user.UserTemplate

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.crowd.model.user.User

Methods inherited from interface com.atlassian.crowd.model.DirectoryEntity

Methods inherited from interface com.atlassian.crowd.embedded.api.User

Methods inherited from interface java.security.Principal

Constructor Detail

UserTemplateWithAttributes

UserTemplateWithAttributes

UserTemplateWithAttributes

UserTemplateWithAttributes

UserTemplateWithAttributes

Method Detail

ofUserWithNoAttributes

toUserWithNoAttributes

toUserWithNoAttributes

getAttributes

getValues

getValue

getKeys

isEmpty

setAttribute

setAttribute

removeAttribute

toString