Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: a6546f48bd16a84d5163d171f9883847a1b42dd1 (plain) (blame)
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/*******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License 2.0
 *  which accompanies this distribution, and is available at
 *  https://www.eclipse.org/legal/epl-2.0/
 *
 *  SPDX-License-Identifier: EPL-2.0
 *
 *  Contributors:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *******************************************************************************/
package org.eclipse.egit.github.core.service;

import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_MILESTONES;
import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_REPOS;

import com.google.gson.reflect.TypeToken;

import java.io.IOException;
import java.util.Collections;
import java.util.List;

import org.eclipse.egit.github.core.IRepositoryIdProvider;
import org.eclipse.egit.github.core.Milestone;
import org.eclipse.egit.github.core.client.GitHubClient;
import org.eclipse.egit.github.core.client.GitHubRequest;
import org.eclipse.egit.github.core.client.PagedRequest;

/**
 * Milestone service class for listing the {@link Milestone} objects in use by a
 * repository and user accessed via a {@link GitHubClient}.
 *
 * @see <a href="http://developer.github.com/v3/issues/milestones">GitHub
 *      milestones API documentation</a>
 */
public class MilestoneService extends GitHubService {

	/**
	 * Create milestone service
	 */
	public MilestoneService() {
		super();
	}

	/**
	 * Create milestone service
	 *
	 * @param client
	 *            cannot be null
	 */
	public MilestoneService(GitHubClient client) {
		super(client);
	}

	/**
	 * Get milestones
	 *
	 * @param repository
	 * @param state
	 * @return list of milestones
	 * @throws IOException
	 */
	public List<Milestone> getMilestones(IRepositoryIdProvider repository,
			String state) throws IOException {
		String repoId = getId(repository);
		return getMilestones(repoId, state);
	}

	/**
	 * Get milestones
	 *
	 * @param user
	 * @param repository
	 * @param state
	 * @return list of milestones
	 * @throws IOException
	 */
	public List<Milestone> getMilestones(String user, String repository,
			String state) throws IOException {
		verifyRepository(user, repository);

		String repoId = user + '/' + repository;
		return getMilestones(repoId, state);
	}

	private List<Milestone> getMilestones(String id, String state)
			throws IOException {

		StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
		uri.append('/').append(id);
		uri.append(SEGMENT_MILESTONES);
		PagedRequest<Milestone> request = createPagedRequest();
		if (state != null)
			request.setParams(Collections.singletonMap(
					IssueService.FILTER_STATE, state));
		request.setUri(uri).setType(new TypeToken<List<Milestone>>() {
			// make protected type visible
		}.getType());
		return getAll(request);
	}

	/**
	 * Create a milestone
	 *
	 * @param repository
	 *            must be non-null
	 * @param milestone
	 *            must be non-null
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone createMilestone(IRepositoryIdProvider repository,
			Milestone milestone) throws IOException {
		String repoId = getId(repository);
		return createMilestone(repoId, milestone);
	}

	/**
	 * Create a milestone
	 *
	 * @param user
	 *            must be non-null
	 * @param repository
	 *            must be non-null
	 * @param milestone
	 *            must be non-null
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone createMilestone(String user, String repository,
			Milestone milestone) throws IOException {
		verifyRepository(user, repository);

		String repoId = user + '/' + repository;
		return createMilestone(repoId, milestone);
	}

	private Milestone createMilestone(String id, Milestone milestone)
			throws IOException {
		if (milestone == null)
			throw new IllegalArgumentException("Milestone cannot be null"); //$NON-NLS-1$

		StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
		uri.append('/').append(id);
		uri.append(SEGMENT_MILESTONES);
		return client.post(uri.toString(), milestone, Milestone.class);
	}

	/**
	 * Get a milestone
	 *
	 * @param repository
	 *            must be non-null
	 * @param number
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone getMilestone(IRepositoryIdProvider repository, int number)
			throws IOException {
		return getMilestone(repository, Integer.toString(number));
	}

	/**
	 * Get a milestone
	 *
	 * @param repository
	 *            must be non-null
	 * @param number
	 *            must be non-null
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone getMilestone(IRepositoryIdProvider repository,
			String number) throws IOException {
		String repoId = getId(repository);
		return getMilestone(repoId, number);
	}

	/**
	 * Get a milestone
	 *
	 * @param user
	 *            must be non-null
	 * @param repository
	 *            must be non-null
	 * @param number
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone getMilestone(String user, String repository, int number)
			throws IOException {
		return getMilestone(user, repository, Integer.toString(number));
	}

	/**
	 * Get a milestone
	 *
	 * @param user
	 *            must be non-null
	 * @param repository
	 *            must be non-null
	 * @param number
	 *            must be non-null
	 * @return created milestone
	 * @throws IOException
	 */
	public Milestone getMilestone(String user, String repository, String number)
			throws IOException {
		verifyRepository(user, repository);

		String repoId = user + '/' + repository;
		return getMilestone(repoId, number);
	}

