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
35 /**
36 * Github release assets.
37 *
38 * @author Carlos Miranda (miranda.cma@gmail.com)
39 * @version $Id: fc1b199762dd4d60e9e8e39ee64d41d6a18d7013 $
40 * @since 0.8
41 * @see <a href="https://developer.github.com/v3/repos/releases/">Releases API</a>
42 */
43 @Immutable
44 public interface ReleaseAssets {
45
46 /**
47 * The release we're in.
48 * @return Issue
49 */
50 Release release();
51
52 /**
53 * Iterate them all.
54 * @return All comments
55 * @see <a href="https://developer.github.com/v3/repos/releases/#list-assets-for-a-release">List Assets for a Release</a>
56 */
57 Iterable<ReleaseAsset> iterate();
58
59 /**
60 * Upload a release asset.
61 * @param content The raw content bytes.
62 * @param type Content-Type of the release asset.
63 * @param name Name of the release asset.
64 * @return The new release asset.
65 * @throws IOException If an IO Exception occurs
66 * @see <a href="https://developer.github.com/v3/repos/releases/#upload-a-release-asset">Upload a Release Asset</a>
67 */
68 ReleaseAsset upload(
69 byte[] content,
70 String type,
71 String name
72 ) throws IOException;
73
74 /**
75 * Get a single release asset.
76 * @param number The release asset ID.
77 * @return The release asset.
78 * @see <a href="https://developer.github.com/v3/repos/releases/#get-a-single-release-asset">Get a Single Release Asset</a>
79 */
80 ReleaseAsset get(int number);
81
82 }