javadoc for AbstractUserManager class

This commit is contained in:
Sebastian Sdorra
2012-12-08 14:42:20 +01:00
parent aed072dda7
commit 57276d093b

View File

@@ -45,6 +45,8 @@ import java.util.HashSet;
import java.util.Set; 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 * @author Sebastian Sdorra
*/ */
@@ -52,10 +54,10 @@ public abstract class AbstractUserManager implements UserManager
{ {
/** /**
* Method description * Register a {@link UserListener}.
* *
* *
* @param listener * @param listener {@link UserListener} to register
*/ */
@Override @Override
public void addListener(UserListener listener) public void addListener(UserListener listener)
@@ -64,10 +66,10 @@ public abstract class AbstractUserManager implements UserManager
} }
/** /**
* Method description * Register a {@link java.util.Collection} of {@link UserListener}s.
* *
* *
* @param listeners * @param listeners listeners to register
*/ */
@Override @Override
public void addListeners(Collection<UserListener> listeners) public void addListeners(Collection<UserListener> listeners)
@@ -76,10 +78,10 @@ public abstract class AbstractUserManager implements UserManager
} }
/** /**
* Method description * Remove specified {@link UserListener}.
* *
* *
* @param listener * @param listener to remove
*/ */
@Override @Override
public void removeListener(UserListener listener) public void removeListener(UserListener listener)
@@ -88,11 +90,12 @@ public abstract class AbstractUserManager implements UserManager
} }
/** /**
* 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 user that has changed
* @param user * @param event type of change event
* @param event
*/ */
protected void fireEvent(User user, HandlerEvent event) protected void fireEvent(User user, HandlerEvent event)
{ {