org.sonar.api.measures.PropertiesBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 5.1

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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  02110-1301, USA.
 */
package org.sonar.api.measures;

import org.sonar.api.utils.KeyValueFormat;

import java.util.Map;
import java.util.TreeMap;

/**
 * @since 1.10
 */
public class PropertiesBuilder {
  private Metric metric;
  private Map props;

  public PropertiesBuilder(Metric metric, Map map) {
    this.props = new TreeMap(map);
    this.metric = metric;
  }

  public PropertiesBuilder(Metric metric) {
    this.props = new TreeMap();
    this.metric = metric;
  }

  public PropertiesBuilder() {
    this.props = new TreeMap();
  }

  public PropertiesBuilder clear() {
    this.props.clear();
    return this;
  }

  public Map getProps() {
    return props;
  }

  public Metric getMetric() {
    return metric;
  }

  public PropertiesBuilder setMetric(Metric metric) {
    this.metric = metric;
    return this;
  }

  public PropertiesBuilder add(K key, V value) {
    props.put(key, value);
    return this;
  }

  public PropertiesBuilder addAll(Map map) {
    props.putAll(map);
    return this;
  }

  public Measure build() {
    return new Measure(metric, buildData());
  }

  public String buildData() {
    return KeyValueFormat.format(props);
  }
}