oracle.ide.panels
Class DetailedTraversalException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          oracle.ide.panels.TraversalException
              oracle.ide.panels.DetailedTraversalException

All Implemented Interfaces:

java.io.Serializable

public class DetailedTraversalException
extends TraversalException

The DetailedTraversalException should be thrown from Traversable.onExit(TraversableContext) method if the user has entered incomplete, invalid, or inconsistent data that causes validation to fail, and you want deatiled exception information presented to the user.

An error message of some kind is required when instantiating the DetailedTraversalException. The message can be a regular String or it can be any object that is accepted by JOptionPane for its message area. The error message along with the exception details will be presented to the user in an exception dialog.

See Also:

Serialized Form

Constructor Summary

DetailedTraversalException(java.lang.Object message)
Creates a new instance with the specified object providing the displayable error message UI to show to the user.

DetailedTraversalException(java.lang.Object message, java.lang.String title)
Creates a new instance with the specified object providing the displayable error message UI to show to the user.

DetailedTraversalException(java.lang.Object message, java.lang.String title, java.lang.String helpID)
Creates a new instance with the specified object providing the displayable error message UI to show to the user.

DetailedTraversalException(java.lang.String message)
Creates a new instance with the specified String as the displayable error message to show to the user.

DetailedTraversalException(java.lang.String message, java.lang.String title)
Creates a new instance with the specified String as the displayable error message to show to the user.

DetailedTraversalException(java.lang.String message, java.lang.String title, java.lang.String helpID)
Creates a new instance with the specified String as the displayable error message to show to the user.

Method Summary

void	showMessageDialog(java.awt.Component parentComponent) Displays the message associated with this DetailedTraversalException in an exception dialog and with the title set with the DetailedTraversalException in the constructor.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DetailedTraversalException

public DetailedTraversalException(java.lang.String message)

Creates a new instance with the specified String as the displayable error message to show to the user.

Parameters:

message - The error message to show to the user. If null, the TraversalException will not display a dialog when showMessageDialog(Component) is called.

DetailedTraversalException

public DetailedTraversalException(java.lang.String message,
                                  java.lang.String title)

Creates a new instance with the specified String as the displayable error message to show to the user.

Parameters:

message - The error message to show to the user. If null, the TraversalException will not display a dialog when showMessageDialog(Component) is called.

title - The title used by the message dialog shown by showMessageDialog(Component).

DetailedTraversalException

public DetailedTraversalException(java.lang.String message,
                                  java.lang.String title,
                                  java.lang.String helpID)

Creates a new instance with the specified String as the displayable error message to show to the user.

Parameters:

message - The error message to show to the user. If null, the TraversalException will not display a dialog when showMessageDialog(Component) is called.

title - The title used by the message dialog shown by showMessageDialog(Component).

helpID - The help topic ID to be associated with the help button in the dialog shown by showMessageDialog(Component).

DetailedTraversalException

public DetailedTraversalException(java.lang.Object message)

Creates a new instance with the specified object providing the displayable error message UI to show to the user. Generally, the object should be a Component. If it is not a Component, then the object will be converted to a String before being displayed to the user.

Parameters:

message - The error message to show to the user. If it is a Component, then it is rendered in the message dialog; otherwise, it is converted to a String. If the message is null, the TraversalException will not display a dialog when the showMessageDialog(Component) method is called.

DetailedTraversalException

public DetailedTraversalException(java.lang.Object message,
                                  java.lang.String title)

Creates a new instance with the specified object providing the displayable error message UI to show to the user. Generally, the object should be a Component. If it is not a Component, then the object will be converted to a String before being displayed to the user.

Parameters:

message - The error message to show to the user. If it is a Component, then it is rendered in the message dialog; otherwise, it is converted to a String. If the message is null, the TraversalException will not display a dialog when the showMessageDialog(Component) method is called.

title - The title used by the message dialog shown by showMessageDialog(Component).

DetailedTraversalException

public DetailedTraversalException(java.lang.Object message,
                                  java.lang.String title,
                                  java.lang.String helpID)

Creates a new instance with the specified object providing the displayable error message UI to show to the user. Generally, the object should be a Component. If it is not a Component, then the object will be converted to a String before being displayed to the user.

Parameters:

message - The error message to show to the user. If it is a Component, then it is rendered in the message dialog; otherwise, it is converted to a String. If the message is null, the TraversalException will not display a dialog when the showMessageDialog(Component) method is called.

title - The title used by the message dialog shown by showMessageDialog(Component).

helpID - The help topic ID to be associated with the help button in the dialog shown by showMessageDialog(Component).

Method Detail

showMessageDialog

public void showMessageDialog(java.awt.Component parentComponent)

Displays the message associated with this DetailedTraversalException in an exception dialog and with the title set with the DetailedTraversalException in the constructor. The alert is parented onto the specified Component. The alert also provides, upon user request, the call stack at the time of the exception.

If the message set with this TraversalException is null, then this method returns without showing any UI. Therefore, the dialog is effectively skipped.

Overrides:

showMessageDialog in class TraversalException