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
|
/*******************************************************************************
* Copyright (c) 2006, 2008 Steffen Pingel and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Tasktop Technologies - initial API and implementation
*******************************************************************************/
package org.eclipse.mylyn.internal.trac.core.model;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.mylyn.internal.trac.core.client.InvalidTicketException;
/**
* Represents a Trac ticket as it is retrieved from a Trac repository.
*
* @author Steffen Pingel
*/
public class TracTicket {
/**
* Represents the key of a string propertiy of a ticket.
*
* @author Steffen Pingel
*/
public enum Key {
CC("cc"), CHANGE_TIME("changetime"), COMPONENT("component"), DESCRIPTION("description"), ID("id"), KEYWORDS( //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
"keywords"), MILESTONE("milestone"), OWNER("owner"), PRIORITY("priority"), REPORTER("reporter"), RESOLUTION( //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
"resolution"), STATUS("status"), SEVERITY("severity"), SUMMARY("summary"), TIME("time"), TYPE("type"), VERSION( //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$
"version"); //$NON-NLS-1$
public static Key fromKey(String name) {
for (Key key : Key.values()) {
if (key.getKey().equals(name)) {
return key;
}
}
return null;
}
private String key;
Key(String key) {
this.key = key;
}
@Override
public String toString() {
return key;
}
public String getKey() {
return key;
}
}
public static final int INVALID_ID = -1;
private Date created;
/**
* User defined custom ticket fields.
*
* @see http://projects.edgewall.com/trac/wiki/TracTicketsCustomFields
*/
private Map<String, String> customValueByKey;
private int id = INVALID_ID;
private Date lastChanged;
/** Trac's built-in ticket properties. */
private final Map<Key, String> valueByKey = new HashMap<Key, String>();
private List<TracComment> comments;
private List<TracAttachment> attachments;
private String[] actions;
private String[] resolutions;
public TracTicket() {
}
/**
* Constructs a Trac ticket.
*
* @param id
* the numeric Trac ticket id
*/
public TracTicket(int id) {
this.id = id;
}
public Date getCreated() {
return created;
}
public int getId() {
return id;
}
public Date getLastChanged() {
return lastChanged;
}
public String getCustomValue(String key) {
if (customValueByKey == null) {
return null;
}
return customValueByKey.get(key);
}
public String getValue(Key key) {
return valueByKey.get(key);
}
public Map<String, String> getValues() {
Map<String, String> result = new HashMap<String, String>();
for (Key key : valueByKey.keySet()) {
result.put(key.getKey(), valueByKey.get(key));
}
if (customValueByKey != null) {
result.putAll(customValueByKey);
}
return result;
}
public boolean isValid() {
return getId() != TracTicket.INVALID_ID;
}
public void putBuiltinValue(Key key, String value) throws InvalidTicketException {
valueByKey.put(key, value);
}
public void putCustomValue(String key, String value) {
if (customValueByKey == null) {
customValueByKey = new HashMap<String, String>();
}
customValueByKey.put(key, value);
}
/**
* Stores a value as it is retrieved from the repository.
*
* @throws InvalidTicketException
* thrown if the type of <code>value</code> is not valid
*/
public boolean putValue(String keyName, String value) throws InvalidTicketException {
Key key = Key.fromKey(keyName);
if (key != null) {
if (key == Key.ID || key == Key.TIME || key == Key.CHANGE_TIME) {
return false;
}
putBuiltinValue(key, value);
} else if (value != null) {
putCustomValue(keyName, value);
} else {
throw new InvalidTicketException("Expected string value for custom key '" + keyName + "', got '" + value //$NON-NLS-1$ //$NON-NLS-2$
+ "'"); //$NON-NLS-1$
}
return true;
}
public void setCreated(Date created) {
this.created = created;
}
public void setId(int id) {
this.id = id;
}
public void setLastChanged(Date lastChanged) {
this.lastChanged = lastChanged;
}
public void addComment(TracComment comment) {
if (comments == null) {
comments = new ArrayList<TracComment>();
}
comments.add(comment);
}
public void addAttachment(TracAttachment attachment) {
if (attachments == null) {
attachments = new ArrayList<TracAttachment>();
}
attachments.add(attachment);
}
public TracComment[] getComments() {
return (comments != null) ? comments.toArray(new TracComment[0]) : null;
}
public TracAttachment[] getAttachments() {
return (attachments != null) ? attachments.toArray(new TracAttachment[0]) : null;
}
public void setActions(String[] actions) {
this.actions = actions;
}
public String[] getActions() {
return actions;
}
public void setResolutions(String[] resolutions) {
this.resolutions = resolutions;
}
public String[] getResolutions() {
return resolutions;
}
}
|
