Summary: Methods | [Expand All]
@PublicApi public interface

DefaultRoleActors

com.atlassian.jira.security.roles.DefaultRoleActors
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This interface defines the association between a ProjectRole and a collection of default Actors. Actors associated with a ProjectRole in this way will be used to populate the ProjectRoleActors association when a new project is created within JIRA.

Note: implementations must be immutable.

Summary

Public Methods
DefaultRoleActors addRoleActor(RoleActor roleActor)
Add the RoleActor to the contained set of RoleActors and return a new DefaultRoleActors with the modified set
DefaultRoleActors addRoleActors(Collection<? extends RoleActor> roleActors)
Add the collection of RoleActors to the contained set of RoleActors and return a new DefaultRoleActors with the modified set
boolean contains(User user)
This method is deprecated. Use contains(ApplicationUser user) instead. Since v6.0.
boolean contains(ApplicationUser user)
Does the collection of RoleActor instances contain the specified user.
Set<ApplicationUser> getApplicationUsers()
Long getProjectRoleId()
Set<RoleActor> getRoleActors()
Set<RoleActor> getRoleActorsByType(String type)
Set<User> getUsers()
DefaultRoleActors removeRoleActor(RoleActor roleActor)
Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set
DefaultRoleActors removeRoleActors(Collection<? extends RoleActor> roleActors)
Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Public Methods

public DefaultRoleActors addRoleActor (RoleActor roleActor)

Add the RoleActor to the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters
roleActor the RoleActor to add
Returns
  • a copy of this DefaultRoleActors with the added RoleActor in its set of RoleActors

public DefaultRoleActors addRoleActors (Collection<? extends RoleActor> roleActors)

Add the collection of RoleActors to the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters
roleActors the collection RoleActor to add
Returns
  • a copy of this DefaultRoleActors with the added RoleActors in its set of RoleActors

public boolean contains (User user)

This method is deprecated.
Use contains(ApplicationUser user) instead. Since v6.0.

Does the collection of RoleActor instances contain the specified user.

Parameters
user the application user to check if they are contained
Returns
  • true if the user is matched by this RoleActor

public boolean contains (ApplicationUser user)

Does the collection of RoleActor instances contain the specified user.

Parameters
user the application user to check if they are contained
Returns
  • true if the user is matched by this RoleActor

public Set<ApplicationUser> getApplicationUsers ()

public Long getProjectRoleId ()

public Set<RoleActor> getRoleActors ()

public Set<RoleActor> getRoleActorsByType (String type)

public Set<User> getUsers ()

public DefaultRoleActors removeRoleActor (RoleActor roleActor)

Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters
roleActor the RoleActor to remove
Returns
  • a copy of this DefaultRoleActors with the removed RoleActor in its set of RoleActors, may be this if unchanged

public DefaultRoleActors removeRoleActors (Collection<? extends RoleActor> roleActors)

Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters
roleActors the RoleActor to remove
Returns
  • a copy of this DefaultRoleActors with the removed RoleActors in its set of RoleActors, may be this if unchanged.