View Javadoc
1   /*
2    * The MIT License (MIT)
3    *
4    * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
5    *     https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
6    *
7    * Permission is hereby granted, free of charge, to any person obtaining a copy
8    * of this software and associated documentation files (the "Software"), to deal
9    * in the Software without restriction, including without limitation the rights
10   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11   * copies of the Software, and to permit persons to whom the Software is
12   * furnished to do so, subject to the following conditions:
13   *
14   * The above copyright notice and this permission notice shall be included in
15   * all copies or substantial portions of the Software.
16   *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23   * THE SOFTWARE.
24   */
25  package org.eluder.coveralls.maven.plugin.service;
26  
27  import java.util.Map;
28  import java.util.Properties;
29  
30  /**
31   * Convenient base class for service setups.
32   */
33  public abstract class AbstractServiceSetup implements ServiceSetup {
34  
35      /** The env. */
36      private final Map<String, String> env;
37  
38      /**
39       * Instantiates a new abstract service setup.
40       *
41       * @param env
42       *            the env
43       */
44      protected AbstractServiceSetup(final Map<String, String> env) {
45          this.env = env;
46      }
47  
48      @Override
49      public String getJobId() {
50          return null;
51      }
52  
53      @Override
54      public String getBuildNumber() {
55          return null;
56      }
57  
58      @Override
59      public String getBuildUrl() {
60          return null;
61      }
62  
63      @Override
64      public String getBranch() {
65          return null;
66      }
67  
68      @Override
69      public String getPullRequest() {
70          return null;
71      }
72  
73      @Override
74      public Properties getEnvironment() {
75          return null;
76      }
77  
78      /**
79       * Gets the property.
80       *
81       * @param name
82       *            the name
83       *
84       * @return the property
85       */
86      protected final String getProperty(final String name) {
87          return this.env.get(name);
88      }
89  
90      /**
91       * Adds the property.
92       *
93       * @param properties
94       *            the properties
95       * @param name
96       *            the name
97       * @param value
98       *            the value
99       */
100     protected final void addProperty(final Properties properties, final String name, final String value) {
101         if (name == null || name.isBlank()) {
102             throw new IllegalArgumentException("name must be defined");
103         }
104         if (value != null && !value.isBlank()) {
105             properties.setProperty(name, value);
106         }
107     }
108 }