Package com.intellij.openapi.vcs.annotate

Class FileAnnotation

java.lang.Object

com.intellij.openapi.vcs.annotate.FileAnnotation

Direct Known Subclasses:

BaseSvnFileAnnotation, CvsFileAnnotation, GitFileAnnotation, HgAnnotation

public abstract class FileAnnotation
extends java.lang.Object

Represents annotations ("vcs blame") for some file in a specific revision

See Also:

AnnotationProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileAnnotation.AuthorsMappingProvider
static interface	FileAnnotation.CurrentFileRevisionProvider
static interface	FileAnnotation.PreviousFileRevisionProvider
static interface	FileAnnotation.RevisionChangesProvider
static interface	FileAnnotation.RevisionsOrderProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileAnnotation(Project project)

Method Summary

Modifier and Type	Method and Description
void	close() Notify that annotations should be closed
abstract void	dispose() This method is invoked when the file annotation is no longer used.
static java.lang.String	formatDate(java.util.Date date)
abstract java.lang.String	getAnnotatedContent()
AnnotationSourceSwitcher	getAnnotationSourceSwitcher() Allows to switch between different representation modes.
abstract LineAnnotationAspect []	getAspects() Get annotation aspects.
FileAnnotation.AuthorsMappingProvider	getAuthorsMappingProvider()
FileAnnotation.CurrentFileRevisionProvider	getCurrentFileRevisionProvider()
abstract VcsRevisionNumber	getCurrentRevision()
VirtualFile	getFile()
java.lang.String	getHtmlToolTip(int lineNumber)
abstract int	getLineCount()
abstract java.util.Date	getLineDate(int lineNumber)
abstract VcsRevisionNumber	getLineRevisionNumber(int lineNumber)
FileAnnotation.PreviousFileRevisionProvider	getPreviousFileRevisionProvider()
Project	getProject()
abstract java.util.List<VcsFileRevision>	getRevisions()
FileAnnotation.RevisionChangesProvider	getRevisionsChangesProvider()
FileAnnotation.RevisionsOrderProvider	getRevisionsOrderProvider()
abstract java.lang.String	getToolTip(int lineNumber) The tooltip that is shown over annotation.
VcsKey	getVcsKey()
boolean	isBaseRevisionChanged(VcsRevisionNumber number)
boolean	isClosed()
VcsRevisionNumber	originalRevision(int lineNumber)
void	reload(FileAnnotation newFileAnnotation) Notify that annotation information has changed, and should be updated.
boolean	revisionsNotEmpty() Deprecated. does nothing
void	setCloser(java.lang.Runnable closer)
void	setReloader(Consumer<? super FileAnnotation> reloader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileAnnotation

protected FileAnnotation(Project project)

Method Detail

getProject

public Project getProject()

getVcsKey

public VcsKey getVcsKey()

getFile

public VirtualFile getFile()

Returns:

annotated file

If annotations are called on a local file, it can be this file. If annotations are called on a specific revision, it can be corresponding VcsVirtualFile. Note: file content might differ from content in annotated revision getAnnotatedContent().

getAnnotatedContent

public abstract java.lang.String getAnnotatedContent()

Returns:

file content in the annotated revision

It might differ from getFile() content. Ex: annotations for a local file, that has non-committed changes. In this case UpToDateLineNumberProvider will be used to transfer lines between local and annotated revisions.

getCurrentRevision

public abstract VcsRevisionNumber getCurrentRevision()

Returns:

annotated revision

This information might be used to close annotations on local file if current revision was changed, and invocation of AnnotationProvider on this file will produce different results - see isBaseRevisionChanged(com.intellij.openapi.vcs.history.VcsRevisionNumber).

isBaseRevisionChanged

public boolean isBaseRevisionChanged(VcsRevisionNumber number)

Parameters:

number - current revision number DiffProvider.getCurrentRevision(VirtualFile)

Returns:

whether annotations should be updated

dispose

public abstract void dispose()

This method is invoked when the file annotation is no longer used. NB: method might be invoked multiple times

getAspects

public abstract LineAnnotationAspect [] getAspects()

Get annotation aspects. The typical aspects are revision number, date, author. The aspects are displayed each in own column in the returned order.

getLineCount

public abstract int getLineCount()

Returns:

number of lines in annotated content

getToolTip

public abstract java.lang.String getToolTip(int lineNumber)

The tooltip that is shown over annotation. Typically, this is a detailed info about related revision. ex: long revision number, commit message

getHtmlToolTip

public java.lang.String getHtmlToolTip(int lineNumber)

getLineRevisionNumber

public abstract VcsRevisionNumber getLineRevisionNumber(int lineNumber)

Returns:

last revision that modified this line.

getLineDate

public abstract java.util.Date getLineDate(int lineNumber)

Returns:

time of the last modification of this line. Typically, this is a timestamp associated with getLineRevisionNumber(int)

getRevisions

public abstract java.util.List<VcsFileRevision> getRevisions()

Returns:

revisions that are mentioned in the annotations, from newest to oldest Can be used to sort revisions, if they can't be sorted by Date or show file modification number for a revision.

getAnnotationSourceSwitcher

public AnnotationSourceSwitcher getAnnotationSourceSwitcher()

Allows to switch between different representation modes.

Ex: in SVN it's possible to show revision that modified line - "svn blame -g", or the commit that merged that change into current branch - "svn blame".

when "show merge sources" is turned on, getLineRevisionNumber(int) returns merge source revision, while originalRevision(int) returns merge revision.

originalRevision

public VcsRevisionNumber originalRevision(int lineNumber)

Returns:

last revision that modified this line in current branch.

See Also:

getAnnotationSourceSwitcher(), getLineRevisionNumber(int)

isClosed

public boolean isClosed()

close

public final void close()

Notify that annotations should be closed

reload

public final void reload(FileAnnotation newFileAnnotation)

Notify that annotation information has changed, and should be updated. If `this` is visible, hide it and show new one instead. If `this` is not visible, do nothing.

Parameters:

newFileAnnotation - annotations to be shown or `null` to load annotations again

setCloser

public final void setCloser(java.lang.Runnable closer)

See Also:

close()

setReloader

public final void setReloader(Consumer<? super FileAnnotation> reloader)

See Also:

reload(FileAnnotation)

revisionsNotEmpty

@Deprecated
public boolean revisionsNotEmpty()

Deprecated. does nothing

getCurrentFileRevisionProvider

public FileAnnotation.CurrentFileRevisionProvider getCurrentFileRevisionProvider()

getPreviousFileRevisionProvider

public FileAnnotation.PreviousFileRevisionProvider getPreviousFileRevisionProvider()

getAuthorsMappingProvider

public FileAnnotation.AuthorsMappingProvider getAuthorsMappingProvider()

getRevisionsOrderProvider

public FileAnnotation.RevisionsOrderProvider getRevisionsOrderProvider()

getRevisionsChangesProvider

public FileAnnotation.RevisionChangesProvider getRevisionsChangesProvider()

formatDate

public static java.lang.String formatDate(java.util.Date date)