Removed DOCUMENT ME comments that were generated and applied source code

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

diff --git a/security/src/main/java/org/wamblee/usermgt/hibernate/HibernateUserSet.java b/security/src/main/java/org/wamblee/usermgt/hibernate/HibernateUserSet.java
index c0dd4021bdfe87a8bec830c8542f0c4126be0e6a..65f7b0b0e03fb3bcbe730ad0ecea38da33fa7589 100644 (file)
--- a/security/src/main/java/org/wamblee/usermgt/hibernate/HibernateUserSet.java
+++ b/security/src/main/java/org/wamblee/usermgt/hibernate/HibernateUserSet.java
@@ -34,36 +34,23 @@ import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 
-
 /**
  * User set backed by the database.
- *
+ * 
  * @author Erik Brakkee
  */
 public class HibernateUserSet extends AbstractUserSet {
-    /**
-     * DOCUMENT ME!
-     */
     private static final String QUERY_FIND_BY_NAME = "findUserByName";
 
-    /**
-     * DOCUMENT ME!
-     */
     private static final String QUERY_FIND_BY_GROUP_NAME = "findUserByGroupName";
 
-    /**
-     * DOCUMENT ME!
-     */
     private static final String PARAM_NAME = "name";
 
-    /**
-     * DOCUMENT ME!
-     */
     private static final String QUERY_COUNT_USERS = "countUsers";
 
     /**
-     * Cache of users. Every user in the cache has its password
-     * validator and encoder set.
+     * Cache of users. Every user in the cache has its password validator and
+     * encoder set.
      */
     private Cache<String, User> cache;
 
@@ -72,21 +59,24 @@ public class HibernateUserSet extends AbstractUserSet {
      */
     private HibernateSupport hibernateSupport;
 
-/**
+    /**
      * Constructs a user set backed by the database.
-     * @param aCache User cache to use. 
+     * 
+     * @param aCache
+     *            User cache to use.
      */
     public HibernateUserSet(Cache<String, User> aCache,
         NameValidator aPasswordValidator, MessageDigester aPasswordEncoder) {
         super(aPasswordValidator, aPasswordEncoder);
-        cache                = aCache;
-        hibernateSupport     = new HibernateSupport();
+        cache = aCache;
+        hibernateSupport = new HibernateSupport();
     }
 
     /**
      * Sets the session factory.
-     *
-     * @param aFactory Session factory.
+     * 
+     * @param aFactory
+     *            Session factory.
      */
     public void setSessionFactory(SessionFactory aFactory) {
         hibernateSupport.setSessionFactory(aFactory);
@@ -94,7 +84,7 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /**
      * Gets the hibernate template.
-     *
+     * 
      * @return Hibernate template.
      */
     private HibernateTemplate getHibernateTemplate() {
@@ -103,14 +93,9 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserSet#userModified(org.wamblee.usermgt.User)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aUser DOCUMENT ME!
-     */
     public void userModified(User aUser) {
         assert aUser.getPrimaryKey() != null;
         hibernateSupport.merge(aUser);
@@ -121,18 +106,9 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserSet#find(java.lang.String)
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     *
-     * @throws RuntimeException DOCUMENT ME!
-     */
     public User find(String aName) {
         User user = cache.get(aName);
 
@@ -140,8 +116,8 @@ public class HibernateUserSet extends AbstractUserSet {
             return user;
         }
 
-        List result = getHibernateTemplate()
-            .findByNamedQueryAndNamedParam(QUERY_FIND_BY_NAME, PARAM_NAME, aName);
+        List result = getHibernateTemplate().findByNamedQueryAndNamedParam(
+            QUERY_FIND_BY_NAME, PARAM_NAME, aName);
 
         if (result.size() > 1) {
             throw new RuntimeException(
@@ -161,32 +137,18 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (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 find(aUser.getName()) != 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) {
         assert aUser.getPrimaryKey() == null;
 
@@ -203,16 +165,9 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (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) {
         assert aUser.getPrimaryKey() != null;
 
@@ -231,17 +186,12 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (non-Javadoc)
-     *
+     * 
      * @see org.wamblee.usermgt.UserSet#list()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public Set<User> list() {
-        Set<User>  users = new TreeSet<User>();
-        List<User> list  = getHibernateTemplate().loadAll(User.class);
+        Set<User> users = new TreeSet<User>();
+        List<User> list = getHibernateTemplate().loadAll(User.class);
 
         for (User user : list) {
             setPasswordInfo(user);
@@ -253,21 +203,13 @@ public class HibernateUserSet extends AbstractUserSet {
 
     /*
      * (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>  users = new TreeSet<User>();
-        List<User> list  = getHibernateTemplate()
-            .findByNamedQueryAndNamedParam(QUERY_FIND_BY_GROUP_NAME,
-                PARAM_NAME, aGroup.getName());
+        Set<User> users = new TreeSet<User>();
+        List<User> list = getHibernateTemplate().findByNamedQueryAndNamedParam(
+            QUERY_FIND_BY_GROUP_NAME, PARAM_NAME, aGroup.getName());
 
         for (User user : list) {
             setPasswordInfo(user);
@@ -277,17 +219,14 @@ public class HibernateUserSet extends AbstractUserSet {
         return users;
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see org.wamblee.usermgt.UserSet#size()
      */
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public int size() {
-        Long result = (Long) getHibernateTemplate()
-            .findByNamedQuery(QUERY_COUNT_USERS).get(0);
+        Long result = (Long) getHibernateTemplate().findByNamedQuery(
+            QUERY_COUNT_USERS).get(0);
 
         return result.intValue();
     }