Package com.intellij.vcs.log

Interface VcsLogProvider

All Known Implementing Classes:

GitLogProvider, HgLogProvider

public interface VcsLogProvider

Provides the information needed to build the VCS log, such as the list of most recent commits with their parents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VcsLogProvider.DetailedLogData Container for the ordered list of commits together with their details, and references.
static interface	VcsLogProvider.LogData Container for references and users.
static interface	VcsLogProvider.Requirements

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<VcsLogProvider>	LOG_PROVIDER_EP

Method Summary

Modifier and Type	Method and Description
java.util.List<TimedVcsCommit>	getCommitsMatchingFilter(VirtualFile root, VcsLogFilterCollection filterCollection, int maxCount) Return commits, which correspond to the given filters.
java.util.Collection<java.lang.String>	getContainingBranches(VirtualFile root, Hash commitHash) Returns the list of names of branches/references which contain the given commit.
java.lang.String	getCurrentBranch(VirtualFile root) Returns currently checked out branch in given root, or null if not on any branch or provided root is not under version control.
VcsUser	getCurrentUser(VirtualFile root) Returns the name of current user as specified for the given root, or null if user didn't configure his name in the VCS settings.
default VcsLogDiffHandler	getDiffHandler() Returns VcsLogDiffHandler for this provider in order to support comparing commits and with local version from log-based file history.
default VcsLogFileHistoryHandler	getFileHistoryHandler() Returns VcsLogFileHistoryHandler for this provider in order to support Log-based file history.
<T> T	getPropertyValue(VcsLogProperties.VcsLogProperty<T> property) In order to tune log for it's VCS, provider may set value to one of the properties specified in VcsLogProperties.
VcsLogRefManager	getReferenceManager() Returns the VcsLogRefManager which will be used to identify positions of references in the log table, on the branches panel, and on the details panel.
VcsKey	getSupportedVcs() Returns the VCS which is supported by this provider.
default VirtualFile	getVcsRoot(Project project, VirtualFile detectedRoot, FilePath filePath) Returns the VCS root which should be used by the file history instead of the root found by standard mechanism (through mappings).
VcsLogProvider.LogData	readAllHashes(VirtualFile root, Consumer<? super TimedVcsCommit> commitConsumer) Reads the whole history.
VcsLogProvider.DetailedLogData	readFirstBlock(VirtualFile root, VcsLogProvider.Requirements requirements) Reads the most recent commits from the log together with all repository references. Commits should be at least topologically ordered, better considering commit time as well: they will be shown in the log in this order.
default java.util.List<? extends VcsFullCommitDetails>	readFullDetails(VirtualFile root, java.util.List<java.lang.String> hashes) Deprecated. replaced by readFullDetails(VirtualFile, List, Consumer).
default void	readFullDetails(VirtualFile root, java.util.List<java.lang.String> hashes, Consumer<? super VcsFullCommitDetails> commitConsumer) Reads full details for specified commits in the repository.
default void	readFullDetails(VirtualFile root, java.util.List<java.lang.String> hashes, Consumer<? super VcsFullCommitDetails> commitConsumer, boolean isForIndexing) Deprecated. replaced by readFullDetails(VirtualFile, List, Consumer).
java.util.List<? extends VcsCommitMetadata>	readMetadata(VirtualFile root, java.util.List<java.lang.String> hashes) Reads those details of the given commits, which are necessary to be shown in the log table and commit details.
default java.util.List<? extends VcsShortCommitDetails>	readShortDetails(VirtualFile root, java.util.List<java.lang.String> hashes) Deprecated. replaced by readMetadata(VirtualFile, List).
default Hash	resolveReference(java.lang.String ref, VirtualFile root) Checks that the given reference points to a valid commit in the given root, and returns the Hash of this commit.
Disposable	subscribeToRootRefreshEvents(java.util.Collection<? extends VirtualFile> roots, VcsLogRefresher refresher) Starts listening to events from the certain VCS, which should lead to the log refresh.

Field Detail

LOG_PROVIDER_EP

static final ExtensionPointName<VcsLogProvider> LOG_PROVIDER_EP

Method Detail

readFirstBlock

VcsLogProvider.DetailedLogData readFirstBlock(VirtualFile root,
                                              VcsLogProvider.Requirements requirements)
                                       throws VcsException

Reads the most recent commits from the log together with all repository references.
Commits should be at least topologically ordered, better considering commit time as well: they will be shown in the log in this order.

This method is called both on the startup and on refresh.

Parameters:

requirements - some limitations on commit data that should be returned, e.g. the number of commits.

Returns:

given amount of ordered commits and all references in the repository.

Throws:

VcsException

readAllHashes

VcsLogProvider.LogData readAllHashes(VirtualFile root,
                                     Consumer<? super TimedVcsCommit> commitConsumer)
                              throws VcsException

Reads the whole history.

