001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar 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 * Sonar 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 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020package org.sonar.api.rules; 021 022import org.apache.commons.lang.StringUtils; 023import org.sonar.api.utils.AnnotationUtils; 024import org.sonar.check.Check; 025 026/** 027 * @since 2.3 028 */ 029public final class RuleAnnotationUtils { 030 031 private RuleAnnotationUtils() { 032 // only static methods 033 } 034 035 public static String getRuleKey(Class annotatedClass) { 036 String key = null; 037 org.sonar.check.Rule ruleAnnotation = AnnotationUtils.getAnnotation(annotatedClass, org.sonar.check.Rule.class); 038 if (ruleAnnotation != null) { 039 key = ruleAnnotation.key(); 040 } else { 041 Check checkAnnotation = AnnotationUtils.getAnnotation(annotatedClass, Check.class); 042 if (checkAnnotation != null) { 043 key = checkAnnotation.key(); 044 } 045 } 046 return StringUtils.defaultIfEmpty(key, annotatedClass.getCanonicalName()); 047 } 048}