001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube 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 * SonarQube 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.rule.internal;
021
022import org.apache.commons.lang.StringUtils;
023import org.sonar.api.rule.RuleKey;
024import org.sonar.api.rule.Severity;
025
026import javax.annotation.Nullable;
027import java.util.HashMap;
028import java.util.Map;
029
030/**
031 * @since 4.2
032 */
033public class NewActiveRule {
034  final RuleKey ruleKey;
035  String severity = Severity.defaultSeverity();
036  Map<String, String> params = new HashMap<String, String>();
037  String internalKey;
038
039  NewActiveRule(RuleKey ruleKey) {
040    this.ruleKey = ruleKey;
041  }
042
043  public NewActiveRule setSeverity(@Nullable String severity) {
044    this.severity = StringUtils.defaultIfBlank(severity, Severity.defaultSeverity());
045    return this;
046  }
047
048  public NewActiveRule setInternalKey(@Nullable String internalKey) {
049    this.internalKey = internalKey;
050    return this;
051  }
052
053  public NewActiveRule setParam(String key, @Nullable String value) {
054    // possible improvement : check that the param key exists in rule definition
055    if (value == null) {
056      params.remove(key);
057    } else {
058      params.put(key, value);
059    }
060    return this;
061  }
062
063  public Map<String, String> params() {
064    return params;
065  }
066}