X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=security%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fusermgt%2FUserSet.java;h=6c04196c8b8d24a60a0cc764a4c008c533275c53;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=ac3f5a70b388024a82a05328fda9dd61a6f6187e;hpb=92e23e5ecf9614f2ab770a8cdedc0b21ddf1e127;p=utils

diff --git a/security/src/main/java/org/wamblee/usermgt/UserSet.java b/security/src/main/java/org/wamblee/usermgt/UserSet.java
index ac3f5a70..6c04196c 100644
--- a/security/src/main/java/org/wamblee/usermgt/UserSet.java
+++ b/security/src/main/java/org/wamblee/usermgt/UserSet.java
@@ -1,23 +1,23 @@
 /*
  * 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 
@@ -26,58 +26,96 @@ import java.util.Set;
  * @author Erik Brakkee
  */
 public interface UserSet {
-    
     /**
-     * Creates a user. 
-     * @param aUsername User name. 
-     * @param aPassword Password. 
+     * 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; 
-    
+     *
+     * @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. 
+     * Must be called whenever a user object has been modified to
+     * notify the 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.
+     *
+     * @return DOCUMENT ME!
      */
     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
+     *
+     * @return DOCUMENT ME!
      */
     boolean remove(User aUser);
-    
+
     /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+/**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+/**
      * Lists the current users. 
      * @return Users. 
      */
-    Set<User> list(); 
-    
+    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. 
@@ -85,8 +123,9 @@ public interface UserSet {
     Set<User> list(Group aGroup);
 
     /**
-     * 
-     * @return The number of users. 
+     * DOCUMENT ME!
+     *
+     * @return The number of users.
      */
-    int size(); 
+    int size();
 }