Commits

Sebastian Sdorra committed d1e0df2

javadoc for AbstractUserManager class

Comments (0)

Files changed (1)

scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java

 import java.util.Set;
 
 /**
+ * Abstract base class for {@link UserManager} implementations. This class
+ * implements the listener methods of the {@link UserManager} interface.
  *
  * @author Sebastian Sdorra
  */
 {
 
   /**
-   * Method description
+   * Register a {@link UserListener}.
    *
    *
-   * @param listener
+   * @param listener {@link UserListener} to register
    */
   @Override
   public void addListener(UserListener listener)
   }
 
   /**
-   * Method description
+   * Register a {@link java.util.Collection} of {@link UserListener}s.
    *
    *
-   * @param listeners
+   * @param listeners listeners to register
    */
   @Override
   public void addListeners(Collection<UserListener> listeners)
   }
 
   /**
-   * Method description
+   * Remove specified {@link UserListener}.
    *
    *
-   * @param listener
+   * @param listener to remove
    */
   @Override
   public void removeListener(UserListener listener)
   }
 
   /**
-   * Method description
+   * Calls the {@link UserListener#onEvent(User,sonia.scm.HandlerEvent)}
+   * method of all registered listeners and send a {@link UserEvent} to
+   * the {@link ScmEventBus}.
    *
-   *
-   * @param user
-   * @param event
+   * @param user user that has changed
+   * @param event type of change event
    */
   protected void fireEvent(User user, HandlerEvent event)
   {