1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
/*
* Copyright (C) 2013, Christian Halstrick <christian.halstrick@sap.com>
* 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.lib;
import java.text.MessageFormat;
import org.eclipse.jgit.errors.IllegalTodoFileModification;
import org.eclipse.jgit.internal.JGitText;
/**
* Describes a single line in a file formatted like the git-rebase-todo file.
*
* @since 3.2
*/
public class RebaseTodoLine {
/**
* Describes rebase actions
*/
@SuppressWarnings("nls")
public enum Action {
/** Use commit */
PICK("pick", "p"),
/** Use commit, but edit the commit message */
REWORD("reword", "r"),
/** Use commit, but stop for amending */
EDIT("edit", "e"),
/** Use commit, but meld into previous commit */
SQUASH("squash", "s"),
/** like "squash", but discard this commit's log message */
FIXUP("fixup", "f"),
/**
* A comment in the file. Also blank lines (or lines containing only
* whitespaces) are reported as comments
*/
COMMENT("comment", "#");
private final String token;
private final String shortToken;
private Action(String token, String shortToken) {
this.token = token;
this.shortToken = shortToken;
}
/**
* @return full action token name
*/
public String toToken() {
return this.token;
}
@Override
public String toString() {
return "Action[" + token + "]";
}
/**
* @param token
* @return the Action
*/
public static Action parse(String token) {
for (Action action : Action.values()) {
if (action.token.equals(token)
|| action.shortToken.equals(token))
return action;
}
throw new IllegalArgumentException(MessageFormat.format(
JGitText.get().unknownOrUnsupportedCommand, token,
Action.values()));
}
}
Action action;
final AbbreviatedObjectId commit;
String shortMessage;
String comment;
/**
* Create a new comment line
*
* @param newComment
* the new comment
*/
public RebaseTodoLine(String newComment) {
this.action = Action.COMMENT;
setComment(newComment);
this.commit = null;
this.shortMessage = null;
}
/**
* Create a new non-comment line
*
* @param action
* a {@link org.eclipse.jgit.lib.RebaseTodoLine.Action} object.
* @param commit
* a {@link org.eclipse.jgit.lib.AbbreviatedObjectId} object.
* @param shortMessage
* a {@link java.lang.String} object.
*/
public RebaseTodoLine(Action action, AbbreviatedObjectId commit,
String shortMessage) {
this.action = action;
this.commit = commit;
this.shortMessage = shortMessage;
this.comment = null;
}
/**
* Get rebase action type
*
* @return rebase action type
*/
public Action getAction() {
return action;
}
/**
* Set the action. It's not allowed to set a non-comment action on a line
* which was a comment line before. But you are allowed to set the comment
* action on a non-comment line and afterwards change the action back to
* non-comment.
*
* @param newAction
* a {@link org.eclipse.jgit.lib.RebaseTodoLine.Action} object.
* @throws org.eclipse.jgit.errors.IllegalTodoFileModification
* on attempt to set a non-comment action on a line which was a
* comment line before.
*/
public void setAction(Action newAction) throws IllegalTodoFileModification {
if (!Action.COMMENT.equals(action) && Action.COMMENT.equals(newAction)) {
// transforming from non-comment to comment
if (comment == null)
// no comment was explicitly set. Take the old line as comment
// text
comment = "# " + action.token + " " //$NON-NLS-1$ //$NON-NLS-2$
+ ((commit == null) ? "null" : commit.name()) + " " //$NON-NLS-1$ //$NON-NLS-2$
+ ((shortMessage == null) ? "null" : shortMessage); //$NON-NLS-1$
} else if (Action.COMMENT.equals(action) && !Action.COMMENT.equals(newAction)) {
// transforming from comment to non-comment
if (commit == null)
throw new IllegalTodoFileModification(MessageFormat.format(
JGitText.get().cannotChangeActionOnComment, action,
newAction));
}
this.action = newAction;
}
/**
* <p>
* Set a comment for this line that is used if this line's
* {@link org.eclipse.jgit.lib.RebaseTodoLine#action} is a {@link org.eclipse.jgit.lib.RebaseTodoLine.Action#COMMENT}
* </p>
* It's allowed to unset the comment by calling
* <code>setComment(null)</code> <br>
* A valid comment either starts with a hash (i.e. <code>'#'</code>), is an
* empty string, or consists of only spaces and tabs.<br>
* If the argument <code>newComment</code> doesn't match these requirements
* an Exception is thrown.
*
* @param newComment
* the comment
*/
public void setComment(String newComment) {
if (newComment == null) {
this.comment = null;
return;
}
if (newComment.contains("\n") || newComment.contains("\r")) //$NON-NLS-1$ //$NON-NLS-2$
throw createInvalidCommentException(newComment);
if (newComment.trim().length() == 0 || newComment.startsWith("#")) { //$NON-NLS-1$
this.comment = newComment;
return;
}
throw createInvalidCommentException(newComment);
}
private static IllegalArgumentException createInvalidCommentException(
String newComment) {
return new IllegalArgumentException(
MessageFormat.format(
JGitText.get().argumentIsNotAValidCommentString, newComment));
}
/**
* Get abbreviated commit SHA-1 of commit that action will be performed on
*
* @return abbreviated commit SHA-1 of commit that action will be performed
* on
*/
public AbbreviatedObjectId getCommit() {
return commit;
}
/**
* Get the first line of the commit message of the commit the action will be
* performed on.
*
* @return the first line of the commit message of the commit the action
* will be performed on.
*/
public String getShortMessage() {
return shortMessage;
}
/**
* Set short message
*
* @param shortMessage
* a short message.
*/
public void setShortMessage(String shortMessage) {
this.shortMessage = shortMessage;
}
/**
* Get a comment
*
* @return a comment. If the line is a comment line then the comment is
* returned. Lines starting with # or blank lines or lines
* containing only spaces and tabs are considered as comment lines.
* The complete line is returned (e.g. including the '#')
*/
public String getComment() {
return comment;
}
/** {@inheritDoc} */
@SuppressWarnings("nls")
@Override
public String toString() {
return "Step["
+ action
+ ", "
+ ((commit == null) ? "null" : commit)
+ ", "
+ ((shortMessage == null) ? "null" : shortMessage)
+ ", "
+ ((comment == null) ? "" : comment) + "]";
}
}
|