blob: eab389460a90f4416bb6f6a33145b9bde034bc8e (
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
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
|
/*
* Copyright (C) 2011, Christian Halstrick <christian.halstrick@sap.com> 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.LinkedList;
import java.util.List;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.api.errors.JGitInternalException;
import org.eclipse.jgit.errors.NoWorkTreeException;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.IndexDiff;
import org.eclipse.jgit.lib.ProgressMonitor;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode;
import org.eclipse.jgit.treewalk.FileTreeIterator;
import org.eclipse.jgit.treewalk.WorkingTreeIterator;
import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
/**
* A class used to execute a {@code Status} command. It has setters for all
* supported options and arguments of this command and a {@link #call()} method
* to finally execute the command. Each instance of this class should only be
* used for one invocation of the command (means: one call to {@link #call()})
*
* @see <a href=
* "http://www.kernel.org/pub/software/scm/git/docs/git-status.html" >Git
* documentation about Status</a>
*/
public class StatusCommand extends GitCommand<Status> {
private WorkingTreeIterator workingTreeIt;
private List<String> paths = null;
private ProgressMonitor progressMonitor = null;
private IgnoreSubmoduleMode ignoreSubmoduleMode = null;
/**
* Constructor for StatusCommand.
*
* @param repo
* a {@link org.eclipse.jgit.lib.Repository} object.
*/
protected StatusCommand(Repository repo) {
super(repo);
}
/**
* Whether to ignore submodules
*
* @param mode
* the
* {@link org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode}
* @return {@code this}
* @since 3.6
*/
public StatusCommand setIgnoreSubmodules(IgnoreSubmoduleMode mode) {
ignoreSubmoduleMode = mode;
return this;
}
/**
* Show only the status of files which match the given paths. The path must
* either name a file or a directory exactly. All paths are always relative
* to the repository root. If a directory is specified all files recursively
* underneath that directory are matched. If this method is called multiple
* times then the status of those files is reported which match at least one
* of the given paths. Note that regex expressions or wildcards are not
* supported.
*
* @param path
* repository-relative path of file/directory to show status for
* (with <code>/</code> as separator)
* @return {@code this}
* @since 3.1
*/
public StatusCommand addPath(String path) {
if (paths == null)
paths = new LinkedList<>();
paths.add(path);
return this;
}
/**
* Returns the paths filtering this status.
*
* @return the paths for which the status is shown or <code>null</code> if
* the complete status for the whole repo is shown.
* @since 3.1
*/
public List<String> getPaths() {
return paths;
}
/**
* {@inheritDoc}
* <p>
* Executes the {@code Status} command with all the options and parameters
* collected by the setter methods of this class. Each instance of this
* class should only be used for one invocation of the command. Don't call
* this method twice on an instance.
*/
@Override
public Status call() throws GitAPIException, NoWorkTreeException {
if (workingTreeIt == null)
workingTreeIt = new FileTreeIterator(repo);
try {
IndexDiff diff = new IndexDiff(repo, Constants.HEAD, workingTreeIt);
if (ignoreSubmoduleMode != null)
diff.setIgnoreSubmoduleMode(ignoreSubmoduleMode);
if (paths != null)
diff.setFilter(PathFilterGroup.createFromStrings(paths));
if (progressMonitor == null)
diff.diff();
else
diff.diff(progressMonitor, ProgressMonitor.UNKNOWN,
ProgressMonitor.UNKNOWN, ""); //$NON-NLS-1$
return new Status(diff);
} catch (IOException e) {
throw new JGitInternalException(e.getMessage(), e);
}
}
/**
* To set the {@link org.eclipse.jgit.treewalk.WorkingTreeIterator} which
* should be used. If this method is not called a standard
* {@link org.eclipse.jgit.treewalk.FileTreeIterator} is used.
*
* @param workingTreeIt
* a working tree iterator
* @return {@code this}
*/
public StatusCommand setWorkingTreeIt(WorkingTreeIterator workingTreeIt) {
this.workingTreeIt = workingTreeIt;
return this;
}
/**
* To set the {@link org.eclipse.jgit.lib.ProgressMonitor} which contains
* callback methods to inform you about the progress of this command.
*
* @param progressMonitor
* a {@link org.eclipse.jgit.lib.ProgressMonitor} object.
* @return {@code this}
* @since 3.1
*/
public StatusCommand setProgressMonitor(ProgressMonitor progressMonitor) {
this.progressMonitor = progressMonitor;
return this;
}
}
|
