001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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.server.profile;
021
022import javax.annotation.CheckForNull;
023import org.apache.commons.lang.StringUtils;
024import org.sonar.api.rules.RuleAnnotationUtils;
025import org.sonar.api.server.ServerSide;
026import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule;
027import org.sonar.check.BelongsToProfile;
028
029/**
030 * Read definitions of quality profiles based on the annotation {@link BelongsToProfile} provided by sonar-check-api. It is used
031 * to feed {@link BuiltInQualityProfilesDefinition}.
032 *
033 * @see BuiltInQualityProfilesDefinition
034 * @since 6.6
035 */
036@ServerSide
037public class BuiltInQualityProfileAnnotationLoader {
038
039  public void load(BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile builtInProfile, String repositoryKey, Class... annotatedClasses) {
040    for (Class<?> annotatedClass : annotatedClasses) {
041      loadActiveRule(builtInProfile, repositoryKey, annotatedClass);
042    }
043  }
044
045  @CheckForNull
046  void loadActiveRule(BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile profile, String repositoryKey, Class<?> clazz) {
047    BelongsToProfile belongsToProfile = clazz.getAnnotation(BelongsToProfile.class);
048    if ((belongsToProfile != null) && StringUtils.equals(belongsToProfile.title(), profile.name())) {
049      String ruleKey = RuleAnnotationUtils.getRuleKey(clazz);
050      NewBuiltInActiveRule activeRule = profile.activateRule(repositoryKey, ruleKey);
051      activeRule.overrideSeverity(belongsToProfile.priority().name());
052    }
053  }
054
055}