improve javadoc of AbstractRepositoryManager

This commit is contained in:
Sebastian Sdorra
2012-12-08 14:57:44 +01:00
parent b7efb30419
commit 63d97d714c

View File

@@ -35,6 +35,9 @@ package sonia.scm.repository;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -47,8 +50,6 @@ import sonia.scm.util.Util;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.EnumMap;
import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
@@ -70,20 +71,21 @@ public abstract class AbstractRepositoryManager implements RepositoryManager
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * Sends a {@link RepositoryHookEvent} to the specified
* {@link RepositoryHook}.
* *
* *
* @param hook * @param hook receiving repository hook
* @param event * @param event hook event
*/ */
protected abstract void fireHookEvent(RepositoryHook hook, protected abstract void fireHookEvent(RepositoryHook hook,
RepositoryHookEvent event); RepositoryHookEvent event);
/** /**
* Method description * Registers a {@link RepositoryHook}
* *
* *
* @param hook * @param hook hook to register
*/ */
@Override @Override
public void addHook(RepositoryHook hook) public void addHook(RepositoryHook hook)
@@ -120,10 +122,10 @@ public abstract class AbstractRepositoryManager implements RepositoryManager
} }
/** /**
* Method description * Register a {@link Collection} of {@link RepositoryHook}s
* *
* *
* @param hooks * @param hooks hooks to register
*/ */
@Override @Override
public void addHooks(Collection<RepositoryHook> hooks) public void addHooks(Collection<RepositoryHook> hooks)
@@ -241,12 +243,10 @@ public abstract class AbstractRepositoryManager implements RepositoryManager
//~--- fields --------------------------------------------------------------- //~--- fields ---------------------------------------------------------------
/** Field description */ /** repository hooks map */
private Map<RepositoryHookType, List<RepositoryHook>> hookMap = private Map<RepositoryHookType, List<RepositoryHook>> hookMap =
new EnumMap<RepositoryHookType, Maps.newEnumMap(RepositoryHookType.class);
List<RepositoryHook>>(RepositoryHookType.class);
/** Field description */ /** repository listeners */
private Set<RepositoryListener> listenerSet = private Set<RepositoryListener> listenerSet = Sets.newHashSet();
new HashSet<RepositoryListener>();
} }