org.sonarqube.gradle.SonarQubeProperties Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarqube-gradle-plugin Show documentation

Gradle plugin to help analyzing projects with SonarQube

There is a newer version: 3.3

Show newest version

/**
 * SonarQube Scanner for Gradle
 * Copyright (C) 2015-2018 SonarSource
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonarqube.gradle;

import java.util.Map;

/**
 * The SonarQube properties for the current Gradle project that are to be passed to the SonarQube Scanner.
 * 
 * The {@code properties} map is already populated with the defaults provided by Gradle, and can be further manipulated as necessary.
 * Before passing them on to the SonarQube Scanner, property values are converted to Strings as follows:
 * 

 * {@code Iterable}s are recursively converted and joined into a comma-separated String.
 * All other values are converted to Strings by calling their {@code toString()} method.
 * 
 */
public class SonarQubeProperties {

  private Map properties;

  public SonarQubeProperties(Map properties) {
    this.properties = properties;
  }

  /**
   * Convenience method for setting a single property.
   *
   * @param key the key of the property to be added
   * @param value the value of the property to be added
   */
  public void property(String key, Object value) {
    properties.put(key, value);
  }

  /**
   * Convenience method for setting multiple properties.
   *
   * @param properties the properties to be added
   */
  public void properties(Map properties) {
    this.properties.putAll(properties);
  }

  /**
   * @return The Sonar properties for the current Gradle project that are to be passed to the Sonar gradle.
   */
  public Map getProperties() {
    return properties;
  }

}