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 */
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.1 (experimental)
029 * @deprecated since 2.3. Use @Rule
030 */
031 @Retention(RetentionPolicy.RUNTIME)
032 @Target(ElementType.TYPE)
033 @Deprecated
034 public @interface Check {
035
036 /**
037 * The default key is the class name.
038 */
039 String key() default "";
040
041 /**
042 * The path to resource bundles (optional). If not set, then it equals the class name.
043 */
044 String bundle() default "";
045
046 /**
047 * The check title. If not defined, then the title is the key
048 */
049 String title() default "";
050
051 /**
052 * The check description, optional.
053 */
054 String description() default "";
055
056 /**
057 * Default priority.
058 */
059 Priority priority() default Priority.MAJOR;
060
061 /**
062 * Will probably be deprecated and replaced by tags
063 *
064 * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-2007
065 */
066 @Deprecated
067 IsoCategory isoCategory();
068 }