org.apache.james.mailbox.model

Interface MailboxACL.MailboxACLRights

All Superinterfaces:

Iterable<MailboxACL.MailboxACLRight>

All Known Implementing Classes:

SimpleMailboxACL.Rfc4314Rights

Enclosing interface:

MailboxACL

public static interface MailboxACL.MailboxACLRights
extends Iterable<MailboxACL.MailboxACLRight>

Iterable set of MailboxACL.MailboxACLRights. Implementations may decide to support only a specific range of rights, e.g. the Standard Rights of RFC 4314 section 2.1. Implementations must not allow adding or removing of elements once this MailboxACLRights are initialized.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(MailboxACL.MailboxACLRight right) Tells whether this contains the given right.
MailboxACL.MailboxACLRights	except(MailboxACL.MailboxACLRights toRemove) Performs the set theoretic operation of relative complement of toRemove MailboxACLRights in this MailboxACLRights.
boolean	isEmpty() Tells if this set of rights is empty.
boolean	isSupported(MailboxACL.MailboxACLRight right) Tells whether the implementation supports the given right.
String	serialize() Returns a serialized form of this MailboxACL.MailboxACLRights as String.
MailboxACL.MailboxACLRights	union(MailboxACL.MailboxACLRights toAdd) Performs the set theoretic operation of union of this MailboxACLRights and toAdd MailboxACLRights.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

contains

boolean contains(MailboxACL.MailboxACLRight right)
                 throws UnsupportedRightException

Tells whether this contains the given right.

Parameters:

right -

Returns:

Throws:

UnsupportedRightException - iff the given right is not supported.

except

MailboxACL.MailboxACLRights except(MailboxACL.MailboxACLRights toRemove)
                                   throws UnsupportedRightException

Performs the set theoretic operation of relative complement of toRemove MailboxACLRights in this MailboxACLRights. A schematic example: "lrw".except("w") returns "lr". Implementations must return a new unmodifiable instance of MailboxACL.MailboxACLRights. However, implementations may decide to return this or toRemove parameter value in case the result would be equal to the respective one of those.

Parameters:

toRemove -

Returns:

Throws:

UnsupportedRightException

isEmpty

boolean isEmpty()

Tells if this set of rights is empty.

Returns:

true if there are no rights in this set; false otherwise.

isSupported

boolean isSupported(MailboxACL.MailboxACLRight right)

Tells whether the implementation supports the given right.

Parameters:

right -

Returns:

true if this supports the given right.

serialize

String serialize()

Returns a serialized form of this MailboxACL.MailboxACLRights as String.

Returns:

a String

union

MailboxACL.MailboxACLRights union(MailboxACL.MailboxACLRights toAdd)
                                  throws UnsupportedRightException

Performs the set theoretic operation of union of this MailboxACLRights and toAdd MailboxACLRights. A schematic example: "lr".union("rw") returns "lrw". Implementations must return a new unmodifiable instance of MailboxACL.MailboxACLRights. However, implementations may decide to return this or toAdd parameter value in case the result would be equal to the respective one of those.

Parameters:

toAdd -

Returns:

union of this and toAdd

Throws:

UnsupportedRightException