1 /*
2 * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.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.text.MessageFormat;
47 import java.util.Collection;
48
49 import org.eclipse.jgit.api.errors.GitAPIException;
50 import org.eclipse.jgit.api.errors.InvalidRefNameException;
51 import org.eclipse.jgit.api.errors.RefNotFoundException;
52 import org.eclipse.jgit.internal.JGitText;
53 import org.eclipse.jgit.lib.Constants;
54 import org.eclipse.jgit.lib.ReflogEntry;
55 import org.eclipse.jgit.lib.ReflogReader;
56 import org.eclipse.jgit.lib.Repository;
57
58 /**
59 * The reflog command
60 *
61 * @see <a
62 * href="http://www.kernel.org/pub/software/scm/git/docs/git-reflog.html"
63 * >Git documentation about reflog</a>
64 */
65 public class ReflogCommand extends GitCommand<Collection<ReflogEntry>> {
66
67 private String ref = Constants.HEAD;
68
69 /**
70 * Constructor for ReflogCommand.
71 *
72 * @param repo
73 * the {@link org.eclipse.jgit.lib.Repository}
74 */
75 public ReflogCommand(Repository repo) {
76 super(repo);
77 }
78
79 /**
80 * The ref used for the reflog operation. If no ref is set, the default
81 * value of HEAD will be used.
82 *
83 * @param ref
84 * the name of the {@code Ref} to log
85 * @return {@code this}
86 */
87 public ReflogCommand setRef(String ref) {
88 checkCallable();
89 this.ref = ref;
90 return this;
91 }
92
93 /**
94 * {@inheritDoc}
95 * <p>
96 * Run the reflog command
97 */
98 @Override
99 public Collection<ReflogEntry> call() throws GitAPIException,
100 InvalidRefNameException {
101 checkCallable();
102
103 try {
104 ReflogReader reader = repo.getReflogReader(ref);
105 if (reader == null)
106 throw new RefNotFoundException(MessageFormat.format(
107 JGitText.get().refNotResolved, ref));
108 return reader.getReverseEntries();
109 } catch (IOException e) {
110 throw new InvalidRefNameException(MessageFormat.format(
111 JGitText.get().cannotRead, ref), e);
112 }
113 }
114
115 }