001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2014 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.rules;
021
022import org.apache.commons.lang.StringUtils;
023import org.apache.commons.lang.builder.ToStringBuilder;
024import org.apache.commons.lang.builder.ToStringStyle;
025import org.sonar.api.ServerExtension;
026
027import java.util.List;
028
029/**
030 * @since 2.3
031 * @deprecated in 4.2. Replaced by org.sonar.api.server.rule.RulesDefinition
032 */
033@Deprecated
034public abstract class RuleRepository implements ServerExtension {
035
036  private String key;
037  private String language;
038  private String name;
039
040  protected RuleRepository(String key, String language) {
041    this.key = key;
042    this.language = language;
043  }
044
045  public final String getKey() {
046    return key;
047  }
048
049  public final String getLanguage() {
050    return language;
051  }
052
053  public final String getName() {
054    return name;
055  }
056
057  public final String getName(boolean useKeyIfEmpty) {
058    if (useKeyIfEmpty) {
059      return StringUtils.defaultIfEmpty(name, key);
060    }
061    return name;
062  }
063
064  public final RuleRepository setName(String s) {
065    this.name = s;
066    return this;
067  }
068
069  public abstract List<Rule> createRules();
070
071  @Override
072  public String toString() {
073    return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
074      .append("key", key)
075      .append("language", language)
076      .append("name", name)
077      .toString();
078  }
079}