From ce00eac36934960b34b3f4eaa9c2447ec7a78554 Mon Sep 17 00:00:00 2001 From: Sergey Malenkov Date: Thu, 9 Apr 2015 14:50:15 +0300 Subject: [PATCH] IDEA-132304 Update com.intellij.openapi.options.ConfigurationException java doc --- .../options/ConfigurationException.java | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/platform/platform-api/src/com/intellij/openapi/options/ConfigurationException.java b/platform/platform-api/src/com/intellij/openapi/options/ConfigurationException.java index dbc411a44055..bc310f87c7d6 100644 --- a/platform/platform-api/src/com/intellij/openapi/options/ConfigurationException.java +++ b/platform/platform-api/src/com/intellij/openapi/options/ConfigurationException.java @@ -15,28 +15,47 @@ */ package com.intellij.openapi.options; +/** + * Thrown to indicate that a configurable component cannot {@link UnnamedConfigurable#apply() apply} entered values. + */ public class ConfigurationException extends Exception { public static final String DEFAULT_TITLE = OptionsBundle.message("cannot.save.settings.default.dialog.title"); private String myTitle = DEFAULT_TITLE; private Runnable myQuickFix; + /** + * @param message the detail message describing the problem + */ public ConfigurationException(String message) { super(message); } + /** + * @param message the detailed message describing the problem + * @param title the title describing the problem in short + */ public ConfigurationException(String message, String title) { super(message); myTitle = title; } + /** + * @return the title describing the problem in short + */ public String getTitle() { return myTitle; } + /** + * @param quickFix a runnable task that can fix the problem somehow + */ public void setQuickFix(Runnable quickFix) { myQuickFix = quickFix; } + /** + * @return a runnable task that can fix the problem somehow, or {@code null} if it is not set + */ public Runnable getQuickFix() { return myQuickFix; }