com.atlassian.confluence.security
Class ContentPermissionSet

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.security.ContentPermissionSet

All Implemented Interfaces:

Cloneable

public class ContentPermissionSet
extends com.atlassian.core.bean.EntityObject

Constructor Summary

ContentPermissionSet()

ContentPermissionSet(String type, ContentEntityObject owningContent)

Method Summary

void	addContentPermission(ContentPermission contentPermission)
boolean	contains(ContentPermission contentPermission)
Collection	getAllExcept(Collection exclusions) Retrieve all the ContentPermissions in this set that do not exist in the given collection.
List	getGroupNames() Returns the names of all groups in this Content Permission Set as a list of Strings.
ContentEntityObject	getOwningContent()
String	getType()
List	getUserNames() Returns the names of all users in this Content Permission Set as a list of Strings.
boolean	isEmpty()
boolean	isPermitted(com.atlassian.user.User user)
Iterator	iterator()
void	removeContentPermission(ContentPermission contentPermission) Remove the given content permission from this set.
void	setOwningContent(ContentEntityObject owningContent) Hibernate setter.
void	setType(String type)
int	size()
String	toString()

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getId, getLastModificationDate, hashCode, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentPermissionSet

public ContentPermissionSet()

ContentPermissionSet

public ContentPermissionSet(String type,
                            ContentEntityObject owningContent)

Method Detail

addContentPermission

public void addContentPermission(ContentPermission contentPermission)

removeContentPermission

public void removeContentPermission(ContentPermission contentPermission)

Remove the given content permission from this set. Does nothing if the permission is not in the set.

isPermitted

public boolean isPermitted(com.atlassian.user.User user)

Returns:

true this user passes at least one of the permissions in this set

getType

public String getType()

setType

public void setType(String type)

isEmpty

public boolean isEmpty()

size

public int size()

contains

public boolean contains(ContentPermission contentPermission)

getOwningContent

public ContentEntityObject getOwningContent()

setOwningContent

public void setOwningContent(ContentEntityObject owningContent)

Hibernate setter.

iterator

public Iterator iterator()

Returns:

an unmodifiable iterator over the ContentPermissions in the set.

getGroupNames

public List getGroupNames()

Returns the names of all groups in this Content Permission Set as a list of Strings.

Returns:

the names of all groups in this Content Permission Set as a list of Strings.

getUserNames

public List getUserNames()

Returns the names of all users in this Content Permission Set as a list of Strings.

Returns:

the names of all users in this Content Permission Set as a list of Strings.

getAllExcept

public Collection getAllExcept(Collection exclusions)

Retrieve all the ContentPermissions in this set that do not exist in the given collection. The comparison is done according to ContentPermission.compareTo(Object).

Parameters:

exclusions - a collection of ContentPermissions

Returns:

the ContentPermissions that are in this object and not given collection.

toString

public String toString()

Overrides:

toString in class Object