diff --git a/scm-core/src/main/java/sonia/scm/store/DataStore.java b/scm-core/src/main/java/sonia/scm/store/DataStore.java index 49676d29c6..897a6d4ab3 100644 --- a/scm-core/src/main/java/sonia/scm/store/DataStore.java +++ b/scm-core/src/main/java/sonia/scm/store/DataStore.java @@ -36,41 +36,44 @@ package sonia.scm.store; import java.util.Map; /** + * A DataStore can be used to store any structured data. Note: the default + * implementation use JAXB to marshall the items. * * @author Sebastian Sdorra * @since 1.23 * - * @param + * @param type of store items */ public interface DataStore extends StoreBase { /** - * Method description + * Put a item with automatically generated id to the store. * * - * @param item + * @param item item to store * - * @return + * @return automatically generated id of the item */ public String put(T item); /** - * Method description + * Put the item with the given id to the store. * * - * @param id - * @param item + * @param id id of the item + * @param item item to store */ public void put(String id, T item); //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns a map of all stored items. The key of the map is the item id and + * the value is item. * * - * @return + * @return map of all stored items */ public Map getAll(); } diff --git a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java index 02e8aa3251..699ae3ede5 100644 --- a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java @@ -32,6 +32,8 @@ package sonia.scm.store; /** + * The DataStoreFactory can be used to create new or get existing + * {@link DataStore}s. * * @author Sebastian Sdorra * @since 1.23 @@ -40,14 +42,14 @@ public interface DataStoreFactory { /** - * Method description + * Get an existing {@link DataStore} or create a new one. * * - * @param type - * @param name - * @param + * @param type type of the store objects + * @param name name of the store + * @param type of the store objects * - * @return + * @return {@link DataStore} with given name and type */ public DataStore getStore(Class type, String name); }