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.check;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * @since 2.3
029 */
030@Retention(RetentionPolicy.RUNTIME)
031@Target(ElementType.TYPE)
032public @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   * The description, optional.
046   */
047  String description() default "";
048
049  /**
050   * Default priority.
051   */
052  Priority priority() default Priority.MAJOR;
053
054  /**
055   * Will probably be deprecated and replaced by tags
056   * 
057   * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-2007
058   */
059  @Deprecated
060  IsoCategory isoCategory() default IsoCategory.NONE;
061
062  Cardinality cardinality() default Cardinality.SINGLE;
063}