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 ffff4abd8d3b87e095032175551075ce8c032141..8914a826437245650a493e10877853221931abb5 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/UserSet.java
+++ b/security/src/main/java/org/wamblee/usermgt/UserSet.java
@@ -1,90 +1,114 @@
 /*
  * Copyright 2005 the original author or authors.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
-
+ */
 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.
-     * @return New user.  
-     * @throws UserMgtException In case the user cannot be created. 
-     */ 
-    User createUser(String aUsername, String aPassword, Group aGroup) throws UserMgtException; 
-    
+     * Creates a user.
+     * 
+     * @param aUsername
+     *            User name.
+     * @param aPassword
+     *            Password.
+     * @param aGroup
+     *            Group.
+     * 
+     * @return New user.
+     * 
+     * @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. 
+     * user set.
+     * 
+     * @param aUser
+     *            Modified user.
      */
-    void userModified(User aUser); 
-    
+    void userModified(User aUser);
+
     /**
-     * Finds  user. 
-     * @param aName Username. 
-     * @return User or null if not found. 
+     * Finds user.
+     * 
+     * @param aName
+     *            Username.
+     * 
+     * @return User or null if not found.
      */
     User find(String aName);
-    
+
     /**
-     * Checks if a user exists. 
-     * @param aUser User. 
-     * @return True iff the user exists. 
+     * Checks if a user exists.
+     * 
+     * @param aUser
+     *            User.
+     * 
+     * @return True iff the user exists.
      */
-    boolean contains(User aUser); 
-    
+    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. 
+     * 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. 
+     * Removes a user. If the user does not exist, nothing happens.
+     * 
      * @param aUser
+     * 
      */
     boolean remove(User aUser);
-    
+
     /**
-     * Lists the current users. 
-     * @return Users. 
+     * Lists the current users.
+     * 
+     * @return Users.
      */
-    Set<User> list(); 
-    
+    Set<User> list();
+
     /**
-     * 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);
 
     /**
      * 
-     * @return The number of users. 
+     * @return The number of users.
      */
-    int size(); 
+    int size();
 }