1 /*
2 * Copyright (C) 2011-2013, Robin Rosenberg <robin.rosenberg@dewire.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.lib;
44
45 /**
46 * Parsed reflog entry
47 *
48 * @since 3.0
49 */
50 public interface ReflogEntry {
51
52 /**
53 * Prefix used in reflog messages when the ref was first created.
54 * <p>
55 * Does not have a corresponding constant in C git, but is untranslated like
56 * the other constants.
57 *
58 * @since 4.9
59 */
60 String PREFIX_CREATED = "created"; //$NON-NLS-1$
61
62 /**
63 * Prefix used in reflog messages when the ref was updated with a fast
64 * forward.
65 * <p>
66 * Untranslated, and exactly matches the
67 * <a href="https://git.kernel.org/pub/scm/git/git.git/tree/builtin/fetch.c?id=f3da2b79be9565779e4f76dc5812c68e156afdf0#n680">
68 * untranslated string in C git</a>.
69 *
70 * @since 4.9
71 */
72 String PREFIX_FAST_FORWARD = "fast-forward"; //$NON-NLS-1$
73
74 /**
75 * Prefix used in reflog messages when the ref was force updated.
76 * <p>
77 * Untranslated, and exactly matches the
78 * <a href="https://git.kernel.org/pub/scm/git/git.git/tree/builtin/fetch.c?id=f3da2b79be9565779e4f76dc5812c68e156afdf0#n695">
79 * untranslated string in C git</a>.
80 *
81 * @since 4.9
82 */
83 String PREFIX_FORCED_UPDATE = "forced-update"; //$NON-NLS-1$
84
85 /**
86 * Get the commit id before the change
87 *
88 * @return the commit id before the change
89 */
90 ObjectId getOldId();
91
92 /**
93 * Get the commit id after the change
94 *
95 * @return the commit id after the change
96 */
97 ObjectId getNewId();
98
99 /**
100 * Get user performing the change
101 *
102 * @return user performing the change
103 */
104 PersonIdent getWho();
105
106 /**
107 * Get textual description of the change
108 *
109 * @return textual description of the change
110 */
111 String getComment();
112
113 /**
114 * Parse checkout
115 *
116 * @return a {@link org.eclipse.jgit.lib.CheckoutEntry} with parsed
117 * information about a branch switch, or null if the entry is not a
118 * checkout
119 */
120 CheckoutEntry parseCheckout();
121
122 }