Removed DOCUMENT ME comments that were generated and applied source code

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

diff --git a/security/src/main/java/org/wamblee/usermgt/UserAdministrationImpl.java b/security/src/main/java/org/wamblee/usermgt/UserAdministrationImpl.java
index 071791b258d9f806ebce0e24b1e563bc34631868..6e1c24937726574d621760dd533d74dd70153bb9 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/UserAdministrationImpl.java
+++ b/security/src/main/java/org/wamblee/usermgt/UserAdministrationImpl.java
@@ -24,10 +24,9 @@ import static org.wamblee.usermgt.UserMgtException.Reason.UNKNOWN_USER;
 
 import java.util.Set;
 
-
 /**
  * Administration of users and groups.
- *
+ * 
  * @author Erik Brakkee
  */
 public class UserAdministrationImpl implements UserAdministration {
@@ -51,34 +50,23 @@ public class UserAdministrationImpl implements UserAdministration {
      */
     private NameValidator groupValidator;
 
-/**
+    /**
      * Constructs empty user administration.
      * 
      */
     public UserAdministrationImpl(UserSet aUsers, GroupSet aGroups,
         NameValidator aUserValidator, NameValidator aGroupValidator) {
-        users              = aUsers;
-        groups             = aGroups;
-        userValidator      = aUserValidator;
-        groupValidator     = aGroupValidator;
+        users = aUsers;
+        groups = aGroups;
+        userValidator = aUserValidator;
+        groupValidator = aGroupValidator;
     }
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#createUser(java.lang.String,
-     *      java.lang.String)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     * @param aPassword DOCUMENT ME!
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * java.lang.String)
      */
     public User createUser(String aUser, String aPassword, Group aGroup)
         throws UserMgtException {
@@ -92,18 +80,9 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#createGroup(java.lang.String)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
-     */
     public Group createGroup(String aName) throws UserMgtException {
         groupValidator.validate(aName);
 
@@ -120,13 +99,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#userModified(org.wamblee.usermgt.User)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#userModified(org.wamblee.usermgt
+     * .User)
      */
     public void userModified(User aUser) {
         users.userModified(aUser);
@@ -134,13 +110,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#groupModified(org.wamblee.usermgt.Group)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#groupModified(org.wamblee.usermgt
+     * .Group)
      */
     public void groupModified(Group aGroup) {
         groups.groupModified(aGroup);
@@ -148,61 +121,37 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getUser(java.lang.String)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public User getUser(String aName) {
         return users.find(aName);
     }
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getGroup(java.lang.String)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public Group getGroup(String aName) {
         return groups.find(aName);
     }
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getUsers()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public Set<User> getUsers() {
         return users.list();
     }
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#getUsers(org.wamblee.usermgt.Group)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#getUsers(org.wamblee.usermgt.Group
+     * )
      */
     public Set<User> getUsers(Group aGroup) {
         return users.list(aGroup);
@@ -210,29 +159,19 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getGroups()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public Set<Group> getGroups() {
         return groups.list();
     }
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#removeUser(org.wamblee.usermgt.User)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#removeUser(org.wamblee.usermgt
+     * .User)
      */
     public void removeUser(User aUser) throws UserMgtException {
         checkUser(aUser);
@@ -241,15 +180,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#removeGroup(org.wamblee.usermgt.Group)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#removeGroup(org.wamblee.usermgt
+     * .Group)
      */
     public void removeGroup(Group aGroup) throws UserMgtException {
         checkGroup(aGroup);
@@ -263,17 +197,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#renameUser(org.wamblee.usermgt.User,
-     *      java.lang.String)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     * @param aUserName DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#renameUser(org.wamblee.usermgt
+     * .User, java.lang.String)
      */
     public void renameUser(User aUser, String aUserName)
         throws UserMgtException {
@@ -297,17 +224,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#renameGroup(org.wamblee.usermgt.Group,
-     *      java.lang.String)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     * @param aGroupName DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#renameGroup(org.wamblee.usermgt
+     * .Group, java.lang.String)
      */
     public void renameGroup(Group aGroup, String aGroupName)
         throws UserMgtException {
@@ -331,17 +251,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#addUserToGroup(org.wamblee.usermgt.User,
-     *      org.wamblee.usermgt.Group)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     * @param aGroup DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#addUserToGroup(org.wamblee.usermgt
+     * .User, org.wamblee.usermgt.Group)
      */
     public void addUserToGroup(User aUser, Group aGroup)
         throws UserMgtException {
@@ -353,17 +266,10 @@ public class UserAdministrationImpl implements UserAdministration {
 
     /*
      * (non-Javadoc)
-     *
-     * @see org.wamblee.usermgt.UserAdministration#removeUserFromGroup(org.wamblee.usermgt.User,
-     *      org.wamblee.usermgt.Group)
-     */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     * @param aGroup DOCUMENT ME!
-     *
-     * @throws UserMgtException DOCUMENT ME!
+     * 
+     * @see
+     * org.wamblee.usermgt.UserAdministration#removeUserFromGroup(org.wamblee
+     * .usermgt.User, org.wamblee.usermgt.Group)
      */
     public void removeUserFromGroup(User aUser, Group aGroup)
         throws UserMgtException {
@@ -374,10 +280,9 @@ public class UserAdministrationImpl implements UserAdministration {
     }
 
     /**
-     * DOCUMENT ME!
-     *
+     * 
      * @param aUser
-     *
+     * 
      * @throws UserMgtException
      */
     private void checkUser(User aUser) throws UserMgtException {
@@ -387,10 +292,9 @@ public class UserAdministrationImpl implements UserAdministration {
     }
 
     /**
-     * DOCUMENT ME!
-     *
+     * 
      * @param aGroup
-     *
+     * 
      * @throws UserMgtException
      */
     private void checkGroup(Group aGroup) throws UserMgtException {
@@ -399,26 +303,20 @@ public class UserAdministrationImpl implements UserAdministration {
         }
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getUserCount()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public int getUserCount() {
         return users.size();
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see org.wamblee.usermgt.UserAdministration#getGroupCount()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public int getGroupCount() {
         return groups.size();
     }