From f3ec755ef5a32c8b75338c61db22272c8bb449c5 Mon Sep 17 00:00:00 2001 From: Julia Beliaeva Date: Thu, 12 Jul 2018 18:55:49 +0300 Subject: [PATCH] [vcs-log] introduce readMetadata method, deprecate readShortDetails --- .../api/src/com/intellij/vcs/log/VcsLogProvider.java | 11 ++++++++++- .../com/intellij/vcs/log/data/MiniDetailsGetter.java | 2 +- .../com/intellij/vcs/log/impl/TestVcsLogProvider.java | 2 +- plugins/git4idea/src/git4idea/log/GitLogProvider.java | 2 +- .../tests/git4idea/log/GitLogProviderTest.java | 2 +- .../src/org/zmlx/hg4idea/log/HgLogProvider.java | 2 +- 6 files changed, 15 insertions(+), 6 deletions(-) diff --git a/platform/vcs-log/api/src/com/intellij/vcs/log/VcsLogProvider.java b/platform/vcs-log/api/src/com/intellij/vcs/log/VcsLogProvider.java index b10378f1b92a..40282d43bb29 100644 --- a/platform/vcs-log/api/src/com/intellij/vcs/log/VcsLogProvider.java +++ b/platform/vcs-log/api/src/com/intellij/vcs/log/VcsLogProvider.java @@ -77,7 +77,16 @@ public interface VcsLogProvider { * Reads those details of the given commits, which are necessary to be shown in the log table. */ @NotNull - List readShortDetails(@NotNull VirtualFile root, @NotNull List hashes) throws VcsException; + @Deprecated + default List readShortDetails(@NotNull VirtualFile root, @NotNull List hashes) + throws VcsException { + return readMetadata(root, hashes); + } + + /** + * Reads those details of the given commits, which are necessary to be shown in the log table and commit details. + */ + List readMetadata(@NotNull VirtualFile root, @NotNull List hashes) throws VcsException; /** * Read full details of the given commits from the VCS. diff --git a/platform/vcs-log/impl/src/com/intellij/vcs/log/data/MiniDetailsGetter.java b/platform/vcs-log/impl/src/com/intellij/vcs/log/data/MiniDetailsGetter.java index bf9b2e6cf03e..f77c3642b405 100644 --- a/platform/vcs-log/impl/src/com/intellij/vcs/log/data/MiniDetailsGetter.java +++ b/platform/vcs-log/impl/src/com/intellij/vcs/log/data/MiniDetailsGetter.java @@ -46,7 +46,7 @@ public class MiniDetailsGetter extends AbstractDataGetter { @Override protected List readDetails(@NotNull VcsLogProvider logProvider, @NotNull VirtualFile root, @NotNull List hashes) throws VcsException { - return logProvider.readShortDetails(root, hashes); + return logProvider.readMetadata(root, hashes); } @NotNull diff --git a/platform/vcs-log/impl/test/com/intellij/vcs/log/impl/TestVcsLogProvider.java b/platform/vcs-log/impl/test/com/intellij/vcs/log/impl/TestVcsLogProvider.java index 55421d97cce7..9e5974d9cb61 100644 --- a/platform/vcs-log/impl/test/com/intellij/vcs/log/impl/TestVcsLogProvider.java +++ b/platform/vcs-log/impl/test/com/intellij/vcs/log/impl/TestVcsLogProvider.java @@ -141,7 +141,7 @@ public class TestVcsLogProvider implements VcsLogProvider { @NotNull @Override - public List readShortDetails(@NotNull VirtualFile root, @NotNull List hashes) { + public List readMetadata(@NotNull VirtualFile root, @NotNull List hashes) { throw new UnsupportedOperationException(); } diff --git a/plugins/git4idea/src/git4idea/log/GitLogProvider.java b/plugins/git4idea/src/git4idea/log/GitLogProvider.java index 24c79b84baf4..63b432571d2f 100644 --- a/plugins/git4idea/src/git4idea/log/GitLogProvider.java +++ b/plugins/git4idea/src/git4idea/log/GitLogProvider.java @@ -353,7 +353,7 @@ public class GitLogProvider implements VcsLogProvider { @NotNull @Override - public List readShortDetails(@NotNull final VirtualFile root, @NotNull List hashes) + public List readMetadata(@NotNull final VirtualFile root, @NotNull List hashes) throws VcsException { return GitLogUtil.collectShortDetails(myProject, myVcs, root, hashes); } diff --git a/plugins/git4idea/tests/git4idea/log/GitLogProviderTest.java b/plugins/git4idea/tests/git4idea/log/GitLogProviderTest.java index c6c5a89c6ea4..15d13ec6adfb 100644 --- a/plugins/git4idea/tests/git4idea/log/GitLogProviderTest.java +++ b/plugins/git4idea/tests/git4idea/log/GitLogProviderTest.java @@ -240,7 +240,7 @@ public class GitLogProviderTest extends GitSingleRepoTest { final List hashes = ContainerUtil.newArrayList(); myLogProvider.readAllHashes(projectRoot, timedVcsCommit -> hashes.add(timedVcsCommit.getId().asString())); - List shortDetails = myLogProvider.readShortDetails(projectRoot, hashes); + List shortDetails = myLogProvider.readMetadata(projectRoot, hashes); Function shortDetailsToString = getShortDetailsToString(); assertOrderedEquals(ContainerUtil.map(shortDetails, shortDetailsToString), ContainerUtil.map(log, shortDetailsToString)); diff --git a/plugins/hg4idea/src/org/zmlx/hg4idea/log/HgLogProvider.java b/plugins/hg4idea/src/org/zmlx/hg4idea/log/HgLogProvider.java index d5c7d678514d..b51c87a9a01d 100644 --- a/plugins/hg4idea/src/org/zmlx/hg4idea/log/HgLogProvider.java +++ b/plugins/hg4idea/src/org/zmlx/hg4idea/log/HgLogProvider.java @@ -127,7 +127,7 @@ public class HgLogProvider implements VcsLogProvider { @NotNull @Override - public List readShortDetails(@NotNull VirtualFile root, @NotNull List hashes) + public List readMetadata(@NotNull VirtualFile root, @NotNull List hashes) throws VcsException { return HgHistoryUtil.readCommitMetadata(myProject, root, hashes); }