com.atlassian.jira.permission

Class PermissionHolder

java.lang.Object

com.atlassian.jira.permission.PermissionHolder

@Immutable
 @PublicApi
public final class PermissionHolder
extends Object

A person or a group of people that holds a permission.

When you grant a permission, you need to define to whom you grant it. PermissionHolder lets you do that.

It consists of two things:

PermissionHolderType type

Type of the permission holder. This can be e.g. user, group, project role but also more ephemeral things like issue assignee or reporter.

Standard JIRA reporter types are gathered in the JiraPermissionHolderType enum.

String parameter

Some types require a parameter (e.g. when the type is user, the parameter needs to contain the user id, group requires the group id, etc.) and some don't (e.g. assignee, reporter, project lead).

Note that each PermissionHolderType has a PermissionHolderType.requiresParameter() method, which specifies whether it requires a parameter or not. It is not possible to create a PermissionHolder without a parameter when the type requires one, and vice versa.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
io.atlassian.fugue.Option<String>	getParameter()
PermissionHolderType	getType()
int	hashCode()
static PermissionHolder	holder(PermissionHolderType type)
static PermissionHolder	holder(PermissionHolderType type, String parameter)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

holder

public static PermissionHolder holder(PermissionHolderType type)

holder

public static PermissionHolder holder(PermissionHolderType type,
                                      @Nullable
                                      String parameter)

getType

public PermissionHolderType getType()

getParameter

public io.atlassian.fugue.Option<String> getParameter()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object