Package com.intellij.vcs.log

Interface VcsLog

All Known Implementing Classes:

VcsLogImpl

public interface VcsLog

Use this interface to access information available in the VCS Log.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getContainingBranches(Hash commitHash, VirtualFile root) Returns names of branches which contain the given commit, or null if this information is unavailable yet.
java.util.Map<VirtualFile,VcsLogProvider>	getLogProviders() Returns VcsLogProviders which are active in this log, i.e.
java.util.List<CommitId>	getSelectedCommits() Returns commits currently selected in the log.
java.util.List<VcsFullCommitDetails>	getSelectedDetails() Returns details of the selected commits.
java.util.List<VcsCommitMetadata>	getSelectedShortDetails() Returns metadata of the selected commit which are visible in the table.
java.util.concurrent.Future<java.lang.Boolean>	jumpToReference(java.lang.String reference) Asynchronously selects the commit node defined by the given reference (commit hash, branch or tag).
void	requestSelectedDetails(Consumer<? super java.util.List<VcsFullCommitDetails>> consumer) Sends a request to load details that are currently selected.

Method Detail

getSelectedCommits

java.util.List<CommitId> getSelectedCommits()

Returns commits currently selected in the log.

getSelectedShortDetails

java.util.List<VcsCommitMetadata> getSelectedShortDetails()

Returns metadata of the selected commit which are visible in the table.
Metadata can be retrieved from index, or loaded from the repository. Metadata is loaded faster than full details and since it is done while scrolling, there is a better chance that details for a commit are loaded when user selects it. This makes this method preferable to getSelectedDetails(). Still, check for LoadingDetails instance has to be done when using details from this list.

getSelectedDetails

java.util.List<VcsFullCommitDetails> getSelectedDetails()

Returns details of the selected commits. For commits that are not loaded an instance of LoadingDetails is returned.

requestSelectedDetails

void requestSelectedDetails(Consumer<? super java.util.List<VcsFullCommitDetails>> consumer)

Sends a request to load details that are currently selected. Details are loaded in background. If a progress indicator is specified it is used during loading process. After all details are loaded they are provided to the consumer in the EDT.

Parameters:

consumer - called in EDT after all details are loaded.

getContainingBranches

java.util.Collection<java.lang.String> getContainingBranches(Hash commitHash,
                                                             VirtualFile root)

Returns names of branches which contain the given commit, or null if this information is unavailable yet.

jumpToReference

java.util.concurrent.Future<java.lang.Boolean> jumpToReference(java.lang.String reference)

Asynchronously selects the commit node defined by the given reference (commit hash, branch or tag). Returns a future that allows to check if the commit was selected, wait for the selection while log is being loaded, or cancel commit selection.

getLogProviders

java.util.Map<VirtualFile,VcsLogProvider> getLogProviders()

Returns VcsLogProviders which are active in this log, i.e. which VCS roots are shown in the log.