source code formatting.
[utils] / security / src / main / java / org / wamblee / usermgt / InMemoryUserSet.java
index 380d92c9fd9163470fd8cc1970e5aa0e970ad1d4..035dc993c636816f9b1c64d753ae0ab842edcf54 100644 (file)
@@ -1,25 +1,25 @@
 /*
  * 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 org.wamblee.security.encryption.MessageDigester;
+
 import java.util.Set;
 import java.util.TreeSet;
 
-import org.wamblee.security.encryption.MessageDigester;
 
 /**
  * In-memory user set.
@@ -27,106 +27,162 @@ import org.wamblee.security.encryption.MessageDigester;
  * @author Erik Brakkee
  */
 public class InMemoryUserSet extends AbstractUserSet {
-
     /**
-     * Users. All users in this set have their password validator and encoder set. 
+     * Users. All users in this set have their password validator and
+     * encoder set.
      */
     private Set<User> users;
 
-    /**
+/**
      * Constructs an empty user set.
      */
-    public InMemoryUserSet(NameValidator aPasswordValidator, MessageDigester aPasswordEncoder) {
+    public InMemoryUserSet(NameValidator aPasswordValidator,
+        MessageDigester aPasswordEncoder) {
         super(aPasswordValidator, aPasswordEncoder);
         users = new TreeSet<User>();
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#userModified(org.wamblee.usermgt.User)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aUser DOCUMENT ME!
+     */
     public void userModified(User aUser) {
         users.remove(aUser);
-       setPasswordInfo(aUser); 
+        setPasswordInfo(aUser);
         users.add(aUser);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#find(java.lang.String)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aName DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public User find(String aName) {
         for (User user : users) {
             if (user.getName().equals(aName)) {
                 return new User(user);
             }
         }
+
         return null;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#add(org.wamblee.usermgt.User)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aUser DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public boolean add(User aUser) {
         setPasswordInfo(aUser);
+
         return users.add(aUser);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#contains(org.wamblee.usermgt.User)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aUser DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public boolean contains(User aUser) {
         return users.contains(aUser);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#remove(org.wamblee.usermgt.User)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aUser DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public boolean remove(User aUser) {
         return users.remove(aUser);
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#list()
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public Set<User> list() {
         Set<User> list = new TreeSet<User>();
+
         for (User user : users) {
             list.add(new User(user));
         }
+
         return list;
     }
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see org.wamblee.usermgt.UserSet#list(org.wamblee.usermgt.Group)
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aGroup DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public Set<User> list(Group aGroup) {
         Set<User> result = new TreeSet<User>();
+
         for (User user : users) {
             if (user.getGroups().contains(aGroup)) {
                 result.add(new User(user));
             }
         }
+
         return result;
     }
-    
+
     /* (non-Javadoc)
      * @see org.wamblee.usermgt.UserSet#size()
      */
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public int size() {
-        return users.size(); 
+        return users.size();
     }
-
 }