summaryrefslogtreecommitdiff
path: root/platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java
diff options
context:
space:
mode:
Diffstat (limited to 'platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java')
-rw-r--r--platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java54
1 files changed, 33 insertions, 21 deletions
diff --git a/platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java b/platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java
index 9f1b8e06b39e..c68e45189a95 100644
--- a/platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java
+++ b/platform/platform-api/src/com/intellij/openapi/diagnostic/ErrorReportSubmitter.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2000-2009 JetBrains s.r.o.
+ * Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@ package com.intellij.openapi.diagnostic;
import com.intellij.openapi.extensions.PluginAware;
import com.intellij.openapi.extensions.PluginDescriptor;
import com.intellij.util.Consumer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
import java.awt.*;
@@ -44,33 +46,43 @@ public abstract class ErrorReportSubmitter implements PluginAware {
}
/**
- * @return "Report to vendor" action text to be used in Error Reporter user interface. For example: "Report to JetBrains".
+ * @return an action text to be used in Error Reporter user interface, e.g. "Report to JetBrains".
*/
public abstract String getReportActionText();
/**
- * This method is called whenever fatal error (aka exception) in plugin code had happened and user decided to report this problem to
- * plugin vendor.
- * @param events sequence of the fatal error descriptors. Fatal errors that happened immediately one after another most probably caused
- * by first one that happened so it's a common practice to submit only first one. Array passed is guaranteed to have at least one element.
- * @param parentComponent one usually wants to show up a dialog asking user for additional details and probably authentication info.
- * parentComponent parameter is passed so dialog that would come up would be properly aligned with its parent dialog (IDE Fatal Errors).
- * @return submission result status.
+ * This method is called whenever an exception in a plugin code had happened and a user decided to report a problem to the plugin vendor.
+ *
+ * @param events a non-empty sequence of error descriptors.
+ * @param additionalInfo additional information provided by a user.
+ * @param parentComponent UI component to use as a parent in any UI activity from a submitter.
+ * @param consumer a callback to be called after sending is finished (or failed).
+ * @return {@code true} if reporting was started, {@code false} if a report can't be sent at the moment.
*/
- public abstract SubmittedReportInfo submit(IdeaLoggingEvent[] events, Component parentComponent);
-
- public void submitAsync(IdeaLoggingEvent[] events,
- String additionalInfo,
- Component parentComponent,
- Consumer<SubmittedReportInfo> consumer) {
- consumer.consume(submit(events, parentComponent));
+ @SuppressWarnings("deprecation")
+ public boolean submit(@NotNull IdeaLoggingEvent[] events,
+ @Nullable String additionalInfo,
+ @NotNull Component parentComponent,
+ @NotNull Consumer<SubmittedReportInfo> consumer) {
+ return trySubmitAsync(events, additionalInfo, parentComponent, consumer);
}
- public boolean trySubmitAsync(IdeaLoggingEvent[] events,
- String additionalInfo,
- Component parentComponent,
- Consumer<SubmittedReportInfo> consumer) {
- submitAsync(events, additionalInfo, parentComponent, consumer);
+ /** @deprecated implement {@link #submit(IdeaLoggingEvent[], String, Component, Consumer)} (to be removed in IDEA 16) */
+ @SuppressWarnings({"deprecation", "unused"})
+ public boolean trySubmitAsync(IdeaLoggingEvent[] events, String info, Component parent, Consumer<SubmittedReportInfo> consumer) {
+ submitAsync(events, info, parent, consumer);
return true;
}
+
+ /** @deprecated implement {@link #submit(IdeaLoggingEvent[], String, Component, Consumer)} (to be removed in IDEA 16) */
+ @SuppressWarnings({"deprecation", "unused"})
+ public void submitAsync(IdeaLoggingEvent[] events, String info, Component parent, Consumer<SubmittedReportInfo> consumer) {
+ consumer.consume(submit(events, parent));
+ }
+
+ /** @deprecated implement {@link #submit(IdeaLoggingEvent[], String, Component, Consumer)} (to be removed in IDEA 16) */
+ @SuppressWarnings({"deprecation", "unused"})
+ public SubmittedReportInfo submit(IdeaLoggingEvent[] events, Component parent) {
+ throw new UnsupportedOperationException("Deprecated API called");
+ }
}