source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2019 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.api.server.profile;
  21
  22 import javax.annotation.CheckForNull;
  23 import org.apache.commons.lang.StringUtils;
  24 import org.sonar.api.rules.RuleAnnotationUtils;
  25 import org.sonar.api.server.ServerSide;
  26 import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule;
  27 import org.sonar.check.BelongsToProfile;
  28
  29 /**
  30  * Read definitions of quality profiles based on the annotation {@link BelongsToProfile} provided by sonar-check-api. It is used
  31  * to feed {@link BuiltInQualityProfilesDefinition}.
  32  *
  33  * @see BuiltInQualityProfilesDefinition
  34  * @since 6.6
  35  */
  36 @ServerSide
  37 public class BuiltInQualityProfileAnnotationLoader {
  38
  39   public void load(BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile builtInProfile, String repositoryKey, Class... annotatedClasses) {
  40     for (Class<?> annotatedClass : annotatedClasses) {
  41       loadActiveRule(builtInProfile, repositoryKey, annotatedClass);
  42     }
  43   }
  44
  45   void loadActiveRule(BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile profile, String repositoryKey, Class<?> clazz) {
  46     BelongsToProfile belongsToProfile = clazz.getAnnotation(BelongsToProfile.class);
  47     if ((belongsToProfile != null) && StringUtils.equals(belongsToProfile.title(), profile.name())) {
  48       String ruleKey = RuleAnnotationUtils.getRuleKey(clazz);
  49       NewBuiltInActiveRule activeRule = profile.activateRule(repositoryKey, ruleKey);
  50       activeRule.overrideSeverity(belongsToProfile.priority().name());
  51     }
  52   }
  53
  54 }