org.eluder.coveralls.maven.plugin.service.ServiceSetup Maven / Gradle / Ivy

Go to download
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 - 2023, Tapio Rautonen
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.eluder.coveralls.maven.plugin.service;

import java.util.Properties;

/**
 * Service specific mojo properties.
 */
public interface ServiceSetup {

    /**
     * Checks if is selected.
     *
     * @return true if this service is selected, otherwise false
     */
    boolean isSelected();

    /**
     * Gets the name.
     *
     * @return service name
     */
    String getName();

    /**
     * Gets the job id.
     *
     * @return service job id, or null if not defined
     */
    String getJobId();

    /**
     * Gets the builds the number.
     *
     * @return service build number, or null if not defined
     */
    String getBuildNumber();

    /**
     * Gets the builds the url.
     *
     * @return service build url, or null if not defined
     */
    String getBuildUrl();

    /**
     * Gets the branch.
     *
     * @return git branch name, or null if not defined
     */
    String getBranch();

    /**
     * Gets the pull request.
     *
     * @return pull request identifier, or null if not defined
     */
    String getPullRequest();

    /**
     * Gets the environment.
     *
     * @return environment related to service, or null if not defined
     */
    Properties getEnvironment();

}