1 /*
2 * Copyright (C) 2011, Christian Halstrick <christian.halstrick@sap.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.api;
44
45 import java.io.IOException;
46 import java.util.LinkedList;
47 import java.util.List;
48
49 import org.eclipse.jgit.api.errors.GitAPIException;
50 import org.eclipse.jgit.api.errors.JGitInternalException;
51 import org.eclipse.jgit.errors.NoWorkTreeException;
52 import org.eclipse.jgit.lib.Constants;
53 import org.eclipse.jgit.lib.IndexDiff;
54 import org.eclipse.jgit.lib.ProgressMonitor;
55 import org.eclipse.jgit.lib.Repository;
56 import org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode;
57 import org.eclipse.jgit.treewalk.FileTreeIterator;
58 import org.eclipse.jgit.treewalk.WorkingTreeIterator;
59 import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
60
61 /**
62 * A class used to execute a {@code Status} command. It has setters for all
63 * supported options and arguments of this command and a {@link #call()} method
64 * to finally execute the command. Each instance of this class should only be
65 * used for one invocation of the command (means: one call to {@link #call()})
66 *
67 * @see <a href=
68 * "http://www.kernel.org/pub/software/scm/git/docs/git-status.html" >Git
69 * documentation about Status</a>
70 */
71 public class StatusCommand extends GitCommand<Status> {
72 private WorkingTreeIterator workingTreeIt;
73 private List<String> paths = null;
74 private ProgressMonitor progressMonitor = null;
75
76 private IgnoreSubmoduleMode ignoreSubmoduleMode = null;
77
78 /**
79 * Constructor for StatusCommand.
80 *
81 * @param repo
82 * a {@link org.eclipse.jgit.lib.Repository} object.
83 */
84 protected StatusCommand(Repository repo) {
85 super(repo);
86 }
87
88 /**
89 * Whether to ignore submodules
90 *
91 * @param mode
92 * the
93 * {@link org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode}
94 * @return {@code this}
95 * @since 3.6
96 */
97 public StatusCommand setIgnoreSubmodules(IgnoreSubmoduleMode mode) {
98 ignoreSubmoduleMode = mode;
99 return this;
100 }
101
102 /**
103 * Show only the status of files which match the given paths. The path must
104 * either name a file or a directory exactly. All paths are always relative
105 * to the repository root. If a directory is specified all files recursively
106 * underneath that directory are matched. If this method is called multiple
107 * times then the status of those files is reported which match at least one
108 * of the given paths. Note that regex expressions or wildcards are not
109 * supported.
110 *
111 * @param path
112 * repository-relative path of file/directory to show status for
113 * (with <code>/</code> as separator)
114 * @return {@code this}
115 * @since 3.1
116 */
117 public StatusCommand addPath(String path) {
118 if (paths == null)
119 paths = new LinkedList<>();
120 paths.add(path);
121 return this;
122 }
123
124 /**
125 * Returns the paths filtering this status.
126 *
127 * @return the paths for which the status is shown or <code>null</code> if
128 * the complete status for the whole repo is shown.
129 * @since 3.1
130 */
131 public List<String> getPaths() {
132 return paths;
133 }
134
135 /**
136 * {@inheritDoc}
137 * <p>
138 * Executes the {@code Status} command with all the options and parameters
139 * collected by the setter methods of this class. Each instance of this
140 * class should only be used for one invocation of the command. Don't call
141 * this method twice on an instance.
142 */
143 @Override
144 public Status call() throws GitAPIException, NoWorkTreeException {
145 if (workingTreeIt == null)
146 workingTreeIt = new FileTreeIterator(repo);
147
148 try {
149 IndexDiff diff = new IndexDiff(repo, Constants.HEAD, workingTreeIt);
150 if (ignoreSubmoduleMode != null)
151 diff.setIgnoreSubmoduleMode(ignoreSubmoduleMode);
152 if (paths != null)
153 diff.setFilter(PathFilterGroup.createFromStrings(paths));
154 if (progressMonitor == null)
155 diff.diff();
156 else
157 diff.diff(progressMonitor, ProgressMonitor.UNKNOWN,
158 ProgressMonitor.UNKNOWN, ""); //$NON-NLS-1$
159 return new Status(diff);
160 } catch (IOException e) {
161 throw new JGitInternalException(e.getMessage(), e);
162 }
163 }
164
165 /**
166 * To set the {@link org.eclipse.jgit.treewalk.WorkingTreeIterator} which
167 * should be used. If this method is not called a standard
168 * {@link org.eclipse.jgit.treewalk.FileTreeIterator} is used.
169 *
170 * @param workingTreeIt
171 * a working tree iterator
172 * @return {@code this}
173 */
174 public StatusCommand setWorkingTreeIt(WorkingTreeIterator workingTreeIt) {
175 this.workingTreeIt = workingTreeIt;
176 return this;
177 }
178
179 /**
180 * To set the {@link org.eclipse.jgit.lib.ProgressMonitor} which contains
181 * callback methods to inform you about the progress of this command.
182 *
183 * @param progressMonitor
184 * a {@link org.eclipse.jgit.lib.ProgressMonitor} object.
185 * @return {@code this}
186 * @since 3.1
187 */
188 public StatusCommand setProgressMonitor(ProgressMonitor progressMonitor) {
189 this.progressMonitor = progressMonitor;
190 return this;
191 }
192 }