add the package org.sonar.api.checks in order to implement its own rules engine

1 files changed, 58 insertions, 0 deletions

diff --git a/sonar-check-api/src/main/java/org/sonar/check/Rule.java b/sonar-check-api/src/main/java/org/sonar/check/Rule.java
new file mode 100644
index 00000000000..2b072ccbfa0
--- /dev/null
+++ b/sonar-check-api/src/main/java/org/sonar/check/Rule.java
@@ -0,0 +1,58 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.check;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @since 2.3
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Rule {
+
+  /**
+   * The default key is the class name.
+   */
+  String key() default "";
+
+  /**
+   * The rule name. If not defined, then the name is the key
+   */
+  String name() default "";
+
+  /**
+   * The description, optional.
+   */
+  String description() default "";
+
+  /**
+   * Default priority.
+   */
+  Priority priority() default Priority.MAJOR;
+
+  /**
+   * Will probably be deprecated and replaced by tags
+   */
+  IsoCategory isoCategory();
+}