Removed DOCUMENT ME comments that were generated and applied source code
[utils] / security / src / main / java / org / wamblee / usermgt / UserMgtException.java
index 8614e0a4fca2a453db3ac788ad22ba69748423fb..0f7db17cb382585ffa8186468c8959ce78c3e302 100644 (file)
@@ -17,22 +17,19 @@ package org.wamblee.usermgt;
 
 import java.util.EnumMap;
 
-
 /**
  * User management exception.
- *
+ * 
  * @author Erik Brakkee
  */
 public class UserMgtException extends Exception {
-    /**
-     * DOCUMENT ME!
-     */
     static final long serialVersionUID = 5585349754997507529L;
 
     /**
      * Mapping of enum to exception message text.
      */
-    private static final EnumMap<Reason, String> MESSAGES = new EnumMap<Reason, String>(Reason.class);
+    private static final EnumMap<Reason, String> MESSAGES = new EnumMap<Reason, String>(
+        Reason.class);
 
     static {
         MESSAGES.put(Reason.UNKNOWN_USER, "Unknown user");
@@ -65,57 +62,47 @@ public class UserMgtException extends Exception {
      */
     private Group group;
 
-/**
+    /**
      * Creates a new UserMgtException object.
-     *
-     * @param aCause DOCUMENT ME!
-     * @param aMessage DOCUMENT ME!
+     * 
      */
     public UserMgtException(Reason aCause, String aMessage) {
         super(MESSAGES.get(aCause) + ": " + aMessage);
         cause = aCause;
     }
 
-/**
+    /**
      * Creates a new UserMgtException object.
-     *
-     * @param aCause DOCUMENT ME!
-     * @param aUser DOCUMENT ME!
+     * 
      */
     public UserMgtException(Reason aCause, User aUser) {
         this(aCause, "for user '" + aUser.getName() + "'");
         user = aUser;
     }
 
-/**
+    /**
      * Creates a new UserMgtException object.
-     *
-     * @param aCause DOCUMENT ME!
-     * @param aGroup DOCUMENT ME!
+     * 
      */
     public UserMgtException(Reason aCause, Group aGroup) {
         this(aCause, "for group '" + aGroup.getName() + "'");
         group = aGroup;
     }
 
-/**
+    /**
      * Creates a new UserMgtException object.
-     *
-     * @param aCause DOCUMENT ME!
-     * @param aUser DOCUMENT ME!
-     * @param aGroup DOCUMENT ME!
+     * 
      */
     public UserMgtException(Reason aCause, User aUser, Group aGroup) {
-        this(aCause,
-            "for user '" + aUser.getName() + "' and group '" + aGroup.getName()
-            + "'");
-        user      = aUser;
-        group     = aGroup;
+        this(aCause, "for user '" + aUser.getName() + "' and group '" +
+            aGroup.getName() + "'");
+        user = aUser;
+        group = aGroup;
     }
 
     /**
      * Gets the cause of the problem.
-     *
+     * 
      * @return Cause.
      */
     public Reason getReason() {
@@ -124,7 +111,7 @@ public class UserMgtException extends Exception {
 
     /**
      * Gets the user for which the problem occurred.
-     *
+     * 
      * @return User or null if not applicable.
      */
     public User getUser() {
@@ -133,28 +120,18 @@ public class UserMgtException extends Exception {
 
     /**
      * Gets the group for which the problem occured.
-     *
+     * 
      * @return Group or null if not applicable.
      */
     public Group getGroup() {
         return group;
     }
 
-/**
-     * Possible causes for the exception. 
-     *
+    /**
+     * Possible causes for the exception.
+     * 
      */
-    public enum Reason {UNKNOWN_USER,
-        UNKNOWN_GROUP,
-        DUPLICATE_USER,
-        DUPLICATE_GROUP,
-        USER_ALREADY_IN_GROUP,
-        USER_NOT_IN_GROUP,
-        TRIVIAL_RENAME,
-        INVALID_PASSWORD,
-        GROUP_STILL_OCCUPIED,
-        USER_MUST_BE_IN_A_GROUP,
-        INVALID_USERNAME,
-        INVALID_GROUPNAME;
+    public enum Reason {
+        UNKNOWN_USER, UNKNOWN_GROUP, DUPLICATE_USER, DUPLICATE_GROUP, USER_ALREADY_IN_GROUP, USER_NOT_IN_GROUP, TRIVIAL_RENAME, INVALID_PASSWORD, GROUP_STILL_OCCUPIED, USER_MUST_BE_IN_A_GROUP, INVALID_USERNAME, INVALID_GROUPNAME;
     }
 }