Removed DOCUMENT ME comments that were generated and applied source code

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

diff --git a/security/src/main/java/org/wamblee/usermgt/UserAdministration.java b/security/src/main/java/org/wamblee/usermgt/UserAdministration.java
index 554590fde05aabc7ec00da0bdbd6d25bdd80ab05..a97199d4f57c7acdebe7631a51573bc485739358 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/UserAdministration.java
+++ b/security/src/main/java/org/wamblee/usermgt/UserAdministration.java
@@ -17,200 +17,189 @@ package org.wamblee.usermgt;
 
 import java.util.Set;
 
-
 /**
- * Interface for user administration. Manages the users and groups. 
- *
+ * Interface for user administration. Manages the users and groups.
+ * 
  * @author Erik Brakkee
  */
 public interface UserAdministration {
     /**
      * Creates a new user.
-     *
-     * @param aUser Username.
-     * @param aPassword Password.
-     * @param aGroup Group.
-     *
+     * 
+     * @param aUser
+     *            Username.
+     * @param aPassword
+     *            Password.
+     * @param aGroup
+     *            Group.
+     * 
      * @return User.
-     *
-     * @throws UserMgtException In case there is a conflict with an existing
-     *         user.
+     * 
+     * @throws UserMgtException
+     *             In case there is a conflict with an existing user.
      */
     User createUser(String aUser, String aPassword, Group aGroup)
         throws UserMgtException;
 
     /**
      * Creates a new group.
-     *
-     * @param aName Group name.
-     *
+     * 
+     * @param aName
+     *            Group name.
+     * 
      * @return Group
-     *
-     * @throws UserMgtException In case there is a conflict with an existing
-     *         group.
+     * 
+     * @throws UserMgtException
+     *             In case there is a conflict with an existing group.
      */
     Group createGroup(String aName) throws UserMgtException;
 
     /**
-     * DOCUMENT ME!
-     *
+     * 
      * @return Number of users.
      */
     int getUserCount();
 
     /**
-     * DOCUMENT ME!
-     *
+     * 
      * @return Number of groups.
      */
     int getGroupCount();
 
     /**
      * Must be called when the user is modified.
-     *
-     * @param aUser User.
+     * 
+     * @param aUser
+     *            User.
      */
     void userModified(User aUser);
 
     /**
      * Must be called when the group is modified.
-     *
-     * @param aGroup Group.
+     * 
+     * @param aGroup
+     *            Group.
      */
     void groupModified(Group aGroup);
 
     /**
      * Gets the user for a given name.
-     *
-     * @param aName User name.
-     *
+     * 
+     * @param aName
+     *            User name.
+     * 
      * @return User or null if not found.
      */
     User getUser(String aName);
 
     /**
      * Gets the group for a given group name.
-     *
-     * @param aName Group name.
-     *
+     * 
+     * @param aName
+     *            Group name.
+     * 
      * @return Group or null if not found.
      */
     Group getGroup(String aName);
 
     /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * Get the users. 
-     * @return All known users. 
+     * Get the users.
+     * 
+     * @return All known users.
      */
     Set<User> getUsers();
 
     /**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * DOCUMENT ME!
-     *
-     * @param aGroup DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * Gets the users for a given group. 
-     * @param aGroup Group. 
+     * Gets the users for a given group.
+     * 
+     * @param aGroup
+     *            Group.
      * @return Set of users (always non-null).
      */
     Set<User> getUsers(Group aGroup);
 
     /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-/**
-     * Gets all known groups. 
-     * @return Groups. 
+     * Gets all known groups.
+     * 
+     * @return Groups.
      */
     Set<Group> getGroups();
 
     /**
      * Renames a user.
-     *
-     * @param aUser User object for which user name must be changed.
-     * @param aUserName New user name.
-     *
-     * @throws UserMgtException In case the user is not known or the new user
-     *         name is already in use by another user.
+     * 
+     * @param aUser
+     *            User object for which user name must be changed.
+     * @param aUserName
+     *            New user name.
+     * 
+     * @throws UserMgtException
+     *             In case the user is not known or the new user name is already
+     *             in use by another user.
      */
     void renameUser(User aUser, String aUserName) throws UserMgtException;
 
     /**
      * Renames a group.
-     *
-     * @param aGroup Group to rename.
-     * @param aGroupName New name for the group.
-     *
-     * @throws UserMgtException In case the new group name is already used by
-     *         another group of if the existing group is unknown.
+     * 
+     * @param aGroup
+     *            Group to rename.
+     * @param aGroupName
+     *            New name for the group.
+     * 
+     * @throws UserMgtException
+     *             In case the new group name is already used by another group
+     *             of if the existing group is unknown.
      */
     void renameGroup(Group aGroup, String aGroupName) throws UserMgtException;
 
     /**
      * Removes the user.
-     *
-     * @param aUser User to remove.
-     *
-     * @throws UserMgtException In case the user does not exist.
+     * 
+     * @param aUser
+     *            User to remove.
+     * 
+     * @throws UserMgtException
+     *             In case the user does not exist.
      */
     void removeUser(User aUser) throws UserMgtException;
 
     /**
      * Removes the group.
-     *
-     * @param aGroup Group to remove.
-     *
-     * @throws UserMgtException In case there are still users that are in the
-     *         given group.
+     * 
+     * @param aGroup
+     *            Group to remove.
+     * 
+     * @throws UserMgtException
+     *             In case there are still users that are in the given group.
      */
     void removeGroup(Group aGroup) throws UserMgtException;
 
     /**
      * Adds a user to a group.
-     *
-     * @param aUser User.
-     * @param aGroup Group.
-     *
-     * @throws UserMgtException In case the user or group or not known or if
-     *         the user  is already part of the group.
+     * 
+     * @param aUser
+     *            User.
+     * @param aGroup
+     *            Group.
+     * 
+     * @throws UserMgtException
+     *             In case the user or group or not known or if the user is
+     *             already part of the group.
      */
     void addUserToGroup(User aUser, Group aGroup) throws UserMgtException;
 
     /**
      * Removes a user from a group.
-     *
-     * @param aUser User
-     * @param aGroup Group
-     *
-     * @throws UserMgtException In case the user or group are unknown or if the
-     *         user  is not part of the group.
-     */
-    void removeUserFromGroup(User aUser, Group aGroup)
-        throws UserMgtException;
+     * 
+     * @param aUser
+     *            User
+     * @param aGroup
+     *            Group
+     * 
+     * @throws UserMgtException
+     *             In case the user or group are unknown or if the user is not
+     *             part of the group.
+     */
+    void removeUserFromGroup(User aUser, Group aGroup) throws UserMgtException;
 }