blob: 3069f3f6d967cd341930dea28b8c4736a7ee7f30 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
package com.intellij.vcs.log;
import com.intellij.openapi.vfs.VirtualFile;
import org.jetbrains.annotations.NotNull;
import java.util.List;
/**
* Returns the basic level of commit meta-data: author, time, subject. These details will be displayed in the log table.
* <p/>
* An instance of this object can be obtained via
* {@link VcsLogObjectsFactory#createShortDetails(Hash, List, long, VirtualFile, String, String, String)
* VcsLogObjectsFactory#createShortDetails}.
* <p/>
* It is not recommended to create a custom implementation of this interface, but if you need it, <b>make sure to implement {@code equals()}
* and {@code hashcode()} so that they consider only the Hash</b>, i.e. two VcsShortCommitDetails are equal if and only if they have equal
* hash codes. The VCS Log framework heavily relies on this fact.
*
* @see VcsCommitMetadata
* @see VcsFullCommitDetails
*/
public interface VcsShortCommitDetails extends TimedVcsCommit {
@Override
@NotNull
Hash getId();
@NotNull
VirtualFile getRoot();
@Override
@NotNull
List<Hash> getParents();
@Override
long getTimestamp();
@NotNull
String getSubject();
@NotNull
VcsUser getAuthor();
}
|