123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184 |
- /*
- * Copyright (C) 2010, Mathias Kinzler <mathias.kinzler@sap.com>
- * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com>
- * Copyright (C) 2014, Robin Stocker <robin@nibor.org>
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- package org.eclipse.jgit.api;
-
- import java.io.IOException;
- import java.text.MessageFormat;
- import java.util.ArrayList;
- import java.util.Collection;
- import java.util.Collections;
- import java.util.Comparator;
- import java.util.List;
-
- import org.eclipse.jgit.api.errors.GitAPIException;
- import org.eclipse.jgit.api.errors.JGitInternalException;
- import org.eclipse.jgit.api.errors.RefNotFoundException;
- import org.eclipse.jgit.internal.JGitText;
- import org.eclipse.jgit.lib.Constants;
- import org.eclipse.jgit.lib.ObjectId;
- import org.eclipse.jgit.lib.Ref;
- import org.eclipse.jgit.lib.Repository;
- import org.eclipse.jgit.revwalk.RevCommit;
- import org.eclipse.jgit.revwalk.RevWalk;
- import org.eclipse.jgit.revwalk.RevWalkUtils;
-
- /**
- * Used to obtain a list of branches.
- * <p>
- * In case HEAD is detached (it points directly to a commit), it is also
- * returned in the results.
- *
- * @see <a
- * href="http://www.kernel.org/pub/software/scm/git/docs/git-branch.html"
- * >Git documentation about Branch</a>
- */
- public class ListBranchCommand extends GitCommand<List<Ref>> {
- private ListMode listMode;
-
- private String containsCommitish;
-
- /**
- * The modes available for listing branches (corresponding to the -r and -a
- * options)
- */
- public enum ListMode {
- /**
- * Corresponds to the -a option (all branches)
- */
- ALL,
- /**
- * Corresponds to the -r option (remote branches only)
- */
- REMOTE;
- }
-
- /**
- * @param repo
- */
- protected ListBranchCommand(Repository repo) {
- super(repo);
- }
-
- public List<Ref> call() throws GitAPIException {
- checkCallable();
- List<Ref> resultRefs;
- try {
- Collection<Ref> refs = new ArrayList<Ref>();
-
- // Also return HEAD if it's detached
- Ref head = repo.exactRef(Constants.HEAD);
- if (head != null && head.getLeaf().getName().equals(Constants.HEAD))
- refs.add(head);
-
- if (listMode == null) {
- refs.addAll(getRefs(Constants.R_HEADS));
- } else if (listMode == ListMode.REMOTE) {
- refs.addAll(getRefs(Constants.R_REMOTES));
- } else {
- refs.addAll(getRefs(Constants.R_HEADS));
- refs.addAll(getRefs(Constants.R_REMOTES));
- }
- resultRefs = new ArrayList<Ref>(filterRefs(refs));
- } catch (IOException e) {
- throw new JGitInternalException(e.getMessage(), e);
- }
-
- Collections.sort(resultRefs, new Comparator<Ref>() {
- public int compare(Ref o1, Ref o2) {
- return o1.getName().compareTo(o2.getName());
- }
- });
- setCallable(false);
- return resultRefs;
- }
-
- private Collection<Ref> filterRefs(Collection<Ref> refs)
- throws RefNotFoundException, IOException {
- if (containsCommitish == null)
- return refs;
-
- try (RevWalk walk = new RevWalk(repo)) {
- ObjectId resolved = repo.resolve(containsCommitish);
- if (resolved == null)
- throw new RefNotFoundException(MessageFormat.format(
- JGitText.get().refNotResolved, containsCommitish));
-
- RevCommit containsCommit = walk.parseCommit(resolved);
- return RevWalkUtils.findBranchesReachableFrom(containsCommit, walk,
- refs);
- }
- }
-
- /**
- * @param listMode
- * optional: corresponds to the -r/-a options; by default, only
- * local branches will be listed
- * @return this instance
- */
- public ListBranchCommand setListMode(ListMode listMode) {
- checkCallable();
- this.listMode = listMode;
- return this;
- }
-
- /**
- * If this is set, only the branches that contain the specified commit-ish
- * as an ancestor are returned.
- *
- * @param containsCommitish
- * a commit ID or ref name
- * @return this instance
- * @since 3.4
- */
- public ListBranchCommand setContains(String containsCommitish) {
- checkCallable();
- this.containsCommitish = containsCommitish;
- return this;
- }
-
- private Collection<Ref> getRefs(String prefix) throws IOException {
- return repo.getRefDatabase().getRefs(prefix).values();
- }
- }
|