org.sonar.server.rule.RuleDefinitionsLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.0
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.server.rule;

import org.sonar.api.server.rule.RulesDefinition;

/**
 * Loads all instances of {@link RulesDefinition}
 * and initializes {@link RuleRepositories}. Used at server startup.
 */
public class RuleDefinitionsLoader {

  private final DeprecatedRulesDefinitionLoader deprecatedDefConverter;
  private final CommonRuleDefinitions coreCommonDefs;
  private final RulesDefinition[] pluginDefs;
  private final RuleRepositories output;

  public RuleDefinitionsLoader(DeprecatedRulesDefinitionLoader deprecatedDefConverter, RuleRepositories output,
    CommonRuleDefinitions coreCommonDefs, RulesDefinition[] pluginDefs) {
    this.deprecatedDefConverter = deprecatedDefConverter;
    this.output = output;
    this.coreCommonDefs = coreCommonDefs;
    this.pluginDefs = pluginDefs;
  }

  /**
   * Used when no definitions at all.
   */
  public RuleDefinitionsLoader(DeprecatedRulesDefinitionLoader converter, RuleRepositories output,
    CommonRuleDefinitions coreCommonDefs) {
    this(converter, output, coreCommonDefs, new RulesDefinition[0]);
  }

  public RulesDefinition.Context load() {
    RulesDefinition.Context context = new RulesDefinition.Context();
    for (RulesDefinition pluginDefinition : pluginDefs) {
      pluginDefinition.define(context);
    }
    deprecatedDefConverter.complete(context);
    coreCommonDefs.define(context);
    output.register(context);
    return context;
  }
}