blob: c7b7ef9a7300dd471602db8a93282d77c979ebd3 (
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
|
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.vcs.log;
import com.intellij.vcs.log.graph.GraphCommit;
import java.util.List;
/**
* A {@link GraphCommit} with information about date & time when this commit was made.
* <p/>
* An instance of this object can be obtained via
* {@link VcsLogObjectsFactory#createTimedCommit(Hash, List, long) VcsLogObjectsFactory#createTimedCommit}.
* <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 TimedVcsCommits are equal if and only if they have equal
* hash codes. The VCS Log framework heavily relies on this fact.
*/
public interface TimedVcsCommit extends GraphCommit<Hash> {
/**
* <p>Returns the timestamp indicating the date & time when this commit was made.</p>
* <p>This time is displayed in the table by default;
* is used for joining commits from different repositories;
* is used for ordering commits in a single repository (keeping the preference of the topological ordering of course).</p>
*/
long getTimestamp();
}
|