1 /*
2 * Copyright (C) 2010, Mathias Kinzler <mathias.kinzler@sap.com>
3 * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com>
4 * Copyright (C) 2014, Robin Stocker <robin@nibor.org>
5 * and other copyright owners as documented in the project's IP log.
6 *
7 * This program and the accompanying materials are made available
8 * under the terms of the Eclipse Distribution License v1.0 which
9 * accompanies this distribution, is reproduced below, and is
10 * available at http://www.eclipse.org/org/documents/edl-v10.php
11 *
12 * All rights reserved.
13 *
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
17 *
18 * - Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 *
21 * - Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials provided
24 * with the distribution.
25 *
26 * - Neither the name of the Eclipse Foundation, Inc. nor the
27 * names of its contributors may be used to endorse or promote
28 * products derived from this software without specific prior
29 * written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
32 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
33 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
36 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
38 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
39 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 */
45 package org.eclipse.jgit.api;
46
47 import static org.eclipse.jgit.lib.Constants.HEAD;
48 import static org.eclipse.jgit.lib.Constants.R_HEADS;
49 import static org.eclipse.jgit.lib.Constants.R_REMOTES;
50
51 import java.io.IOException;
52 import java.text.MessageFormat;
53 import java.util.ArrayList;
54 import java.util.Collection;
55 import java.util.Collections;
56 import java.util.List;
57
58 import org.eclipse.jgit.api.errors.GitAPIException;
59 import org.eclipse.jgit.api.errors.JGitInternalException;
60 import org.eclipse.jgit.api.errors.RefNotFoundException;
61 import org.eclipse.jgit.internal.JGitText;
62 import org.eclipse.jgit.lib.ObjectId;
63 import org.eclipse.jgit.lib.Ref;
64 import org.eclipse.jgit.lib.Repository;
65 import org.eclipse.jgit.revwalk.RevCommit;
66 import org.eclipse.jgit.revwalk.RevWalk;
67 import org.eclipse.jgit.revwalk.RevWalkUtils;
68
69 /**
70 * Used to obtain a list of branches.
71 * <p>
72 * In case HEAD is detached (it points directly to a commit), it is also
73 * returned in the results.
74 *
75 * @see <a
76 * href="http://www.kernel.org/pub/software/scm/git/docs/git-branch.html"
77 * >Git documentation about Branch</a>
78 */
79 public class ListBranchCommand extends GitCommand<List<Ref>> {
80 private ListMode listMode;
81
82 private String containsCommitish;
83
84 /**
85 * The modes available for listing branches (corresponding to the -r and -a
86 * options)
87 */
88 public enum ListMode {
89 /**
90 * Corresponds to the -a option (all branches)
91 */
92 ALL,
93 /**
94 * Corresponds to the -r option (remote branches only)
95 */
96 REMOTE;
97 }
98
99 /**
100 * Constructor for ListBranchCommand.
101 *
102 * @param repo
103 * a {@link org.eclipse.jgit.lib.Repository} object.
104 */
105 protected ListBranchCommand(Repository repo) {
106 super(repo);
107 }
108
109 /** {@inheritDoc} */
110 @Override
111 public List<Ref> call() throws GitAPIException {
112 checkCallable();
113 List<Ref> resultRefs;
114 try {
115 Collection<Ref> refs = new ArrayList<>();
116
117 // Also return HEAD if it's detached
118 Ref head = repo.exactRef(HEAD);
119 if (head != null && head.getLeaf().getName().equals(HEAD)) {
120 refs.add(head);
121 }
122
123 if (listMode == null) {
124 refs.addAll(repo.getRefDatabase().getRefsByPrefix(R_HEADS));
125 } else if (listMode == ListMode.REMOTE) {
126 refs.addAll(repo.getRefDatabase().getRefsByPrefix(R_REMOTES));
127 } else {
128 refs.addAll(repo.getRefDatabase().getRefsByPrefix(R_HEADS,
129 R_REMOTES));
130 }
131 resultRefs = new ArrayList<>(filterRefs(refs));
132 } catch (IOException e) {
133 throw new JGitInternalException(e.getMessage(), e);
134 }
135
136 Collections.sort(resultRefs,
137 (Reff" href="../../../../org/eclipse/jgit/lib/Ref.html#Ref">Ref o1, Ref o2) -> o1.getName().compareTo(o2.getName()));
138 setCallable(false);
139 return resultRefs;
140 }
141
142 private Collection<Ref> filterRefs(Collection<Ref> refs)
143 throws RefNotFoundException, IOException {
144 if (containsCommitish == null)
145 return refs;
146
147 try (RevWalkvWalk.html#RevWalk">RevWalk walk = new RevWalk(repo)) {
148 ObjectId resolved = repo.resolve(containsCommitish);
149 if (resolved == null)
150 throw new RefNotFoundException(MessageFormat.format(
151 JGitText.get().refNotResolved, containsCommitish));
152
153 RevCommit containsCommit = walk.parseCommit(resolved);
154 return RevWalkUtils.findBranchesReachableFrom(containsCommit, walk,
155 refs);
156 }
157 }
158
159 /**
160 * Set the list mode
161 *
162 * @param listMode
163 * optional: corresponds to the -r/-a options; by default, only
164 * local branches will be listed
165 * @return this instance
166 */
167 public ListBranchCommand setListMode(ListMode listMode) {
168 checkCallable();
169 this.listMode = listMode;
170 return this;
171 }
172
173 /**
174 * If this is set, only the branches that contain the specified commit-ish
175 * as an ancestor are returned.
176 *
177 * @param containsCommitish
178 * a commit ID or ref name
179 * @return this instance
180 * @since 3.4
181 */
182 public ListBranchCommand setContains(String containsCommitish) {
183 checkCallable();
184 this.containsCommitish = containsCommitish;
185 return this;
186 }
187 }