1 /*
2 * Copyright (C) 2011, GitHub Inc.
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.text.MessageFormat;
47 import java.util.ArrayList;
48 import java.util.Collection;
49 import java.util.Collections;
50 import java.util.List;
51
52 import org.eclipse.jgit.api.errors.GitAPIException;
53 import org.eclipse.jgit.api.errors.InvalidRefNameException;
54 import org.eclipse.jgit.api.errors.JGitInternalException;
55 import org.eclipse.jgit.internal.JGitText;
56 import org.eclipse.jgit.lib.Constants;
57 import org.eclipse.jgit.lib.ReflogEntry;
58 import org.eclipse.jgit.lib.Repository;
59 import org.eclipse.jgit.revwalk.RevCommit;
60 import org.eclipse.jgit.revwalk.RevWalk;
61
62 /**
63 * Command class to list the stashed commits in a repository.
64 *
65 * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html"
66 * >Git documentation about Stash</a>
67 */
68 public class StashListCommand extends GitCommand<Collection<RevCommit>> {
69
70 /**
71 * Create a new stash list command
72 *
73 * @param repo a {@link org.eclipse.jgit.lib.Repository} object.
74 */
75 public StashListCommand(Repository repo) {
76 super(repo);
77 }
78
79 /** {@inheritDoc} */
80 @Override
81 public Collection<RevCommit> call() throws GitAPIException,
82 InvalidRefNameException {
83 checkCallable();
84
85 try {
86 if (repo.exactRef(Constants.R_STASH) == null)
87 return Collections.emptyList();
88 } catch (IOException e) {
89 throw new InvalidRefNameException(MessageFormat.format(
90 JGitText.get().cannotRead, Constants.R_STASH), e);
91 }
92
93 final ReflogCommandhtml#ReflogCommand">ReflogCommand refLog = new ReflogCommand(repo);
94 refLog.setRef(Constants.R_STASH);
95 final Collection<ReflogEntry> stashEntries = refLog.call();
96 if (stashEntries.isEmpty())
97 return Collections.emptyList();
98
99 final List<RevCommit> stashCommits = new ArrayList<>(
100 stashEntries.size());
101 try (RevWalkvWalk.html#RevWalk">RevWalk walk = new RevWalk(repo)) {
102 for (ReflogEntry entry : stashEntries) {
103 try {
104 stashCommits.add(walk.parseCommit(entry.getNewId()));
105 } catch (IOException e) {
106 throw new JGitInternalException(MessageFormat.format(
107 JGitText.get().cannotReadCommit, entry.getNewId()),
108 e);
109 }
110 }
111 }
112 return stashCommits;
113 }
114 }