	private Milestone getMilestone(String id, String number) throws IOException {
		if (number == null)
			throw new IllegalArgumentException("Milestone cannot be null"); //$NON-NLS-1$
		if (number.length() == 0)
			throw new IllegalArgumentException("Milestone cannot be empty"); //$NON-NLS-1$

		StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
		uri.append('/').append(id);
		uri.append(SEGMENT_MILESTONES);
		uri.append('/').append(number);
		GitHubRequest request = createRequest();
		request.setUri(uri);
		request.setType(Milestone.class);
		return (Milestone) client.get(request).getBody();
	}

	/**
	 * Delete a milestone with the given id from the given repository
	 *
	 * @param repository
	 * @param milestone
	 * @throws IOException
	 */
	public void deleteMilestone(IRepositoryIdProvider repository, int milestone)
			throws IOException {
		deleteMilestone(repository, Integer.toString(milestone));
	}

	/**
	 * Delete a milestone with the given id from the given repository
	 *
	 * @param repository
	 * @param milestone
	 * @throws IOException
	 */
	public void deleteMilestone(IRepositoryIdProvider repository,
			String milestone) throws IOException {
		String repoId = getId(repository);
		deleteMilestone(repoId, milestone);
	}

	/**
	 * Delete a milestone with the given id from the given repository
	 *
	 * @param user
	 * @param repository
	 * @param milestone
	 * @throws IOException
	 */
	public void deleteMilestone(String user, String repository, int milestone)
			throws IOException {
		deleteMilestone(user, repository, Integer.toString(milestone));
	}

	/**
	 * Delete a milestone with the given id from the given repository
	 *
	 * @param user
	 * @param repository
	 * @param milestone
	 * @throws IOException
	 */
	public void deleteMilestone(String user, String repository, String milestone)
			throws IOException {
		verifyRepository(user, repository);

		String repoId = user + '/' + repository;
		deleteMilestone(repoId, milestone);
	}

	private void deleteMilestone(String id, String milestone)
			throws IOException {
		if (milestone == null)
			throw new IllegalArgumentException("Milestone cannot be null"); //$NON-NLS-1$
		if (milestone.length() == 0)
			throw new IllegalArgumentException("Milestone cannot be empty"); //$NON-NLS-1$

		StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
		uri.append('/').append(id);
		uri.append(SEGMENT_MILESTONES);
		uri.append('/').append(milestone);
		client.delete(uri.toString());
	}

	/**
	 * Edit the given milestone in the given repository
	 *
	 * @param repository
	 * @param milestone
	 * @return edited milestone
	 * @throws IOException
	 */
	public Milestone editMilestone(IRepositoryIdProvider repository,
			Milestone milestone) throws IOException {
		String repoId = getId(repository);
		if (milestone == null)
			throw new IllegalArgumentException("Milestone cannot be null"); //$NON-NLS-1$

		StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
		uri.append('/').append(repoId);
		uri.append(SEGMENT_MILESTONES);
		uri.append('/').append(milestone.getNumber());

		return client.post(uri.toString(), milestone, Milestone.class);
	}
}

Back to the top