1 /**
2 * Copyright (c) 2013-2023, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.github;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34 import java.util.Map;
35
36 /**
37 * Github Milestones.
38 * @author Paul Polishchuk (ppol@ua.fm)
39 * @version $Id: a483a5e2841785fe63b74017ad331ed9a83d5494 $
40 * @see <a href="https://developer.github.com/v3/issues/milestones/">Milestones API</a>
41 * @since 0.7
42 */
43 @Immutable
44 public interface Milestones {
45
46 /**
47 * Owner of them.
48 * @return Repo
49 */
50 Repo repo();
51
52 /**
53 * Create Milestone.
54 * @param title Milestone creation JSON
55 * @return Milestone
56 * @throws java.io.IOException If there is any I/O problem
57 * @see <a href="https://developer.github.com/v3/issues/milestones/#create-a-milestone">Create Milestone</a>
58 * @since 0.5
59 */
60 Milestone create(String title)
61 throws IOException;
62
63 /**
64 * Get specific milestone by number.
65 * @param number Milestone number
66 * @return Milestone
67 * @see <a href="https://developer.github.com/v3/issues/milestones/#get-a-single-milestone">Get a single milestone</a>
68 */
69 Milestone get(int number);
70
71 /**
72 * Iterate them all.
73 * @param params Iterating parameters, as requested by API
74 * @return Iterator of milestones
75 * @see <a href="https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository">List milestones for a repository</a>
76 */
77 Iterable<Milestone> iterate(
78 Map<String, String> params);
79
80 /**
81 * Remove milestone by number.
82 * @param number Milestone number
83 * @throws IOException If there is any I/O problem
84 * @see <a href="https://developer.github.com/v3/issues/milestones/#delete-a-milestone">Delete a milestone</a>
85 */
86 void remove(int number)
87 throws IOException;
88 }