com.ibm.websphere.command

Class CommandException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.websphere.exception.DistributedException
  5. extended bycom.ibm.websphere.command.CommandException
All implemented interfaces:
DistributedExceptionEnabled, java.io.Serializable
Direct known subclasses:
UnauthorizedAccessException, UnavailableCompensatingCommandException, UnsetInputPropertiesException

  1. public class CommandException
  2. extends DistributedException
This is the base class for all Command exceptions. All application exceptions used in a Command implementation must extend the CommandException class. The CommandException class supports the chaining of distributed exceptions.
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. protected
  2. java.lang.Throwable
throwable

Constructor Summary

Constructor and Description
CommandException()
Constructor without parameters.
CommandException(java.lang.String message)
Constructor with a message parameter.
CommandException(java.lang.String resourceBundleName,java.lang.String resourceKey,java.lang.Object[] formatArguments,java.lang.String defaultText)
Constructor with information for localizing messages.
CommandException(java.lang.String resourceBundleName,java.lang.String resourceKey,java.lang.Object[] formatArguments,java.lang.String defaultText,java.lang.Throwable exception)
Constructor with information for localizing messages and an exception to chain.
CommandException(java.lang.String message,java.lang.Throwable throwable)
Constructor with a message and throwable exception, which is saved.
CommandException(java.lang.Throwable throwable)
Constructor with a throwable exception, which is saved.

Method Summary

Modifier and Type Method and Description
  1. java.lang.Throwable
getException()
Returns a throwable exception.
Methods inherited from class com.ibm.websphere.exception.DistributedException
getException, getExceptionInfo, getMessage, getOriginalException, getPreviousException, printStackTrace, printStackTrace, printStackTrace, printSuperStackTrace, printSuperStackTrace, setDefaultMessage, setLocalizationInfo
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

throwable

  1. protected java.lang.Throwable throwable

Constructor Detail

CommandException

  1. public CommandException()
Constructor without parameters.

CommandException

  1. public CommandException(java.lang.String message)
Constructor with a message parameter.
Parameters:
message - A string describing the exception.

CommandException

  1. public CommandException(java.lang.String resourceBundleName,
  2. java.lang.String resourceKey,
  3. java.lang.Object[] formatArguments,
  4. java.lang.String defaultText)
Constructor with information for localizing messages.
Parameters:
resourceBundleName - The name of resource bundle that will be used to retrieve the message for getMessage() method.
resourceKey - The key in the resource bundle that will be used to select the specific message that is retrieved for the getMessage() method.
formatArguments - The arguments to be passed to the MessageFormat class to act as replacement variables in the message that is retrieved from the resource bundle. Valid types are those supported by MessageFormat.
defaultText - The default message that will be used by the getMessage() method if the resource bundle or the key cannot be found.

CommandException

  1. public CommandException(java.lang.String resourceBundleName,
  2. java.lang.String resourceKey,
  3. java.lang.Object[] formatArguments,
  4. java.lang.String defaultText,
  5. java.lang.Throwable exception)
Constructor with information for localizing messages and an exception to chain.
Parameters:
resourceBundleName - The name of resource bundle that will be used to retrieve the message for getMessage() method.
resourceKey - The key in the resource bundle that will be used to select the specific message retrieved for the getMessage() method.
formatArguments - The arguments to be passed to the MessageFormat class to act as replacement variables in the message that is retrieved from the resource bundle. Valid types are those supported by MessageFormat.
defaultText - The default message that will be used by the getMessage() method if the resource bundle or the key cannot be found.
exception - The exception that is to be chained.

CommandException

  1. public CommandException(java.lang.Throwable throwable)
Constructor with a throwable exception, which is saved.
Parameters:
throwable - The exception to save.

CommandException

  1. public CommandException(java.lang.String message,
  2. java.lang.Throwable throwable)
Constructor with a message and throwable exception, which is saved.
Parameters:
throwable - The exception to save.

Method Detail

getException

  1. public java.lang.Throwable getException( )
Returns a throwable exception.
Returns:
A throwable exception.