[vcs-log] add javadoc
authorJulia Beliaeva <Julia.Beliaeva@jetbrains.com>
Sun, 23 Oct 2016 21:45:09 +0000 (00:45 +0300)
committerJulia Beliaeva <Julia.Beliaeva@jetbrains.com>
Sun, 23 Oct 2016 22:36:14 +0000 (01:36 +0300)
platform/vcs-log/impl/src/com/intellij/vcs/log/VcsLogStorage.java

index 6e3b81318ceb5f2fa94485adabc98cd3ac8999f7..01011e9d9f8bd3c55a98a11f4698bbe7a1823745 100644 (file)
@@ -21,27 +21,58 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
- * Map of {@link Hash} to <b>{@code int}</b>.
+ * Storage for various Log objects like CommitId or VcsRef
+ * which quantity is to big to keep them in memory.
+ * VcsLogStorage keeps a mapping from integers to those objects
+ * allowing to operate with integers, not the objects themselves.
  */
 public interface VcsLogStorage {
 
+  /**
+   * Returns an integer index that is a unique identifier for a commit with specified hash and root.
+   *
+   * @param hash commit hash
+   * @param root root of the repository for the commit
+   * @return a commit index
+   */
   int getCommitIndex(@NotNull Hash hash, @NotNull VirtualFile root);
 
+  /**
+   * Returns a commit for a specified index or null if this index does not correspond to any commit.
+   *
+   * @param commitIndex index of a commit
+   * @return commit identified by this index or null
+   */
   @Nullable
   CommitId getCommitId(int commitIndex);
 
   /**
    * Iterates over known commit ids to find the first one which satisfies given condition.
    *
-   * @return
+   * @return matching commit or null if no commit matches the given condition
    */
   @Nullable
   CommitId findCommitId(@NotNull Condition<CommitId> condition);
 
+  /**
+   * Returns an integer index that is a unique identifier for a reference.
+   *
+   * @param ref reference
+   * @return a reference index
+   */
   int getRefIndex(@NotNull VcsRef ref);
 
+  /**
+   * Returns a reference for a specified index or null if this index does not correspond to any reference.
+   *
+   * @param refIndex index of a reference
+   * @return reference identified by this index or null
+   */
   @Nullable
   VcsRef getVcsRef(int refIndex);
 
+  /**
+   * Forces data in the storage to be written on disk.
+   */
   void flush();
 }