Removed DOCUMENT ME comments that were generated and applied source code

[utils] / security / src / main / java / org / wamblee / usermgt / UserSet.java

diff --git a/security/src/main/java/org/wamblee/usermgt/UserSet.java b/security/src/main/java/org/wamblee/usermgt/UserSet.java
index 6c04196c8b8d24a60a0cc764a4c008c533275c53..8914a826437245650a493e10877853221931abb5 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/UserSet.java
+++ b/security/src/main/java/org/wamblee/usermgt/UserSet.java
@@ -17,114 +17,97 @@ package org.wamblee.usermgt;
 
 import java.util.Set;
 
-
 /**
- * Represents a set of users.
- * Typical implementations would be an implementation based on a static configuration file or 
- * an implementation backed by a database.  
- *
+ * Represents a set of users. Typical implementations would be an implementation
+ * based on a static configuration file or an implementation backed by a
+ * database.
+ * 
  * @author Erik Brakkee
  */
 public interface UserSet {
     /**
      * Creates a user.
-     *
-     * @param aUsername User name.
-     * @param aPassword Password.
-     * @param aGroup Group.
-     *
+     * 
+     * @param aUsername
+     *            User name.
+     * @param aPassword
+     *            Password.
+     * @param aGroup
+     *            Group.
+     * 
      * @return New user.
-     *
-     * @throws UserMgtException In case the user cannot be created.
+     * 
+     * @throws UserMgtException
+     *             In case the user cannot be created.
      */
     User createUser(String aUsername, String aPassword, Group aGroup)
         throws UserMgtException;
 
     /**
-     * Must be called whenever a user object has been modified to
-     * notify the user set.
-     *
-     * @param aUser Modified user.
+     * Must be called whenever a user object has been modified to notify the
+     * user set.
+     * 
+     * @param aUser
+     *            Modified user.
      */
     void userModified(User aUser);
 
     /**
-     * Finds  user.
-     *
-     * @param aName Username.
-     *
+     * Finds user.
+     * 
+     * @param aName
+     *            Username.
+     * 
      * @return User or null if not found.
      */
     User find(String aName);
 
     /**
      * Checks if a user exists.
-     *
-     * @param aUser User.
-     *
+     * 
+     * @param aUser
+     *            User.
+     * 
      * @return True iff the user exists.
      */
     boolean contains(User aUser);
 
     /**
-     * Adds a user. If the user already exists, the user details are
-     * updated with that of the specified user object.
-     *
-     * @param aUser User to add.
-     *
-     * @return DOCUMENT ME!
+     * Adds a user. If the user already exists, the user details are updated
+     * with that of the specified user object.
+     * 
+     * @param aUser
+     *            User to add.
+     * 
      */
     boolean add(User aUser);
 
     /**
      * Removes a user. If the user does not exist, nothing happens.
-     *
+     * 
      * @param aUser
-     *
-     * @return DOCUMENT ME!
+     * 
      */
     boolean remove(User aUser);
 
     /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * Lists the current users. 
-     * @return Users. 
+     * Lists the current users.
+     * 
+     * @return Users.
      */
     Set<User> list();
 
     /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * Lists the users belonging to a particular group. 
-     * @param aGroup Group. 
-     * @return Groups. 
+     * Lists the users belonging to a particular group.
+     * 
+     * @param aGroup
+     *            Group.
+     * @return Groups.
      */
     Set<User> list(Group aGroup);
 
     /**
-     * DOCUMENT ME!
-     *
+     * 
      * @return The number of users.
      */
     int size();