com.atlassian.crowd.model.group

Class DelegatingGroupWithAttributes

java.lang.Object

com.atlassian.crowd.embedded.impl.AbstractDelegatingEntityWithAttributes

com.atlassian.crowd.model.group.DelegatingGroupWithAttributes

All Implemented Interfaces:

Attributes, DirectoryEntity, Group, GroupWithAttributes, Comparable<Group>

public class DelegatingGroupWithAttributes
extends AbstractDelegatingEntityWithAttributes
implements GroupWithAttributes

Implementation of GroupWithAttributes that simply delegates to an underlying Group and Attributes object.

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

• It is constructed with immutable objects or
• the mutable objects it is constructed with are not "leaked".

Constructor Summary

Constructors

Constructor and Description
DelegatingGroupWithAttributes(Group group, Attributes attributes)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Group other)
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
String	getDescription()
long	getDirectoryId()
String	getExternalId() This will return null for directories which do not support external ids
String	getName()
GroupType	getType()
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 com.atlassian.crowd.embedded.api.Attributes

getKeys, getValue, getValues, isEmpty

Constructor Detail

DelegatingGroupWithAttributes

public DelegatingGroupWithAttributes(Group group,
                                     Attributes attributes)

Method Detail

getDirectoryId

public long getDirectoryId()

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

Returns:

name of the entity.

isActive

public boolean isActive()

Specified by:

isActive in interface Group

Returns:

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

getDescription

public String getDescription()

Specified by:

getDescription in interface Group

Returns:

description of the group or null if there is no description.

getType

public GroupType getType()

Specified by:

getType in interface Group

Returns:

the type of the group.

getExternalId

@Nullable
public String getExternalId()

Description copied from interface: Group

This will return null for directories which do not support external ids

Specified by:

getExternalId in interface Group

Returns:

external id of the group or null it there is no external id

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 DirectoryEntity

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 DirectoryEntity

Overrides:

hashCode in class Object

Returns:

hashcode.

compareTo

public int compareTo(Group other)

Specified by:

compareTo in interface Comparable<Group>