org.sonar.commonrules.api.CommonRule Maven / Gradle / Ivy

Go to download
/*
 * Sonar Common Rules
 * Copyright (C) 2012 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.sonar.commonrules.api;

import com.google.common.base.Preconditions;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RuleParam;

public class CommonRule {

  private Rule rule;

  CommonRule(Rule rule) {
    this.rule = rule;
  }

  Rule getRule() {
    return rule;
  }

  public CommonRule withParameter(String paramKey, String paramValue) {
    Preconditions.checkNotNull(paramKey, "The parameter key can't be null.");
    Preconditions.checkNotNull(paramValue, "The parameter value can't be null.");

    RuleParam param = rule.getParam(paramKey);
    if (param == null) {
      throw new IllegalStateException("Parameter '" + paramKey + "' on rule '" + rule.getKey() + "' does not exist.");
    }
    param.setDefaultValue(paramValue);
    return this;
  }

}