com.atlassian.crowd.model.group

Class ImmutableGroup

java.lang.Object

com.atlassian.crowd.model.group.ImmutableGroup

All Implemented Interfaces:

DirectoryEntity, Group, Comparable<Group>

public class ImmutableGroup
extends Object
implements Group

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableGroup.Builder

Method Summary

Modifier and Type	Method and Description
static ImmutableGroup.Builder	builder(Group group)
static ImmutableGroup.Builder	builder(long directoryId, String name)
static ImmutableGroup.Builder	builder(String name)
int	compareTo(Group other)
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
static ImmutableGroup	from(Group group)
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()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static ImmutableGroup from(Group group)

Returns:

an ImmutableGroup with the same properties as the given group. Will avoid creating a copy if possible.

builder

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

builder

public static ImmutableGroup.Builder builder(String name)

builder

public static ImmutableGroup.Builder builder(Group group)

compareTo

public int compareTo(@Nonnull
                     Group other)

Specified by:

compareTo in interface Comparable<Group>

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.

getType

public GroupType getType()

Specified by:

getType in interface Group

Returns:

the type of the group.

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.

getExternalId

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.

toString

public String toString()

Overrides:

toString in class Object