oracle.ide.feedback

Class FeedbackManager

java.lang.Object

oracle.ide.feedback.FeedbackManager

public abstract class FeedbackManager
extends java.lang.Object

The FeedbackManager automatically file bugs.

See the howto page and an example of the bug produced.

When the user hits an unepected condition, a bomb button appears in the toolbar. This button brings a dialog that shows the details about the exception. The user has the option to report the bug or to clear the error.

If the user reports the bug, the exception is compared with a database bugs that have already been filed. If the exception has never been reported before, a new bug is created.

The FeedbackManager UI will be disabled if you add "-nofeedback" to the command line.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_EXCEPTIONS
static java.lang.String	PROPERTY_INTERNAL

Constructor Summary

Constructors

Constructor and Description
FeedbackManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addFeedback(java.lang.String message)
static void	addFeedback(java.lang.String message, Context context)
protected abstract void	addFeedbackImpl(oracle.ide.feedback.shared.Feedback feedback)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	clearExceptions() INTERNAL USE!
void	disableFeedbackOnLoggedExceptions(java.util.Collection<java.lang.String> apinames) Used to selectively (or completely) disable the filing of feedback reports when an call is made to Logging with an exception.
void	disableFeedbackOnLoggingFromThesePackages(java.util.Set<java.lang.String> packageNames) Experimental; interface may change if we find that we need greater specificity about where in the stack trace a package appears
void	enableFeedbackOnLoggedExceptions(java.util.Collection<java.lang.String> apinames) Allow for re-enabling feedback reporting on an exception.
protected void	firePropertyChange(java.beans.PropertyChangeEvent event)
protected void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
protected void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
void	flush() INTERNAL USE!
protected java.util.Collection<java.lang.String>	getAPIsToExcludeFromLogHandling()
static FeedbackManager	getFeedbackManager()
java.util.List<FeedbackManagerCallback>	getFeedbackParticipants()
java.util.Set<java.lang.String>	getPackagesToExcludeFromLogHandling()
boolean	hasExceptions()
protected boolean	isFeedbackLogHandlerDisabled()
boolean	isIgnoredLogger(java.lang.String loggerName) Some third-party loggers log SEVERE log messages that we can't suppress, and that are already being adequately handled ..
static boolean	isOn()
void	registerCallback(FeedbackManagerCallback participant)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
static void	reportAPIException(java.lang.String message, java.lang.Throwable exception, int apiDepth)
static void	reportAPIException(java.lang.String message, java.lang.Throwable exception, java.lang.String apiName)
protected abstract void	reportApiExceptionImpl(java.lang.String message, java.lang.Throwable exception, java.lang.String apiName, boolean printToConsole)
static void	reportException(java.lang.String dialogHeader, java.lang.String message, java.lang.Throwable exception)
static void	reportException(java.lang.String message, java.lang.Throwable exception)
static void	reportException(java.lang.Throwable exception)
protected abstract void	reportExceptionImpl(java.lang.String message, java.lang.Throwable exception, boolean printToConsole)
protected abstract void	reportExceptionImpl(java.lang.String message, java.lang.Throwable exception, int apiDepth, boolean printToConsole)
protected abstract void	reportExceptionImpl(java.lang.String message, java.lang.Throwable exception, int apiDepth, boolean printToConsole, java.lang.String dialogHeader)
void	setExceptions(boolean exceptions)
protected static void	setFeedbackManager(FeedbackManager feedbackManager) Publishes the specified FeedbackManager as the active instance in the IDE.
void	setLoggersToIgnore(java.util.List<java.lang.String> loggers)
void	showFeedbackDialog(boolean reportEnabled) INTERNAL USE!
void	unregisterCallback(FeedbackManagerCallback participant)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_EXCEPTIONS

public static final java.lang.String PROPERTY_EXCEPTIONS

See Also:

Constant Field Values

PROPERTY_INTERNAL

public static final java.lang.String PROPERTY_INTERNAL

See Also:

Constant Field Values

Constructor Detail

FeedbackManager

public FeedbackManager()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                      int oldValue,
                      int newValue)

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                      boolean oldValue,
                      boolean newValue)

firePropertyChange

protected void firePropertyChange(java.beans.PropertyChangeEvent event)

