public class

Rights

extends Object
implements Cloneable
java.lang.Object
   ↳ com.google.code.com.sun.mail.imap.Rights

Class Overview

The Rights class represents the set of rights for an authentication identifier (for instance, a user or a group).

A right is represented by the Rights.Right inner class.

A set of standard rights are predefined (see RFC 2086). Most folder implementations are expected to support these rights. Some implementations may also support site-defined rights.

The following code sample illustrates how to examine your rights for a folder. 


 Rights rights = folder.myRights();

 // Check if I can write this folder
 if (rights.contains(Rights.Right.WRITE))
	System.out.println("Can write folder");

 // Now give Joe all my rights, except the ability to write the folder
 rights.remove(Rights.Right.WRITE);
 ACL acl = new ACL("joe", rights);
 folder.setACL(acl);

Summary

Nested Classes
class Rights.Right This inner class represents an individual right. 
Fields
private boolean[] rights
Public Constructors
Rights()
Construct an empty Rights object.
Rights(Rights rights)
Construct a Rights object initialized with the given rights.
Rights(String rights)
Construct a Rights object initialized with the given rights.
Rights(Rights.Right right)
Construct a Rights object initialized with the given right.
Public Methods
void add(Rights rights)
Add all the rights in the given Rights object to this Rights object.
void add(Rights.Right right)
Add the specified right to this Rights object.
Object clone()
Returns a clone of this Rights object.
boolean contains(Rights rights)
Check whether all the rights in the specified Rights object are present in this Rights object.
boolean contains(Rights.Right right)
Check whether the specified right is present in this Rights object.
boolean equals(Object obj)
Check whether the two Rights objects are equal.
Right[] getRights()
Return all the rights in this Rights object.
int hashCode()
Compute a hash code for this Rights object.
void remove(Rights.Right right)
Remove the specified right from this Rights object.
void remove(Rights rights)
Remove all rights in the given Rights object from this Rights object.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private boolean[] rights

Public Constructors

public Rights ()

Construct an empty Rights object.

public Rights (Rights rights)

Construct a Rights object initialized with the given rights.

Parameters
rights The rights for initialization

public Rights (String rights)

Construct a Rights object initialized with the given rights.

Parameters
rights The rights for initialization

public Rights (Rights.Right right)

Construct a Rights object initialized with the given right.

Parameters
right The right for initialization

Public Methods

public void add (Rights rights)

Add all the rights in the given Rights object to this Rights object.

Parameters
rights Rights object

public void add (Rights.Right right)

Add the specified right to this Rights object.

Parameters
right The right to add

public Object clone ()

Returns a clone of this Rights object.

public boolean contains (Rights rights)

Check whether all the rights in the specified Rights object are present in this Rights object.

Parameters
rights
Returns
  • true if all rights in the given Rights object are present, otherwise false.

public boolean contains (Rights.Right right)

Check whether the specified right is present in this Rights object.

Parameters
right
Returns
  • true of the given right is present, otherwise false.

public boolean equals (Object obj)

Check whether the two Rights objects are equal.

Parameters
obj
Returns
  • true if they're equal

public Right[] getRights ()

Return all the rights in this Rights object. Returns an array of size zero if no rights are set.

Returns
  • array of Rights.Right objects representing rights

public int hashCode ()

Compute a hash code for this Rights object.

Returns
  • the hash code

public void remove (Rights.Right right)

Remove the specified right from this Rights object.

Parameters
right The right to be removed

public void remove (Rights rights)

Remove all rights in the given Rights object from this Rights object.

Parameters
rights The rights to be removed

public String toString ()