svn commit: r828689 - /jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java

[an...@apache.org]

Author: angela
Date: Thu Oct 22 13:44:55 2009
New Revision: 828689

URL: http://svn.apache.org/viewvc?rev=828689&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java

Modified: jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java?rev=828689&r1=828688&r2=828689&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java (original)
+++ jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java Thu Oct 22 13:44:55 2009
@@ -27,7 +27,7 @@
     /**
      * @return Iterator of <code>Authorizable</code>s which are declared
      * members of this Group.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     Iterator<Authorizable> getDeclaredMembers() throws RepositoryException;
 
@@ -35,20 +35,23 @@
      * @return Iterator of <code>Authorizable</code>s which are members of
      * this Group. This includes both declared members and all authorizables
      * that are indirect group members.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     Iterator<Authorizable> getMembers() throws RepositoryException;
 
     /**
+     * @param authorizable The <code>Authorizable</code> to test.
      * @return true if the Authorizable to test is a direct or indirect member
      * of this Group.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean isMember(Authorizable authorizable) throws RepositoryException;
 
     /**
      * Add a member to this Group.
      *
+     * @param authorizable The <code>Authorizable</code> to be added as
+     * member to this group.
      * @return true if the <code>Authorizable</code> has successfully been added
      * to this Group, false otherwise (e.g. unknown implemention
      * or if it already is a member or if the passed authorizable is this
@@ -60,8 +63,10 @@
     /**
      * Remove a member from this Group.
      *
+     * @param authorizable The <code>Authorizable</code> to be removed from
+     * the list of group members.
      * @return true if the Authorizable was successfully removed. False otherwise.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean removeMember(Authorizable authorizable) throws RepositoryException;
 }