From 12e202de97ad59a324c9af508f24ec94476b7e02 Mon Sep 17 00:00:00 2001 From: Julien Lancelot Date: Mon, 7 Nov 2016 15:22:50 +0100 Subject: [PATCH] SONAR-8354 Deprecate API related to dashboards --- .../src/main/java/org/sonar/api/web/Dashboard.java | 2 ++ .../src/main/java/org/sonar/api/web/DashboardLayout.java | 2 ++ .../src/main/java/org/sonar/api/web/DashboardTemplate.java | 2 ++ .../src/main/java/org/sonar/api/web/RubyRailsWidget.java | 2 ++ sonar-plugin-api/src/main/java/org/sonar/api/web/Widget.java | 2 ++ .../src/main/java/org/sonar/api/web/WidgetCategory.java | 2 ++ .../src/main/java/org/sonar/api/web/WidgetLayout.java | 2 ++ .../src/main/java/org/sonar/api/web/WidgetLayoutType.java | 2 ++ .../src/main/java/org/sonar/api/web/WidgetProperties.java | 4 ++++ .../src/main/java/org/sonar/api/web/WidgetProperty.java | 4 ++++ .../src/main/java/org/sonar/api/web/WidgetPropertyType.java | 4 ++++ .../src/main/java/org/sonar/api/web/WidgetScope.java | 3 +++ 12 files changed, 31 insertions(+) diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java index 3c1357b89b5..e03de099b71 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java @@ -33,7 +33,9 @@ import java.util.Map; * "dashboard.<id>.description". * * @since 2.13 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated public final class Dashboard { private String description; diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardLayout.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardLayout.java index 346a5f8dcf5..2f8212a744e 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardLayout.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardLayout.java @@ -23,7 +23,9 @@ package org.sonar.api.web; * Possible layouts for a dashboard. * * @since 2.13 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated public enum DashboardLayout { /** diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardTemplate.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardTemplate.java index 755b513990e..a37260e8571 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardTemplate.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/DashboardTemplate.java @@ -26,7 +26,9 @@ import org.sonar.api.server.ServerSide; * This extension point must be implemented to define a new dashboard. * * @since 2.13 + * @deprecated since 6.2, as dahsboards have been removed */ +@Deprecated @ServerSide @ExtensionPoint public abstract class DashboardTemplate { diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/RubyRailsWidget.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/RubyRailsWidget.java index b1f6aea1ee1..adb5986eae9 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/RubyRailsWidget.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/RubyRailsWidget.java @@ -31,7 +31,9 @@ package org.sonar.api.web; * * * @since 1.11 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated public interface RubyRailsWidget extends Widget { /** * @return content of the Ruby on Rails template diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/Widget.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/Widget.java index de49b78c8fb..4d6671e7665 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/Widget.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/Widget.java @@ -21,6 +21,8 @@ package org.sonar.api.web; /** * @since 1.11 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated public interface Widget extends View { } diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetCategory.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetCategory.java index a15894f68b0..85d5976a886 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetCategory.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetCategory.java @@ -26,7 +26,9 @@ import java.lang.annotation.Target; /** * @since 2.4 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface WidgetCategory { diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayout.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayout.java index fa1d503b0e4..d0ff39744ab 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayout.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayout.java @@ -26,7 +26,9 @@ import java.lang.annotation.Target; /** * @since 2.4 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface WidgetLayout { diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayoutType.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayoutType.java index 2ce37e99074..b582d6cc553 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayoutType.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetLayoutType.java @@ -21,7 +21,9 @@ package org.sonar.api.web; /** * @since 2.4 + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated public enum WidgetLayoutType { DEFAULT, NONE } diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperties.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperties.java index 7e80203f30b..c98b1f60534 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperties.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperties.java @@ -22,6 +22,10 @@ package org.sonar.api.web; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; +/** + * @deprecated since 6.2, as dashboards have been removed + */ +@Deprecated @Retention(RetentionPolicy.RUNTIME) public @interface WidgetProperties { WidgetProperty[] value() default {}; diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperty.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperty.java index 5003381681e..ca4f9573174 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperty.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetProperty.java @@ -24,6 +24,10 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * @deprecated since 6.2, as dashboards have been removed + */ +@Deprecated @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface WidgetProperty { diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetPropertyType.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetPropertyType.java index 4420512cf43..ac662a7616c 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetPropertyType.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetPropertyType.java @@ -19,6 +19,10 @@ */ package org.sonar.api.web; +/** + * @deprecated since 6.2, as dashboards have been removed + */ +@Deprecated public enum WidgetPropertyType { /** * Integer value, positive or negative diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java index 85220edb61d..ba118a209b2 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java @@ -32,7 +32,10 @@ import java.lang.annotation.Target; * then is is assumed project scoped. * * @since 3.1 +/** + * @deprecated since 6.2, as dashboards have been removed */ +@Deprecated @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface WidgetScope { -- 2.39.5