Removed DOCUMENT ME comments that were generated and applied source code
[utils] / security / src / main / java / org / wamblee / usermgt / InMemoryUserSet.java
index 0ccbba7237198b8341c97ea93f91ed1473200038..d0e55a4879d74dab1d4f6956481e6a675648c0ac 100644 (file)
@@ -1,42 +1,44 @@
 /*
  * 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.
+ * 
+ * @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;
+    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>();
+        users = new TreeSet<User>();
     }
 
     /*
@@ -45,9 +47,9 @@ public class InMemoryUserSet extends AbstractUserSet {
      * @see org.wamblee.usermgt.UserSet#userModified(org.wamblee.usermgt.User)
      */
     public void userModified(User aUser) {
-        _users.remove(aUser);
-       setPasswordInfo(aUser); 
-        _users.add(aUser);
+        users.remove(aUser);
+        setPasswordInfo(aUser);
+        users.add(aUser);
     }
 
     /*
@@ -56,11 +58,12 @@ public class InMemoryUserSet extends AbstractUserSet {
      * @see org.wamblee.usermgt.UserSet#find(java.lang.String)
      */
     public User find(String aName) {
-        for (User user : _users) {
+        for (User user : users) {
             if (user.getName().equals(aName)) {
                 return new User(user);
             }
         }
+
         return null;
     }
 
@@ -71,7 +74,8 @@ public class InMemoryUserSet extends AbstractUserSet {
      */
     public boolean add(User aUser) {
         setPasswordInfo(aUser);
-        return _users.add(aUser);
+
+        return users.add(aUser);
     }
 
     /*
@@ -80,7 +84,7 @@ public class InMemoryUserSet extends AbstractUserSet {
      * @see org.wamblee.usermgt.UserSet#contains(org.wamblee.usermgt.User)
      */
     public boolean contains(User aUser) {
-        return _users.contains(aUser);
+        return users.contains(aUser);
     }
 
     /*
@@ -89,7 +93,7 @@ public class InMemoryUserSet extends AbstractUserSet {
      * @see org.wamblee.usermgt.UserSet#remove(org.wamblee.usermgt.User)
      */
     public boolean remove(User aUser) {
-        return _users.remove(aUser);
+        return users.remove(aUser);
     }
 
     /*
@@ -99,9 +103,11 @@ public class InMemoryUserSet extends AbstractUserSet {
      */
     public Set<User> list() {
         Set<User> list = new TreeSet<User>();
-        for (User user : _users) {
+
+        for (User user : users) {
             list.add(new User(user));
         }
+
         return list;
     }
 
@@ -112,19 +118,22 @@ public class InMemoryUserSet extends AbstractUserSet {
      */
     public Set<User> list(Group aGroup) {
         Set<User> result = new TreeSet<User>();
-        for (User user : _users) {
+
+        for (User user : users) {
             if (user.getGroups().contains(aGroup)) {
                 result.add(new User(user));
             }
         }
+
         return result;
     }
-    
-    /* (non-Javadoc)
+
+    /*
+     * (non-Javadoc)
+     * 
      * @see org.wamblee.usermgt.UserSet#size()
      */
     public int size() {
-        return _users.size(); 
+        return users.size();
     }
-
 }