public class TraversalException
extends java.lang.Exception
TraversalException
can be thrown by the Traversable.onExit(TraversableContext)
method if the user has entered incomplete, invalid, or inconsistent data that causes validation to fail.
An error message of some kind is required when instantiating the TraversalException
. The message can be a regular String
or it can be any object that is accepted by JOptionPane
for its message area.
Constructor and Description |
---|
TraversalException(java.lang.Object message)
Creates a new instance with the specified object providing the displayable error message UI to show to the user.
|
TraversalException(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.
|
TraversalException(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.
|
TraversalException(java.lang.String message)
Creates a new instance with the specified
String as the displayable error message to show to the user. |
TraversalException(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. |
TraversalException(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. |
Modifier and Type | Method and Description |
---|---|
void |
showMessageDialog(java.awt.Component parentComponent)
Displays the message associated with this
TraversalException in an alert and with the title set with the TraversalException in the constructor. |
public TraversalException(java.lang.String message)
String
as the displayable error message to show to the user.message
- The error message to show to the user. If null
, the TraversalException
will not display a dialog when showMessageDialog(Component)
is called.public TraversalException(java.lang.String message, java.lang.String title)
String
as the displayable error message to show to the user.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)
.public TraversalException(java.lang.String message, java.lang.String title, java.lang.String helpID)
String
as the displayable error message to show to the user.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)
.public TraversalException(java.lang.Object message)
Component
. If it is not a Component
, then the object will be converted to a String
before being displayed to the user.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.public TraversalException(java.lang.Object message, java.lang.String title)
Component
. If it is not a Component
, then the object will be converted to a String
before being displayed to the user.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)
.public TraversalException(java.lang.Object message, java.lang.String title, java.lang.String helpID)
Component
. If it is not a Component
, then the object will be converted to a String
before being displayed to the user.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)
.public void showMessageDialog(java.awt.Component parentComponent)
TraversalException
in an alert and with the title set with the TraversalException
in the constructor. The alert is parented onto the specified Component
. If the message set with this TraversalException
is null
, then this method returns without showing any UI. Therefore, the dialog is effectively skipped.