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.sonar.api.utils.AnnotationUtils; 024 025/** 026 * @since 2.3 027 */ 028public final class RuleAnnotationUtils { 029 030 private RuleAnnotationUtils() { 031 // only static methods 032 } 033 034 public static String getRuleKey(Class annotatedClass) { 035 String key = null; 036 org.sonar.check.Rule ruleAnnotation = AnnotationUtils.getAnnotation(annotatedClass, org.sonar.check.Rule.class); 037 if (ruleAnnotation != null) { 038 key = ruleAnnotation.key(); 039 } 040 return StringUtils.defaultIfEmpty(key, annotatedClass.getCanonicalName()); 041 } 042}