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
|
/*
* Copyright (C) 2006-2008, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
* Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.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.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import org.eclipse.jgit.revwalk.RevObject;
/**
* Mutable builder to construct an annotated tag recording a project state.
*
* Applications should use this object when they need to manually construct a
* tag and want precise control over its fields.
*
* To read a tag object, construct a {@link org.eclipse.jgit.revwalk.RevWalk}
* and obtain a {@link org.eclipse.jgit.revwalk.RevTag} instance by calling
* {@link org.eclipse.jgit.revwalk.RevWalk#parseTag(AnyObjectId)}.
*/
public class TagBuilder {
private ObjectId object;
private int type = Constants.OBJ_BAD;
private String tag;
private PersonIdent tagger;
private String message;
/** @return the type of object this tag refers to. */
public int getObjectType() {
return type;
}
/** @return the object this tag refers to. */
public ObjectId getObjectId() {
return object;
}
/**
* Set the object this tag refers to, and its type.
*
* @param obj
* the object.
* @param objType
* the type of {@code obj}. Must be a valid type code.
*/
public void setObjectId(AnyObjectId obj, int objType) {
object = obj.copy();
type = objType;
}
/**
* Set the object this tag refers to, and infer its type.
*
* @param obj
* the object the tag will refer to.
*/
public void setObjectId(RevObject obj) {
setObjectId(obj, obj.getType());
}
/** @return short name of the tag (no {@code refs/tags/} prefix). */
public String getTag() {
return tag;
}
/**
* Set the name of this tag.
*
* @param shortName
* new short name of the tag. This short name should not start
* with {@code refs/} as typically a tag is stored under the
* reference derived from {@code "refs/tags/" + getTag()}.
*/
public void setTag(String shortName) {
this.tag = shortName;
}
/** @return creator of this tag. May be null. */
public PersonIdent getTagger() {
return tagger;
}
/**
* Set the creator of this tag.
*
* @param taggerIdent
* the creator. May be null.
*/
public void setTagger(PersonIdent taggerIdent) {
tagger = taggerIdent;
}
/** @return the complete commit message. */
public String getMessage() {
return message;
}
/**
* Set the tag's message.
*
* @param newMessage
* the tag's message.
*/
public void setMessage(final String newMessage) {
message = newMessage;
}
/**
* Format this builder's state as an annotated tag object.
*
* @return this object in the canonical annotated tag format, suitable for
* storage in a repository.
*/
public byte[] build() {
ByteArrayOutputStream os = new ByteArrayOutputStream();
OutputStreamWriter w = new OutputStreamWriter(os, Constants.CHARSET);
try {
w.write("object ");
getObjectId().copyTo(w);
w.write('\n');
w.write("type ");
w.write(Constants.typeString(getObjectType()));
w.write("\n");
w.write("tag ");
w.write(getTag());
w.write("\n");
if (getTagger() != null) {
w.write("tagger ");
w.write(getTagger().toExternalString());
w.write('\n');
}
w.write('\n');
if (getMessage() != null)
w.write(getMessage());
w.close();
} catch (IOException err) {
// This should never occur, the only way to get it above is
// for the ByteArrayOutputStream to throw, but it doesn't.
//
throw new RuntimeException(err);
}
return os.toByteArray();
}
/**
* Format this builder's state as an annotated tag object.
*
* @return this object in the canonical annotated tag format, suitable for
* storage in a repository.
*/
public byte[] toByteArray() {
return build();
}
@Override
public String toString() {
StringBuilder r = new StringBuilder();
r.append("Tag");
r.append("={\n");
r.append("object ");
r.append(object != null ? object.name() : "NOT_SET");
r.append("\n");
r.append("type ");
r.append(object != null ? Constants.typeString(type) : "NOT_SET");
r.append("\n");
r.append("tag ");
r.append(tag != null ? tag : "NOT_SET");
r.append("\n");
if (tagger != null) {
r.append("tagger ");
r.append(tagger);
r.append("\n");
}
r.append("\n");
r.append(message != null ? message : "");
r.append("}");
return r.toString();
}
}
|
