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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* Copyright (C) 2011, 2019 GitHub Inc. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.api;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.api.errors.JGitInternalException;
import org.eclipse.jgit.blame.BlameGenerator;
import org.eclipse.jgit.blame.BlameResult;
import org.eclipse.jgit.diff.DiffAlgorithm;
import org.eclipse.jgit.diff.RawTextComparator;
import org.eclipse.jgit.lib.AnyObjectId;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
/**
* Blame command for building a {@link org.eclipse.jgit.blame.BlameResult} for a
* file path.
*/
public class BlameCommand extends GitCommand<BlameResult> {
private String path;
private DiffAlgorithm diffAlgorithm;
private RawTextComparator textComparator;
private ObjectId startCommit;
private Collection<ObjectId> reverseEndCommits;
private Boolean followFileRenames;
/**
* Constructor for BlameCommand
*
* @param repo
* the {@link org.eclipse.jgit.lib.Repository}
*/
public BlameCommand(Repository repo) {
super(repo);
}
/**
* Set file path.
*
* @param filePath
* file path (with <code>/</code> as separator)
* @return this command
*/
public BlameCommand setFilePath(String filePath) {
this.path = filePath;
return this;
}
/**
* Set diff algorithm
*
* @param diffAlgorithm
* a {@link org.eclipse.jgit.diff.DiffAlgorithm} object.
* @return this command
*/
public BlameCommand setDiffAlgorithm(DiffAlgorithm diffAlgorithm) {
this.diffAlgorithm = diffAlgorithm;
return this;
}
/**
* Set raw text comparator
*
* @param textComparator
* a {@link org.eclipse.jgit.diff.RawTextComparator}
* @return this command
*/
public BlameCommand setTextComparator(RawTextComparator textComparator) {
this.textComparator = textComparator;
return this;
}
/**
* Set start commit id
*
* @param commit
* id of a commit
* @return this command
*/
public BlameCommand setStartCommit(AnyObjectId commit) {
this.startCommit = commit.toObjectId();
return this;
}
/**
* Enable (or disable) following file renames.
* <p>
* If true renames are followed using the standard FollowFilter behavior
* used by RevWalk (which matches {@code git log --follow} in the C
* implementation). This is not the same as copy/move detection as
* implemented by the C implementation's of {@code git blame -M -C}.
*
* @param follow
* enable following.
* @return {@code this}
*/
public BlameCommand setFollowFileRenames(boolean follow) {
followFileRenames = Boolean.valueOf(follow);
return this;
}
/**
* Configure the command to compute reverse blame (history of deletes).
*
* @param start
* oldest commit to traverse from. The result file will be loaded
* from this commit's tree.
* @param end
* most recent commit to stop traversal at. Usually an active
* branch tip, tag, or HEAD.
* @return {@code this}
* @throws java.io.IOException
* the repository cannot be read.
*/
public BlameCommand reverse(AnyObjectId start, AnyObjectId end)
throws IOException {
return reverse(start, Collections.singleton(end.toObjectId()));
}
/**
* Configure the generator to compute reverse blame (history of deletes).
*
* @param start
* oldest commit to traverse from. The result file will be loaded
* from this commit's tree.
* @param end
* most recent commits to stop traversal at. Usually an active
* branch tip, tag, or HEAD.
* @return {@code this}
* @throws java.io.IOException
* the repository cannot be read.
*/
public BlameCommand reverse(AnyObjectId start, Collection<ObjectId> end)
throws IOException {
startCommit = start.toObjectId();
reverseEndCommits = new ArrayList<>(end);
return this;
}
/**
* {@inheritDoc}
* <p>
* Generate a list of lines with information about when the lines were
* introduced into the file path.
*/
@Override
public BlameResult call() throws GitAPIException {
checkCallable();
try (BlameGenerator gen = new BlameGenerator(repo, path)) {
if (diffAlgorithm != null)
gen.setDiffAlgorithm(diffAlgorithm);
if (textComparator != null)
gen.setTextComparator(textComparator);
if (followFileRenames != null)
gen.setFollowFileRenames(followFileRenames.booleanValue());
if (reverseEndCommits != null)
gen.reverse(startCommit, reverseEndCommits);
else if (startCommit != null)
gen.push(null, startCommit);
else {
gen.prepareHead();
}
return gen.computeBlameResult();
} catch (IOException e) {
throw new JGitInternalException(e.getMessage(), e);
}
}
}
|
