001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
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.rules;
021    
022    import java.util.Map;
023    
024    import org.apache.commons.configuration.Configuration;
025    import org.sonar.api.CoreProperties;
026    import org.sonar.api.utils.KeyValueFormat;
027    
028    /**
029     * A utility class to manipulate concepts around rules
030     */
031    public final class RuleUtils {
032    
033      private RuleUtils() {
034      }
035    
036      /**
037       * Gets a Map<RulePriority, Integer> containing the weights defined in the settings
038       * Default value is used when the property is not set (see property key and default value in the class CoreProperties)
039       *
040       * @param configuration the Sonar configuration
041       * @return a map
042       */
043      public static Map<RulePriority, Integer> getPriorityWeights(final Configuration configuration) {
044        String levelWeight = configuration.getString(CoreProperties.CORE_RULE_WEIGHTS_PROPERTY, CoreProperties.CORE_RULE_WEIGHTS_DEFAULT_VALUE);
045    
046        Map<RulePriority, Integer> weights = KeyValueFormat.parse(levelWeight, new KeyValueFormat.RulePriorityNumbersPairTransformer());
047    
048        for (RulePriority priority : RulePriority.values()) {
049          if (!weights.containsKey(priority)) {
050            weights.put(priority, 1);
051          }
052        }
053        return weights;
054      }
055    }