001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2011 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.measures;
021    
022    import org.sonar.api.utils.KeyValueFormat;
023    
024    import java.util.Map;
025    import java.util.TreeMap;
026    
027    /**
028     * @since 1.10
029     */
030    public class PropertiesBuilder<KEY, VALUE> {
031      private Metric metric;
032      private Map<KEY, VALUE> props;
033    
034      public PropertiesBuilder(Metric metric, Map<KEY, VALUE> map) {
035        this.props = new TreeMap<KEY, VALUE>(map);
036        this.metric = metric;
037      }
038    
039      public PropertiesBuilder(Metric metric) {
040        this.props = new TreeMap<KEY, VALUE>();
041        this.metric = metric;
042      }
043    
044      public PropertiesBuilder() {
045        this.props = new TreeMap<KEY, VALUE>();
046      }
047    
048      public PropertiesBuilder<KEY, VALUE> clear() {
049        this.props.clear();
050        return this;
051      }
052    
053      public Map<KEY, VALUE> getProps() {
054        return props;
055      }
056    
057      public Metric getMetric() {
058        return metric;
059      }
060    
061      public PropertiesBuilder<KEY, VALUE> setMetric(Metric metric) {
062        this.metric = metric;
063        return this;
064      }
065    
066      public PropertiesBuilder<KEY, VALUE> add(KEY key, VALUE value) {
067        props.put(key, value);
068        return this;
069      }
070    
071      public PropertiesBuilder<KEY, VALUE> addAll(Map<KEY, VALUE> map) {
072        props.putAll(map);
073        return this;
074      }
075    
076      public Measure build() {
077        return new Measure(metric, buildData());
078      }
079    
080      public String buildData() {
081        return KeyValueFormat.format(props);
082      }
083    }