Reports commits to the consumer to avoid creation & even temporary storage of a too large commits collection.

Returns:

all references and all authors in the repository.

Throws:

VcsException

readMetadata

java.util.List<? extends VcsCommitMetadata> readMetadata(VirtualFile root,
                                                         java.util.List<java.lang.String> hashes)
                                                  throws VcsException

Reads those details of the given commits, which are necessary to be shown in the log table and commit details.

Throws:

VcsException

readFullDetails

default void readFullDetails(VirtualFile root,
                             java.util.List<java.lang.String> hashes,
                             Consumer<? super VcsFullCommitDetails> commitConsumer)
                      throws VcsException

Reads full details for specified commits in the repository.

Reports commits to the consumer to avoid creation & even temporary storage of a too large commits collection.

Throws:

VcsException

getSupportedVcs

VcsKey getSupportedVcs()

Returns the VCS which is supported by this provider.

If there will be several VcsLogProviders which support the same VCS, only one will be chosen. It is undefined, which one.

getReferenceManager

VcsLogRefManager getReferenceManager()

Returns the VcsLogRefManager which will be used to identify positions of references in the log table, on the branches panel, and on the details panel.

subscribeToRootRefreshEvents

Disposable subscribeToRootRefreshEvents(java.util.Collection<? extends VirtualFile> roots,
                                        VcsLogRefresher refresher)

Starts listening to events from the certain VCS, which should lead to the log refresh.

Returns disposable that unsubscribes from events. Using a MessageBus topic can help to accomplish that.

Parameters:

roots - VCS roots which should be listened to.

refresher - The refresher which should be notified about the need of refresh.

Returns:

Disposable that unsubscribes from events on dispose.

getCommitsMatchingFilter

java.util.List<TimedVcsCommit> getCommitsMatchingFilter(VirtualFile root,
                                                        VcsLogFilterCollection filterCollection,
                                                        int maxCount)
                                                 throws VcsException

Return commits, which correspond to the given filters.

Parameters:

maxCount - maximum number of commits to request from the VCS, or -1 for unlimited.

Throws:

VcsException

getCurrentUser

VcsUser getCurrentUser(VirtualFile root)
                throws VcsException

Returns the name of current user as specified for the given root, or null if user didn't configure his name in the VCS settings.

Throws:

VcsException

getContainingBranches

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

Returns the list of names of branches/references which contain the given commit.

Throws:

VcsException

getPropertyValue

<T> T getPropertyValue(VcsLogProperties.VcsLogProperty<T> property)

In order to tune log for it's VCS, provider may set value to one of the properties specified in VcsLogProperties.

Type Parameters:

T - Type of property value.

Parameters:

property - Property instance to return value for.

Returns:

Property value or null if unset.

getCurrentBranch

java.lang.String getCurrentBranch(VirtualFile root)

Returns currently checked out branch in given root, or null if not on any branch or provided root is not under version control.

Parameters:

root - root for which branch is requested.

Returns:

branch that is currently checked out in the specified root.

getDiffHandler

default VcsLogDiffHandler getDiffHandler()

Returns VcsLogDiffHandler for this provider in order to support comparing commits and with local version from log-based file history.

Returns:

diff handler or null if unsupported.

getFileHistoryHandler

default VcsLogFileHistoryHandler getFileHistoryHandler()

Returns VcsLogFileHistoryHandler for this provider in order to support Log-based file history.

Returns:

file history handler or null if unsupported.

resolveReference

default Hash resolveReference(java.lang.String ref,
                              VirtualFile root)

Checks that the given reference points to a valid commit in the given root, and returns the Hash of this commit. Otherwise, if the reference is invalid, returns null.

getVcsRoot

default VirtualFile getVcsRoot(Project project,
                               VirtualFile detectedRoot,
                               FilePath filePath)

Returns the VCS root which should be used by the file history instead of the root found by standard mechanism (through mappings).

readShortDetails

@Deprecated
default java.util.List<? extends VcsShortCommitDetails> readShortDetails(VirtualFile root,
                                                                         java.util.List<java.lang.String> hashes)
                                                                  throws VcsException

Deprecated. replaced by readMetadata(VirtualFile, List).

Throws:

VcsException

readFullDetails

@Deprecated
default void readFullDetails(VirtualFile root,
                             java.util.List<java.lang.String> hashes,
                             Consumer<? super VcsFullCommitDetails> commitConsumer,
                             boolean isForIndexing)
                      throws VcsException

Deprecated. replaced by readFullDetails(VirtualFile, List, Consumer).

Throws:

VcsException

readFullDetails

@Deprecated
default java.util.List<? extends VcsFullCommitDetails> readFullDetails(VirtualFile root,
                                                                       java.util.List<java.lang.String> hashes)
                                                                throws VcsException

Deprecated. replaced by readFullDetails(VirtualFile, List, Consumer).

Throws:

VcsException