com.atlassian.confluence.api.model.people

Class Group

java.lang.Object

com.atlassian.confluence.api.model.people.Group

All Implemented Interfaces:

Subject, NavigationAware

@ExperimentalApi
public class Group
extends Object
implements Subject, NavigationAware

Represents a group that may contain zero or more users.

This model is deliberately very simple. It is intended that this (and most of the Subject hierarchy in api.model.people) will be replaced by Crowd entities in the near future.

Since:

5.7

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GROUP_TYPE

Constructor Summary

Constructors

Constructor and Description
Group(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getDisplayName() Returns a name that is suitable for display to identify the user / group.
String	getName()
SubjectType	getSubjectType()
int	hashCode()
Navigation.Builder	resolveNavigation(NavigationService navigationService)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_TYPE

protected static final String GROUP_TYPE

See Also:

Constant Field Values

Constructor Detail

Group

public Group(String name)

Method Detail

getName

public String getName()

getDisplayName

public String getDisplayName()

Description copied from interface: Subject

Returns a name that is suitable for display to identify the user / group. Will never return null.

Specified by:

getDisplayName in interface Subject

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

resolveNavigation

public Navigation.Builder resolveNavigation(NavigationService navigationService)

Specified by:

resolveNavigation in interface NavigationAware

getSubjectType

public SubjectType getSubjectType()

Specified by:

getSubjectType in interface Subject

Returns:

SubjectType corresponding to this Subject

See Also:

SubjectType#VALUES}