addFeedbackImpl

protected abstract void addFeedbackImpl(oracle.ide.feedback.shared.Feedback feedback)

reportExceptionImpl

protected abstract void reportExceptionImpl(java.lang.String message,
                       java.lang.Throwable exception,
                       boolean printToConsole)

reportExceptionImpl

protected abstract void reportExceptionImpl(java.lang.String message,
                       java.lang.Throwable exception,
                       int apiDepth,
                       boolean printToConsole)

reportExceptionImpl

protected abstract void reportExceptionImpl(java.lang.String message,
                       java.lang.Throwable exception,
                       int apiDepth,
                       boolean printToConsole,
                       java.lang.String dialogHeader)

reportApiExceptionImpl

protected abstract void reportApiExceptionImpl(java.lang.String message,
                          java.lang.Throwable exception,
                          java.lang.String apiName,
                          boolean printToConsole)

addFeedback

public static void addFeedback(java.lang.String message)

addFeedback

public static void addFeedback(java.lang.String message,
               Context context)

isOn

public static boolean isOn()

reportException

public static void reportException(java.lang.String dialogHeader,
                   java.lang.String message,
                   java.lang.Throwable exception)

reportException

public static void reportException(java.lang.String message,
                   java.lang.Throwable exception)

reportException

public static void reportException(java.lang.Throwable exception)

reportAPIException

public static void reportAPIException(java.lang.String message,
                      java.lang.Throwable exception,
                      java.lang.String apiName)

reportAPIException

public static void reportAPIException(java.lang.String message,
                      java.lang.Throwable exception,
                      int apiDepth)

getFeedbackManager

public static FeedbackManager getFeedbackManager()

setFeedbackManager

protected static void setFeedbackManager(FeedbackManager feedbackManager)

Publishes the specified FeedbackManager as the active instance in the IDE.

hasExceptions

public boolean hasExceptions()

setExceptions

public void setExceptions(boolean exceptions)

disableFeedbackOnLoggedExceptions

public void disableFeedbackOnLoggedExceptions(java.util.Collection<java.lang.String> apinames)

Used to selectively (or completely) disable the filing of feedback reports when an call is made to Logging with an exception. If called with a null or empty collection, no feedback reports will be generated while logging. If called with a list of API names, then the log messages will be examined for an API[...] prefix, and any whose name matches a value passed in will be ignored.

disableFeedbackOnLoggingFromThesePackages

public void disableFeedbackOnLoggingFromThesePackages(java.util.Set<java.lang.String> packageNames)

Experimental; interface may change if we find that we need greater specificity about where in the stack trace a package appears

enableFeedbackOnLoggedExceptions

public void enableFeedbackOnLoggedExceptions(java.util.Collection<java.lang.String> apinames)

Allow for re-enabling feedback reporting on an exception. Probably not needed but simple enough to put the capability here; might be useful in unit testing if nowhere else

isFeedbackLogHandlerDisabled

protected boolean isFeedbackLogHandlerDisabled()

getAPIsToExcludeFromLogHandling

protected java.util.Collection<java.lang.String> getAPIsToExcludeFromLogHandling()

getPackagesToExcludeFromLogHandling

public java.util.Set<java.lang.String> getPackagesToExcludeFromLogHandling()

registerCallback

public void registerCallback(FeedbackManagerCallback participant)

unregisterCallback

public void unregisterCallback(FeedbackManagerCallback participant)

getFeedbackParticipants

public java.util.List<FeedbackManagerCallback> getFeedbackParticipants()

isIgnoredLogger

public boolean isIgnoredLogger(java.lang.String loggerName)

Some third-party loggers log SEVERE log messages that we can't suppress, and that are already being adequately handled .. we don't want feedback reports generated for these. Exclusion filters can be configured in manifest via fcpauto-hook logger element.

setLoggersToIgnore

public void setLoggersToIgnore(java.util.List<java.lang.String> loggers)

showFeedbackDialog

public void showFeedbackDialog(boolean reportEnabled)

INTERNAL USE!

flush

public void flush()
           throws java.io.IOException

INTERNAL USE!

Flush any buffered output.

Throws:

java.io.IOException

clearExceptions

public void clearExceptions()

INTERNAL USE!

Clears any recorded exceptions.