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 */ 020 package org.sonar.check; 021 022 import java.lang.annotation.ElementType; 023 import java.lang.annotation.Retention; 024 import java.lang.annotation.RetentionPolicy; 025 import java.lang.annotation.Target; 026 027 /** 028 * @since 2.3 029 */ 030 @Retention(RetentionPolicy.RUNTIME) 031 @Target(ElementType.TYPE) 032 public @interface Rule { 033 034 /** 035 * The default key is the class name. 036 */ 037 String key() default ""; 038 039 /** 040 * The rule name. If not defined, then the name is the key 041 */ 042 String name() default ""; 043 044 /** 045 * HTML description 046 */ 047 String description() default ""; 048 049 /** 050 * Default severity used when activating the rule in a Quality profile. 051 */ 052 Priority priority() default Priority.MAJOR; 053 054 Cardinality cardinality() default Cardinality.SINGLE; 055 056 /** 057 * The status. Can be READY, BETA or DEPRECATED 058 * @since 3.6 059 */ 060 String status() default "READY"; 061 062 /** 063 * Rule tags 064 * @since 4.2 065 */ 066 String[] tags() default {}; 067 }