1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2013 - 2023, Tapio Rautonen
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package org.eluder.coveralls.maven.plugin.service;
25
26 import java.util.Properties;
27
28 /**
29 * Service specific mojo properties.
30 */
31 public interface ServiceSetup {
32
33 /**
34 * Checks if is selected.
35 *
36 * @return <code>true</code> if this service is selected, otherwise <code>false</code>
37 */
38 boolean isSelected();
39
40 /**
41 * Gets the name.
42 *
43 * @return service name
44 */
45 String getName();
46
47 /**
48 * Gets the job id.
49 *
50 * @return service job id, or <code>null</code> if not defined
51 */
52 String getJobId();
53
54 /**
55 * Gets the builds the number.
56 *
57 * @return service build number, or <code>null</code> if not defined
58 */
59 String getBuildNumber();
60
61 /**
62 * Gets the builds the url.
63 *
64 * @return service build url, or <code>null</code> if not defined
65 */
66 String getBuildUrl();
67
68 /**
69 * Gets the branch.
70 *
71 * @return git branch name, or <code>null</code> if not defined
72 */
73 String getBranch();
74
75 /**
76 * Gets the pull request.
77 *
78 * @return pull request identifier, or <code>null</code> if not defined
79 */
80 String getPullRequest();
81
82 /**
83 * Gets the environment.
84 *
85 * @return environment related to service, or <code>null</code> if not defined
86 */
87 Properties getEnvironment();
88
89 }