Package com.intellij.openapi.vcs

Interface CachingCommittedChangesProvider<T extends CommittedChangeList,U extends ChangeBrowserSettings>

All Superinterfaces:

CommittedChangesProvider<T,U>

All Known Implementing Classes:

CvsCommittedChangesProvider, SvnCommittedChangesProvider

public interface CachingCommittedChangesProvider<T extends CommittedChangeList,U extends ChangeBrowserSettings>
extends CommittedChangesProvider<T,U>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChangelistTitle() Returns the name of the "changelist" concept in the specified VCS (changelist, revision etc.)
int	getFormatVersion() Returns the current version of the binary data format that is read/written by the caching provider.
default java.util.Collection<FilePath>	getIncomingFiles(RepositoryLocation location) Returns the list of files under the specified repository root which may contain incoming changes.
default boolean	isChangeLocallyAvailable(FilePath filePath, VcsRevisionNumber localRevision, VcsRevisionNumber changeRevision, T changeList)
default boolean	isMaxCountSupported() Returns true if the underlying VCS allows to limit the number of loaded changes.
T	readChangeList(RepositoryLocation location, java.io.DataInput stream)
default boolean	refreshCacheByNumber() Returns true if the changelist number restriction should be used when refreshing the cache, or false if the date restriction should be used.
boolean	refreshIncomingWithCommitted() Returns true if a timer-based refresh of committed changes should be followed by refresh of incoming changes, so that, for example, changes from the wrong branch would be automatically removed from view.
void	writeChangeList(java.io.DataOutput stream, T list)

Methods inherited from interface com.intellij.openapi.vcs.CommittedChangesProvider

createActions, createDefaultSettings, createFilterUI, getColumns, getCommittedChanges, getForNonLocal, getLocationFor, getLocationFor, getOneList, getUnlimitedCountValue, getZipper, loadCommittedChanges, supportsIncomingChanges

Method Detail

getFormatVersion

int getFormatVersion()

Returns the current version of the binary data format that is read/written by the caching provider. If the format version loaded from the cache stream does not match the format version returned by the provider, the cache stream is discarded and changes are reloaded from server.

Returns:

binary format version.

writeChangeList

void writeChangeList(java.io.DataOutput stream,
                     T list)
              throws java.io.IOException

Throws:

java.io.IOException

readChangeList

T readChangeList(RepositoryLocation location,
                 java.io.DataInput stream)
          throws java.io.IOException

Throws:

java.io.IOException

isMaxCountSupported

default boolean isMaxCountSupported()

Returns true if the underlying VCS allows to limit the number of loaded changes. If the VCS does not support that, filtering by date will be used when initializing history cache.

Returns:

true if number limit is supported, false otherwise.

getIncomingFiles

default java.util.Collection<FilePath> getIncomingFiles(RepositoryLocation location)
                                                 throws VcsException

Returns the list of files under the specified repository root which may contain incoming changes. This method is an optional optimization: if null is returned, all files are checked through DiffProvider in a regular way.

Parameters:

location - the location where changes are requested.

Returns:

the files which may contain the changes, or null if the call is not supported.

Throws:

VcsException

refreshCacheByNumber

default boolean refreshCacheByNumber()

Returns true if the changelist number restriction should be used when refreshing the cache, or false if the date restriction should be used.

Returns:

true if restrict by number, false if restrict by date

getChangelistTitle

java.lang.String getChangelistTitle()

Returns the name of the "changelist" concept in the specified VCS (changelist, revision etc.)

Returns:

the name of the concept, or null if the VCS (like CVS) does not use changelist numbering.

isChangeLocallyAvailable

default boolean isChangeLocallyAvailable(FilePath filePath,
                                         VcsRevisionNumber localRevision,
                                         VcsRevisionNumber changeRevision,
                                         T changeList)

refreshIncomingWithCommitted

boolean refreshIncomingWithCommitted()

Returns true if a timer-based refresh of committed changes should be followed by refresh of incoming changes, so that, for example, changes from the wrong branch would be automatically removed from view.

Returns:

true if auto-refresh includes incoming changes refresh, false otherwise